libsaas documentation

Libsaas is a Python library that makes it easy to interact with various software as a service APIs. Think of it as an ORM for APIs.

Libsaas handles all the nitty-gritty details, such as input and output format, authentication and URL schemes. You don’t have to deal with serialization, extra headers and other quirks of various APIs. Everything’s Python, you just pass Python objects to Python functions and get the results out:

>>> from libsaas.services import zendesk
>>> service = zendesk.Zendesk('myapp', 'myuser', 's3cr3t')
>>> joe = service.users().search('joe@example.org')['users'][0]
>>> joes_tickets = service.user(joe['id']).tickets_requested()
>>> for ticket in joes_tickets:
...    print(ticket['description'])

Check out the list of currently supported services, add your own connectors and help us make using APIs less painful!

Requirements

For basic operation libsaas does not depend on any external modules, it just uses the standard Python library. It is regularly tested on Python 2.6, 2.7, 3.2 and PyPy.

Optional requirements

Some features of libsaas do need external libraries to be installed. To use one of the pluggable executors you will need the corresponding Python module, for instance python-requests for the Requests executor.

Usage

To use libsaas, you first create a service object and then use the method it provides to send and fetch data from a software as a service API.

With libsaas you always work with Python objects, serialization of data sent and received is provided by the library. Here’s an example of using libsaas to check what’s the most watched repository from all people that follow you.

from __future__ import print_function

from libsaas.services import github

# use basic authentication to create a token for libsaas
basic = github.GitHub('me@example.org', 'my-github-password')

auth = basic.authorizations().create({'scopes': 'repo,gist',
                                      'note': 'libsaas example'})

# use token authentication for the rest of the calls
gh = github.GitHub(auth['token'])

# go through your followers
for follower in gh.user().followers():
    username = follower['login']

    # get the source repositories owned by each follower
    repos = gh.user(username).repos().get(type='owner')
    sources = [repo for repo in repos if not repo['fork']]

    # handle the case where a user has no repos
    if not sources:
        print("{0} has no repositories".format(username))
        continue

    # print the most watched repo of each follower, excluding forks
    most = sorted(sources, key=lambda repo: repo['watchers'])[-1]
    print("{0}'s most watched repository: {1}".format(username, most['name']))

Consulting original documentation

The most productive way to use libsaas is to keep the original API documentation and the libsaas documentation open side-by-side. Since every API has its own data format, the abstraction provided by libsaas ends at providing you with Python objects. You should refer to the original service documentation in order to fully interpret the results.

Combining services

Libsaas is most useful when you combine access to different services. This allows you to quickly create mashups without worrying about all the little quirks of each API. Here’s how you’d get the tickets solved yesterday in your Zendesk and accordingly tag users who reported those tickets in Mailchimp.

You could then run this script nightly and create an automatic mailing campaign to send quality surveys to users who’s tickets have been solved recently.

from datetime import datetime, timedelta

from libsaas.services import mailchimp, zendesk

# create Zendesk and Mailchimp services
zd = zendesk.Zendesk('mycompany', 'username', 'password')
mc = mailchimp.Mailchimp('8ac789caf98879caf897a678fa76daf-us2')

# get tickets solved yesterday
yesterday = (datetime.now() - timedelta(days=1)).strftime('%Y-%m-%d')
tickets = zd.search('updated>{0} status:solved type:ticket'.format(yesterday))

# get emails of users who requested those tickets
user_ids = [ticket['requester_id'] for ticket in tickets['results']]
emails = [zd.user(user_id).get()['user']['email'] for user_id in user_ids]

# grab the ID of the "Users" list
lists = mc.lists(filters={'list_name': 'Users'})
list_id = lists['data'][0]['id']

# set the SOLVED variable for those users in Mailchimp to yesterday
batch = [{'EMAIL': email, 'SOLVED': yesterday} for email in emails]
mc.listBatchSubscribe(list_id, batch, double_optin=False, update_existing=True)

Pluggable executors

Everything out there uses HTTP, but there’s more than one way to skin a request. By default libsaas uses Python’s standard urllib2 to make HTTP requests, but it provides a few other executor modules and you can even plug in your own.

Here’s an example of using the Requests executor in order to add a user agent and a timeout every time libsaas makes a HTTP request. The example code will unstar all gists a user has previously starred.

import libsaas
from libsaas.executors import requests_executor
from libsaas.services import github

# use the Requests executor with a custom timeout and make it always send a
# user agent string
uastring = 'libsaas {0}'.format(libsaas.__versionstr__)

requests_executor.use(timeout=5.0,
                      config={'base_headers': {'User-agent': uastring}})

# unstar all starred gists
gh = github.GitHub('my-github-token')

for gist in gh.gists().starred():
    gh.gist(gist['id']).unstar()

Another executor included in libsaas is the Twisted executor that makes it easy to integrate libsaas in Twisted programs. When using the Twisted executor, libsaas will return Deferreds that will fire with the fetched data.

The saas script

If you want to quickly interact with a SaaS API, you can use the saas command line program. It can execute any method provided by libsaas and has some limited discoverability features.

To use it, call it with the desired service as the first argument, followed by the service parameters and the path to the method you want to call.

This means that code like this:

>>> from libsaas.services import zendesk
>>> service = zendesk.Zendesk('myapp', 'myuser', 's3cr3t')
>>> service.user(364).tickets_requested()

Translates to:

$ saas zendesk --subdomain=myapp --username=myuser --password=s3cr3t \
    user 364 tickets_requested

The saas script can also choose executors and output some debugging information while executing:

$ saas mailchimp --api_key=8ac789caf98879caf897a678fa76daf-us2 \
    --executor requests campaignContent 8df731

Another useful feature is that saas will try to interpret every parameter as JSON, making it easier to use methods that need Python dictionaries:

$ saas github --token_or_password=my-gh-token \
    gist 125342 update '{"description": "my gist"}'

Unicode support

Libsaas supports both 2.x and 3.x versions of Python, so some rules about where to use Unicode and where to use byte strings need to be followed.

As defined in the standards, URLs are ASCII-only. Characters from outside of ASCII should be encoded using so-called percent encoding. Encoding schemes, such as UTF-8 or ISO-8859-2 are mostly outside of the scope of HTTP. Libsaas tries to be flexible in what it accepts as user input and handles encoding and percent quoting automatically for you.

When you pass a string parameter to a libsaas method, it will be coerced to bytes before percent-encoding, and UTF-8 will be used as the encoding. This means that in Python 2 parameters of the str type will be used as-is and unicode parameters will be encoded according to UTF-8. In Python 3 str parameters will be UTF-8 encoded and bytes will be used as-is.

If you need to send characters outside of ASCII in different encoding than UTF-8, encode them yourself and hand the bytes off to libsaas.

Data returned from libsaas methods might be encoded differently, depending on the method in question. For most APIs using JSON it will be Unicode, because the JSON standard mandates the use of UTF-8, making it easy to convert bytes received from the service into Unicode characters. Some APIs though might return binary data, such as APIs exporting images or providing access to raw files. When in doubt, consult the upstream service documentation.

Internal usage

This section is only relevant if you are extending libsaas. Normal users that only interact with libsaas via the methods it provides can safely skip it.

Internally, libsaas uses a structure called Request to prepare and execute a HTTP request. There are four pieces of information this structure holds:

• the HTTP method to use
• the URL (without query parameters)
• the query parameters
• HTTP headers

Here’s how each of them should be represented with regards to Unicode/bytes.

HTTP method

In both Python 2 and 3 this should be a str object, that only contains bytes from the ASCII range. Note that in Python 2 this represents a binary string and in Python 3 it means Unicode text. Since the HTTP method name can only include ASCII characters, the distinction is not important and using str makes it easy to write code that’s compatible with both Python 2 and 3.

URL

Same as the HTTP method, it should be a string that only uses ASCII characters. Note that this means that libsaas methods should take care to encode user input adecuately before handing the Request over to the executor and they need to be prepared to accept both byte strings and text.

Query parameters

This can either be a mapping of strings to strings or a simple string value. The executor will accept both byte strings and text for keys and values of the mapping, as well as numbers. It is the executor’s responsibility to correctly encode and quote those value before making a HTTP request to the server.

HTTP headers

This should be a mapping of strings using ASCII characters to ASCII characters only (just like the HTTP method or the URL). According to RFC 2616 non-ASCII characters are allowed in headers, but should be mime-encoded (as defined in RFC 20147). If you need to use such values, encode them before handing the Request over to the executor.

Parsers

Data passed to parsers from the executor is always binary, which means that on Python 2 it will be a str and on Python 3 it will be bytes. It is the parser’s responsibility to deal with any encoding issues.

Supported services

Basecamp

class basecamp.Basecamp(account_id, token_or_username, password=None)

Create a Basecamp service.

Variables:

• account_id (int) – Your Basecamp account id.
• token_or_username (str) – Either an OAuth 2.0 token, or the username if you want to use Basic authentication.
• password (str) – Only used with the Basic authentication, leave this as None when using OAuth.

GlobalAttachments

Basecamp.attachments()

Return the resource corresponding to all attachments.

GlobalAttachments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

GlobalAttachments.delete()

Delete this resource.

GlobalAttachments.get(page=None)

Fetch all resources.

Variables:page (int) – the page that will be return. If not indicated, first one is returned.

GlobalAttachments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Calendar

Basecamp.calendar(calendar_id)

Return the resource corresponding to a single calendar.

Access

Calendar.access(access_id)

Return the resource corresponding to a single access.

Access.revoke()

Delete this resource.

Accesses

Calendar.accesses()

Return the resource corresponding to all calendar accesses.

Accesses.get()

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

Accesses.grant(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

CalendarEvent

Calendar.calendar_event(calendar_event_id)

Return the resource corresponding to a single calendar event.

Comments

CalendarEvent.comments()

Return the resource corresponding to all comments.

Comments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Comments.delete()

Delete this resource.

Comments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

CalendarEvent.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

CalendarEvent.delete()

Delete this resource.

CalendarEvent.get()

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

CalendarEvent.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

CalendarEvents

Calendar.calendar_events()

Return the resource corresponding to all calendar events.

CalendarEvents.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

CalendarEvents.delete()

Delete this resource.

CalendarEvents.get()

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

CalendarEvents.past()

CalendarEvents.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Calendar.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Calendar.delete()

Delete this resource.

Calendar.get()

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

Calendar.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Calendars

Basecamp.calendars()

Return the resource corresponding to all calendars.

Calendars.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Calendars.delete()

Delete this resource.

Calendars.get()

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

Calendars.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

GlobalDocuments

Basecamp.documents()

Return the resource corresponding to all documents.

GlobalDocuments.delete()

Delete this resource.

GlobalDocuments.get()

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

GlobalDocuments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Events

Basecamp.events()

Return the resource corresponding to all events.

Events.delete()

Delete this resource.

Events.get(since, page=None)

Fetch all events.

Variables:

• since (str) – a datetime.
• page (int) – the page that will be return. If not indicated, first one is returned.

Events.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

People

Basecamp.people()

Return the resource corresponding to all people.

People.delete()

Delete this resource.

People.get()

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

Person, CurrentPerson

Basecamp.person(person_id=None)

Return the resource corresponding to a single person. If person_id is None, current person will be returned.

AssignedTodos

Person.assigned_todos()

Return the resource corresponding to all assigned todos.

AssignedTodos.delete()

Delete this resource.

AssignedTodos.get()

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

AssignedTodos.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Events

Person.events()

Return the resource corresponding to all events.

Events.delete()

Delete this resource.

Events.get(since, page=None)

Fetch all events.

Variables:

• since (str) – a datetime.
• page (int) – the page that will be return. If not indicated, first one is returned.

Events.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Person.delete()

Delete this resource.

Person.get()

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

CurrentPerson.get()

Project

Basecamp.project(project_id)

Return the resource corresponding to a single project.

Access

Project.access(access_id)

Return the resource corresponding to a single access.

Access.revoke()

Delete this resource.

Accesses

Project.accesses()

Return the resource corresponding to all project accesses.

Accesses.get()

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

Accesses.grant(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Attachments

Project.attachments()

Return the resource corresponding to all attachments.

Attachments.delete()

Delete this resource.

Attachments.get(page=None)

Fetch all resources.

Variables:page (int) – the page that will be return. If not indicated, first one is returned.

Attachments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

CalendarEvent

Project.calendar_event(calendar_event_id)

Return the resource corresponding to a single calendar event.

Comments

CalendarEvent.comments()

Return the resource corresponding to all comments.

Comments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Comments.delete()

Delete this resource.

Comments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

CalendarEvent.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

CalendarEvent.delete()

Delete this resource.

CalendarEvent.get()

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

CalendarEvent.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

CalendarEvents

Project.calendar_events()

Return the resource corresponding to all calendar events.

CalendarEvents.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

CalendarEvents.delete()

Delete this resource.

CalendarEvents.get()

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

CalendarEvents.past()

CalendarEvents.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Comment

Project.comment(comment_id)

Return the resource corresponding to a single comment.

Comment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Comment.delete()

Delete this resource.

Document

Project.document(document_id)

Return the resource corresponding to a single document.

Comments

Document.comments()

Return the resource corresponding to all comments.

Comments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Comments.delete()

Delete this resource.

Comments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Document.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Document.delete()

Delete this resource.

Document.get()

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

Document.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Documents

Project.documents()

Return the resource corresponding to all documents.

Documents.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Documents.delete()

Delete this resource.

Documents.get()

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

Documents.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Events

Project.events()

Return the resource corresponding to all events.

Events.delete()

Delete this resource.

Events.get(since, page=None)

Fetch all events.

Variables:

• since (str) – a datetime.
• page (int) – the page that will be return. If not indicated, first one is returned.

Events.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Message

Project.message(message_id)

Return the resource corresponding to a single message.

Comments

Message.comments()

Return the resource corresponding to all comments.

Comments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Comments.delete()

Delete this resource.

Comments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Message.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Message.delete()

Delete this resource.

Message.get()

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

Message.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Messages

Project.messages()

Return the resource corresponding to all project messages.

Messages.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Messages.delete()

Delete this resource.

Messages.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Todo

Project.todo(todo_id)

Return the resource corresponding to a single todo.

Comments

Todo.comments()

Return the resource corresponding to all comments.

Comments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Comments.delete()

Delete this resource.

Comments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Todo.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Todo.delete()

Delete this resource.

Todo.get()

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

Todo.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Todolist

Project.todolist(todolist_id)

Return the resource corresponding to a single todolist.

Todos

Todolist.todos()

Return the resource corresponding to all todos.

Todos.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Todos.delete()

Delete this resource.

Todos.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Todolist.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Todolist.delete()

Delete this resource.

Todolist.get()

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

Todolist.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Todolists

Project.todolists()

Return the resource corresponding to all todolists.

Todolists.completed()

Todolists.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Todolists.delete()

Delete this resource.

Todolists.get()

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

Todolists.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ProjectTopics

Project.topics()

Return the resource corresponding to all project topics.

ProjectTopics.delete()

Delete this resource.

ProjectTopics.get(page=None)

Fetch all topics.

Variables:page (int) – the page that will be return. If not indicated, first one is returned.

ProjectTopics.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Upload

Project.upload(upload_id)

Return the resource corresponding to a single upload.

Comments

Upload.comments()

Return the resource corresponding to all comments.

Comments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Comments.delete()

Delete this resource.

Comments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Upload.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Upload.get()

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

Uploads

Project.uploads()

Return the resource corresponding to all uploads.

Uploads.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Uploads.delete()

Delete this resource.

Uploads.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Project.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Project.delete()

Delete this resource.

Project.get()

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

Project.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Projects

Basecamp.projects()

Return the resource corresponding to all projects.

Projects.archived()

Projects.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Projects.delete()

Delete this resource.

Projects.get()

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

Projects.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

GlobalTodolists

Basecamp.todolists()

Return the resource corresponding to all todolists.

GlobalTodolists.completed()

GlobalTodolists.delete()

Delete this resource.

GlobalTodolists.get()

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

GlobalTodolists.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Topics

Basecamp.topics()

Return the resource corresponding to all topics.

Topics.delete()

Delete this resource.

Topics.get()

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

Topics.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

BitBucket

class bitbucket.BitBucket(username, password=None)

Create a BitBucket service.

Variables:

• username (str) – The username for the authenticated user.
• password (str) – The password for the authenticated user.

Email

BitBucket.email(email_id)

Return the resource corresponding to a single email

Email.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Email.delete()

Delete this email address from the user account

Email.get()

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

Email.primary()

Set this email as de primary email.

Email.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Emails

BitBucket.emails()

Return the resource corresponding to all the emails

Emails.add(address)

Add an email to the user account.

Emails.delete()

Delete this resource.

Emails.get()

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

Emails.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Repo

BitBucket.repo(user, repo)

Return the resource corresponding to one repository

Changeset

Repo.changeset(changeset_md5)

Return a resource corresponding to a changeset for this repo.

Changeset.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Changeset.delete()

Delete this resource.

Changeset.diffstat()

Return the diffstat for this changeset

Changeset.get()

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

Changeset.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Changesets

Repo.changesets()

Return a resource corresponding to all the changesets for this repo.

Changesets.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Changesets.delete()

Delete this resource.

Changesets.get(start='tip', limit=15)

Fetch changesets

Variables:

• start – Changesets start default is ‘tip’
• limit – Limit of changesets, default is 15

Changesets.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue

Repo.issue(id)

Return a resource corresponding to an issue from this repo.

IssueComment

RepoIssue.comment(comment_id)

Return the resource corresponding to a single comment of this issue.

IssueComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComment.delete()

Delete this resource.

IssueComment.get()

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

IssueComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComments

RepoIssue.comments()

Return the resource corresponding to the comments of this issue.

IssueComments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComments.delete()

Delete this resource.

IssueComments.get()

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

IssueComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.delete()

Delete this resource.

RepoIssue.followers()

Fetch the followers of this issue.

RepoIssue.get()

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

RepoIssue.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues

Repo.issues()

Return a resource corresponding to all issues from this repo.

IssueComment

RepoIssues.component(component_id)

Return the resources corresponding to one component of this issue.

IssueComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComment.delete()

Delete this resource.

IssueComment.get()

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

IssueComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComponents

RepoIssues.components()

Return the resource corresponding to the components of this issue.

IssueComponents.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComponents.delete()

Delete this resource.

IssueComponents.get()

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

IssueComponents.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueMilestone

RepoIssues.milestone(milestone_id)

Return the resource corresponding to one milestone of this issue.

IssueMilestone.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueMilestone.delete()

Delete this resource.

IssueMilestone.get()

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

IssueMilestone.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueMilestones

RepoIssues.milestones()

Return the resources corresponding to the milestones of this issue.

IssueMilestones.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueMilestones.delete()

Delete this resource.

IssueMilestones.get()

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

IssueMilestones.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueVersion

RepoIssues.version(version_id)

Return the resource corresponding to one version of this issue.

IssueVersion.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueVersion.delete()

Delete this resource.

IssueVersion.get()

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

IssueVersion.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueVersions

RepoIssues.versions()

Return the resource corresponding to the versions of this issue.

IssueVersions.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueVersions.delete()

Delete this resource.

IssueVersions.get()

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

IssueVersions.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues.create(obj)

Create a new Issue.

Variables:obj –

a Python object with the needed params that can be: title: The title of the new issue content: The content of the new issue component: The componen associated with the issue milestone: The milestone associated with the issue version: The version associated with the issue responsible: The username of the person responsible for the issue priority: The priority of the issue. Valid priorities are:

• trivial
• minor
• major
• critical
• blocker

status: The status of the issue. Val statuses are:

• new
• open
• resolved
• on hold
• invalid
• duplicate
• wontfix

kind: The kind of the issue. Valid kinds are:

• bug
• enhancement
• proposal
• task

RepoIssues.delete()

Delete this resource.

RepoIssues.filter(filters)

Search through the issues applying filters.

Look at https://confluence.atlassian.com/display/BITBUCKET/Issues to get a complete list of possible filters.

Variables:filters (dict of str to str or tuple of str) – A dictionary of filters. Keys are strings corresponding to the filter names and values are ether string filter values or tuples, in which case their conditions are implicitly ORed. For example, {“title”: (“~one”, “~two”)} would mean issues with the title containing either “one” or “two”

RepoIssues.get(search=None, start=None, limit=None)

Fetch issues for this repository based on the filter parameters.

RepoIssues.search(search=None)

Search through issues.

Variables:search – the query string parameter.

RepoIssues.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLink

Repo.link(id)

Reurn a resource corresponding to a link from this repo.

RepoLink.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLink.delete()

Delete this resource.

RepoLink.get()

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

RepoLink.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLinks

Repo.links()

Return a resouce corresponding to all the links from this repo.

RepoLinks.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLinks.delete()

Delete this resource.

RepoLinks.get()

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

RepoLinks.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoPrivileges

Repo.privileges(specific_user=None)

Return a resource corresponding to all privileges from this repo, either for everyone or for a specific user.

RepoPrivileges.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoPrivileges.delete()

Delete this resource.

RepoPrivileges.get(filter=None)

RepoPrivileges.grant(privilege)

Grant a privilege on the repo.

Variables:privilege (str) – The privilege to grant.

RepoPrivileges.revoke()

Revoke privileges on the repo from the user.

RepoPrivileges.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Service

Repo.service(service_id)

Return a resource corresponding to one service for this repo.

Service.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Service.delete()

Delete this resource.

Service.get()

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

Service.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Services

Repo.services()

Return a resource corresponding to all the services for this repo.

Services.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Services.delete()

Delete this resource.

Services.get()

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

Services.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Repo.branches()

Fetch the repository branches.

Repo.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Repo.delete()

Delete this resource.

Repo.events(start=0, limit=15, etype=None)

Fetch events for this repository.

Variables:

• start – Event start, default is 0.
• limit – Event result limit, default is 15.
• type – Event type, for example ‘issue_comment’.

Repo.followers()

Fetch the followers of this repo.

Repo.get()

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

Repo.invite(user, permission)

Invite a user to participate in the repository, with the given permissions.

Variables:

• user (str) – The email of the user to invite.
• permission (str) – The permission to grant (either read or write)

Repo.tags()

Fetch the repository tags.

Repo.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Repos

BitBucket.repos()

Return the resource corresponding to all the repositories

Repos.create(name, scm=None, is_private=False)

Create a new repository.

Variables:

• name – the repository name.
• scm – the type of repository you want to create, can be: git: for git repository hg: for mercurial repository

Repos.delete()

Delete a repository.

Repos.get(*args, **kwargs)

Fetch all repositories you have access to.

Repos.search(name=None)

Search for repositories with the given name.

Repos.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

User

BitBucket.user(user_id=None)

Return the resource corresponding to all the users

Group

User.group(group_name)

Return a resource corresponding a single user’s groups.

This resource only exists for User resources that specify a concrete username.

GroupMember

Group.member(member)

Return the resource corresponding to a member of the group.

GroupMember.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

GroupMember.delete()

Delete this resource.

GroupMember.get()

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

GroupMember.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

GroupMembers

Group.members()

Return the resource corresponding to all members of the group.

GroupMembers.create(username)

GroupMembers.delete()

Delete this resource.

GroupMembers.get()

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

GroupMembers.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Group.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Group.delete()

Delete this resource.

Group.get()

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

Group.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

GroupPrivileges

User.group_privileges(group=None, repo=None)

Return a resource corresponding to the group privileges for a user.

This resource only exists for User resources that specify a concrete username.

GroupPrivileges.get(filter=None, private=None)

Fetch the group privileges.

Variables:

• filter (str) – Only return specific privileges (read, write, admin).
• private (bool) – Only include private repositories.

GroupPrivileges.grant(group, repo, privilege)

Grant a privilege for a repository to a group.

GroupPrivileges.revoke(group, repo)

Revoke privileges for a repository from a group.

Groups

User.groups()

Return a resource corresponding to all of the user’s groups.

This resource only exists for User resources that specify a concrete username.

Groups.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Groups.delete()

Delete this resource.

Groups.get()

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

Groups.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

User.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

User.delete()

Delete this resource.

User.events(start=0, limit=15, etype=None)

Fetch events for this user.

Variables:

• start – Event start, default is 0.
• limit – Event result limit, default is 15.
• type – Event type, for example ‘issue_comment’.

User.followers()

Fetch the followers of this user.

User.follows()

Fetch the list of repositories the authenticated user follows.

User.get()

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

User.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Bitly

class bitly.Bitly(token)

Create a Bitly service.

Variables:token (str) – an OAuth 2.0 token.

HighValue

Bitly.highvalue()

Return the resource corresponding to all high-value links.

HighValue.get(limit)

Returns a specified number of “high-value” bitly links that are popular across bitly at this particular moment.

Variables:limit (int) – the maximum number of high-value links to return.

Link

Bitly.link(link)

Return the resource corresponding to a single link.

Link.category()

Returns the detected categories for a document, in descending order of confidence.

Link.clicks(unit=None, units=None, timezone=None, rollup=None, limit=None, unit_reference_ts=None)

Returns the number of clicks on a single bitly link.

Variables:

• unit (str) – timspan: minute, hour, day, week or month. When unit is minute the maximum value for units is 60. if` not indicated, defaults to day.
• units (int) – an integer representing the time units to query data for. If -1 is passed, it will return all units of time.
• timezone (str) – an integer hour offset from UTC (-14..14) or a timezone string. If not indicated, defaults to America/New_York.
• rollup (bool) – returns data for multiple units rolled up to a single result instead of a separate value for each period of time.
• limit (int) – the number of rows it will return. Default is 100.
• unit_reference_ts (int) – an epoch timestamp, indicating the most recent time for which to pull metrics. If not indicated, it defaults to now.

Link.content(content_type=None)

Returns the “main article” from the linked page, as determined by the content extractor, in either HTML or plain text format.

Variables:content_type (str) – specifies whether to return the content as html or plain text. if` not indicated, defaults to ‘html’.

Link.countries(unit=None, units=None, timezone=None, limit=None, unit_reference_ts=None)

Returns metrics about the countries referring click traffic to a single bitly link.

Variables:

• unit (str) – timspan: minute, hour, day, week or month. When unit is minute the maximum value for units is 60. if` not indicated, defaults to day.
• units (int) – an integer representing the time units to query data for. If -1 is passed, it will return all units of time.
• timezone (str) – an integer hour offset from UTC (-14..14) or a timezone string. If not indicated, defaults to America/New_York.
• limit (int) – the number of rows it will return. Default is 100.
• unit_reference_ts (int) – an epoch timestamp, indicating the most recent time for which to pull metrics. If not indicated, it defaults to now.

Link.encoders_count()

Returns the number of users who have shortened a single bitly link.

Link.info()

Returns metadata about a single bitly link.

Link.language()

Returns the significant languages for the bitly link.

Link.location()

Returns the significant locations for the bitly link or None if locations do not exist.

Link.referrers(unit=None, units=None, timezone=None, limit=None, unit_reference_ts=None)

Returns metrics about the pages referring click traffic to a single bitly link.

Variables:

• unit (str) – timspan: minute, hour, day, week or month. When unit is minute the maximum value for units is 60. if` not indicated, defaults to day.
• units (int) – an integer representing the time units to query data for. If -1 is passed, it will return all units of time.
• timezone (str) – an integer hour offset from UTC (-14..14) or a timezone string. If not indicated, defaults to America/New_York.
• limit (int) – the number of rows it will return. Default is 100.
• unit_reference_ts (int) – an epoch timestamp, indicating the most recent time for which to pull metrics. If not indicated, it defaults to now.

Link.referrers_by_domain(unit=None, units=None, timezone=None, limit=None, unit_reference_ts=None)

Returns metrics about the pages referring click traffic to a single bitly link, grouped by referring domain.

Variables:

• unit (str) – timspan: minute, hour, day, week or month. When unit is minute the maximum value for units is 60. if` not indicated, defaults to day.
• units (int) – an integer representing the time units to query data for. If -1 is passed, it will return all units of time.
• timezone (str) – an integer hour offset from UTC (-14..14) or a timezone string. If not indicated, defaults to America/New_York.
• limit (int) – the number of rows it will return. Default is 100.
• unit_reference_ts (int) – an epoch timestamp, indicating the most recent time for which to pull metrics. If not indicated, it defaults to now.

Link.referring_domains(unit=None, units=None, timezone=None, limit=None, unit_reference_ts=None)

Returns metrics about the domains referring click traffic to a single bitly link.

Variables:

• unit (str) – timspan: minute, hour, day, week or month. When unit is minute the maximum value for units is 60. if` not indicated, defaults to day.
• units (int) – an integer representing the time units to query data for. If -1 is passed, it will return all units of time.
• timezone (str) – an integer hour offset from UTC (-14..14) or a timezone string. If not indicated, defaults to America/New_York.
• limit (int) – the number of rows it will return. Default is 100.
• unit_reference_ts (int) – an epoch timestamp, indicating the most recent time for which to pull metrics. If not indicated, it defaults to now.

Link.shares(unit=None, units=None, timezone=None, rollup=None, limit=None, unit_reference_ts=None)

Returns metrics about a shares of a single link.

Variables:

• unit (str) – timspan: minute, hour, day, week or month. When unit is minute the maximum value for units is 60. if` not indicated, defaults to day.
• units (int) – an integer representing the time units to query data for. If -1 is passed, it will return all units of time.
• timezone (str) – an integer hour offset from UTC (-14..14) or a timezone string. If not indicated, defaults to America/New_York.
• rollup (bool) – returns data for multiple units rolled up to a single result instead of a separate value for each period of time.
• limit (int) – the number of rows it will return. Default is 100.
• unit_reference_ts (int) – an epoch timestamp, indicating the most recent time for which to pull metrics. If not indicated, it defaults to now.

Link.social()

Returns the “social score” for a specified bitly link.

RealTime

Bitly.realtime()

Return the resource corresponding to a single object.

RealTime.bursting_phrases()

Returns phrases that are receiving an uncharacteristically high volume of click traffic, and the individual links (hashes) driving traffic to pages containing these phrases.

RealTime.clickrate(phrase)

Returns the click rate for content containing a specified phrase.

Variables:phrase (str) – the phrase for which you’d like to get the click rate.

RealTime.hot_phrases()

Returns phrases that are receiving a consistently high volume of click traffic, and the individual links (hashes) driving traffic to pages containing these phrases.

Search

Bitly.search()

Return the resource corresponding to all links.

Search.get(limit=None, offset=None, query=None, lang=None, cities=None, domain=None, fields=None)

Search links receiving clicks across bitly by content, language, location, and more

Variables:

• limit (int) – the maximum number of links to return.
• offset (int) – which result to start with (defaults to 0).
• query (str) – the string to query for.
• lang (str) – favor results in this language (two letter ISO code).
• cities (str) – show links active in this city.
• domain (str) – restrict results to this web domain.
• fields (str) – which fields to return in the response (comma-separated). May be any of: domain, initial_epoch, h2, h3, site, lastindexed, keywords, last_indexed_epoch, title, initial, summaryText, content, score, summaryTitle, type, description, cities, lang, url, referrer, aggregate_link, lastseen, page, ogtitle aggregate_link. By default, all will be returned.

User

Bitly.user()

Return the resource corresponding to a single user.

User.clicks(unit=None, units=None, timezone=None, rollup=None, limit=None, unit_reference_ts=None)

Returns the aggregate number of clicks on all of the authenticated user’s bitly links.

Variables:

• unit (str) – timspan: minute, hour, day, week or month. When unit is minute the maximum value for units is 60. if` not indicated, defaults to day.
• units (int) – an integer representing the time units to query data for. If -1 is passed, it will return all units of time.
• timezone (str) – an integer hour offset from UTC (-14..14) or a timezone string. If not indicated, defaults to America/New_York.
• rollup (bool) – returns data for multiple units rolled up to a single result instead of a separate value for each period of time.
• limit (int) – the number of rows it will return. Default is 100.
• unit_reference_ts (int) – an epoch timestamp, indicating the most recent time for which to pull metrics. If not indicated, it defaults to now.

User.countries(unit=None, units=None, timezone=None, rollup=None, limit=None, unit_reference_ts=None)

Returns aggregate metrics about the countries referring click traffic to all of the authenticated user’s bitly links.

Variables:

• unit (str) – timspan: minute, hour, day, week or month. When unit is minute the maximum value for units is 60. if` not indicated, defaults to day.
• units (int) – an integer representing the time units to query data for. If -1 is passed, it will return all units of time.
• timezone (str) – an integer hour offset from UTC (-14..14) or a timezone string. If not indicated, defaults to America/New_York.
• rollup (bool) – returns data for multiple units rolled up to a single result instead of a separate value for each period of time.
• limit (int) – the number of rows it will return. Default is 100.
• unit_reference_ts (int) – an epoch timestamp, indicating the most recent time for which to pull metrics. If not indicated, it defaults to now.

User.info(login=None, full_name=None)

Return or update information about a user.

Variables:

• login (str) – the bitly login of the user whose info to look up. If not given, the authenticated user will be used.
• full_name (str) – set the users full name value (only available for the authenticated user).

User.link_history(link=None, limit=None, offset=None, created_before=None, created_after=None, modified_after=None, expand_client_id=None, archived=None, private=None, user=None)

Returns entries from a user’s link history in reverse chronological order.

:var link the bitly link to return metadata for (when specified,

overrides all other options).

:var limit the max number of results to return. :vartype login: int

:var offset the numbered result at which to start (for pagination). :vartype offset: int

:var created_before timestamp as an integer unix epoch. :vartype created_before: int

:var created_after timestamp as an integer unix epoch. :vartype created_after: int

:var modified_after timestamp as an integer unix epoch. :vartype modified_after: int

:var expand_client_id whether to provide additional information about

encoding application.

:var archived whether to include or exclude archived

history entries. Defaults to ‘off’.

:var private whether to include or exclude private

history entries. Defaults to ‘both’.

Variables:user (str) – the user for whom to retrieve history entries (if different from authenticated user).

User.network_history(limit=None, offset=None, expand_client_id=None, expand_user=None)

Returns entries from a user’s network history in reverse chronogical order.

:var limit the max number of results to return. :vartype login: int

:var offset the numbered result at which to start (for pagination). :vartype offset: int

:var expand_client_id whether to provide additional information about

encoding application.

:var expand_user include extra user info in response. :vartype expand_user: bool

User.popular_links(unit=None, units=None, timezone=None, limit=None, unit_reference_ts=None)

Returns the authenticated user’s most-clicked bitly links (ordered by number of clicks) in a given time period.

Variables:

• unit (str) – timspan: minute, hour, day, week or month. When unit is minute the maximum value for units is 60. if` not indicated, defaults to day.
• units (int) – an integer representing the time units to query data for. If -1 is passed, it will return all units of time.
• timezone (str) – an integer hour offset from UTC (-14..14) or a timezone string. If not indicated, defaults to America/New_York.
• limit (int) – the number of rows it will return. Default is 100.
• unit_reference_ts (int) – an epoch timestamp, indicating the most recent time for which to pull metrics. If not indicated, it defaults to now.

User.referrers(unit=None, units=None, timezone=None, rollup=None, limit=None, unit_reference_ts=None)

Returns aggregate metrics about the pages referring click traffic to all of the authenticated user’s bitly links.

Variables:

• unit (str) – timspan: minute, hour, day, week or month. When unit is minute the maximum value for units is 60. if` not indicated, defaults to day.
• units (int) – an integer representing the time units to query data for. If -1 is passed, it will return all units of time.
• timezone (str) – an integer hour offset from UTC (-14..14) or a timezone string. If not indicated, defaults to America/New_York.
• rollup (bool) – returns data for multiple units rolled up to a single result instead of a separate value for each period of time.
• limit (int) – the number of rows it will return. Default is 100.
• unit_reference_ts (int) – an epoch timestamp, indicating the most recent time for which to pull metrics. If not indicated, it defaults to now.

User.referring_domains(unit=None, units=None, timezone=None, rollup=None, limit=None, unit_reference_ts=None)

Returns aggregate metrics about the domains referring click traffic to all of the authenticated user’s bitly links

Variables:

• unit (str) – timspan: minute, hour, day, week or month. When unit is minute the maximum value for units is 60. if` not indicated, defaults to day.
• units (int) – an integer representing the time units to query data for. If -1 is passed, it will return all units of time.
• timezone (str) – an integer hour offset from UTC (-14..14) or a timezone string. If not indicated, defaults to America/New_York.
• rollup (bool) – returns data for multiple units rolled up to a single result instead of a separate value for each period of time.
• limit (int) – the number of rows it will return. Default is 100.
• unit_reference_ts (int) – an epoch timestamp, indicating the most recent time for which to pull metrics. If not indicated, it defaults to now.

User.share_counts(unit=None, units=None, timezone=None, rollup=None, limit=None, unit_reference_ts=None)

Returns the number of shares by the authenticated user in a given time period.

Variables:

• unit (str) – timspan: minute, hour, day, week or month. When unit is minute the maximum value for units is 60. if` not indicated, defaults to day.
• units (int) – an integer representing the time units to query data for. If -1 is passed, it will return all units of time.
• timezone (str) – an integer hour offset from UTC (-14..14) or a timezone string. If not indicated, defaults to America/New_York.
• rollup (bool) – returns data for multiple units rolled up to a single result instead of a separate value for each period of time.
• limit (int) – the number of rows it will return. Default is 100.
• unit_reference_ts (int) – an epoch timestamp, indicating the most recent time for which to pull metrics. If not indicated, it defaults to now.

User.tracking_domain_list()

Returns a list of tracking domains a user has configured.

CartoDB

class cartodb.CartoDB(subdomain, api_key)

Create a CartoDB service.

Variables:

• subdomain (str) – The account-specific part of the CartoDB domain, for instance use mycompany if your CartpDB domain is mycompany.cartodb.com.
• api_key (str) – The API key.

Service methods

CartoDB.sql(q)

SQL request to the CartoDB account

Variables:q (str) – The sql query

CartoDB.viz(type=None)

Get the list of visualizations (undocumented endpoint)

Variables:type – The visualization type

Compete

class compete.Compete(api_key)

Create an Compete service.

Variables:api_key (str) – The API key.

Site

Compete.site(domain)

Return the resource corresponding to a single site.

Metric

Site.metric(metric_id)

Return the resource corresponding to a single metric for the site.

Metric.get(latest=None, start_date=None, end_date=None)

Fetch the object’s data.

Variables:

• latest (int) – Returns the latest N months or days. If omitted, it returns data for the most recent 13 months for a monthly metric. For daily metrics, it returns data for the most recent 30 days.
• start_date (str) – Return specific start date. If omitted, it returns data for the most recent 13 months for a monthly metric. For daily metrics, it returns data for the most recent 30 days.
• end_date (str) – Returns specific end date. If omitted, it returns data for the most recent 13 months for a monthly metric. For daily metrics, it returns data for the most recent 30 days.

Desk

class desk.Desk(subdomain, api_key, api_secret=None, access_token=None, access_token_secret=None)

Create a Desk service.

Variables:

• subdomain (str) – The account-specific part of the Desk domain, for instance use mycompany if your Desk domain is mycompany.desk.com, or the full domain if using Desk whitelabel, for instance support.mycompany.com. If the parameter contains a dot, it is treated as a full domain, otherwise as a subdomain.
• api_key (str) – The API key.
• api_secret (str) – API secret.
• access_token (str) – OAuth 1.0a access token.
• access_token_secret (str) – OAuth 1.0a access token secret. requests.

Article

Desk.article(article_id)

Return the resource corresponding to a single article.

Article.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Article.delete()

Delete this resource.

Article.get(embed=None, fields=None)

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

Upstream documentation: http://dev.desk.com/API/using-the-api/

Article.update(obj)

Case

Desk.case(case_id, is_external=False)

Return the resource corresponding to a single case.

Variables:

• case_id (bool) – The case id
• is_external – Use the external id

Replies

Case.replies()

Return the resource corresponding to the case replies

Replies.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Replies.delete()

Delete this resource.

Replies.get(embed=None, fields=None, per_page=None, page=None)

Returns a paginated list of elements

Upstream documentation: http://dev.desk.com/API/using-the-api/

Replies.update(obj)

Reply

Case.reply(reply_id)

Return the resource corresponding to a single reply

Reply.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Reply.delete()

Delete this resource.

Reply.get(embed=None, fields=None)

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

Upstream documentation: http://dev.desk.com/API/using-the-api/

Reply.update(obj)

Case.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Case.delete()

Delete this resource.

Case.get(embed=None, fields=None)

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

Upstream documentation: http://dev.desk.com/API/using-the-api/

Case.history(per_page=None, page=None)

The case history endpoint will display a paginated list of all events/actions that have happened to the case

Upstream documentation: http://dev.desk.com/API/cases#history

Case.message()

Retrieve the original message for this case.

Upstream documentation: http://dev.desk.com/API/cases#message-show

Case.update(obj)

Cases

Desk.cases()

Return the resource corresponding to all the cases.

Cases.get(embed=None, fields=None, per_page=None, page=None)

Retrieve a paginated list of all cases.

Upstream documentation: http://dev.desk.com/API/cases#list

Cases.search(name=None, first_name=None, last_name=None, email=None, phone=None, company=None, twitter=None, labels=None, case_id=None, subject=None, description=None, status=None, priority=None, assigned_group=None, assigned_user=None, channels=None, notes=None, attachments=None, created=None, updated=None, since_created_at=None, max_created_at=None, since_updated_at=None, max_updated_at=None, since_id=None, max_id=None, per_page=None, page=None, embed=None, fields=None, **case_custom_fields)

Search cases based on a combination of parameters with pagination.

Upstream documentation: http://dev.desk.com/API/cases#search

Companies

Desk.companies()

Return the resource corresponding to all companies.

Companies.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Companies.get(embed=None, fields=None, per_page=None, page=None)

Retrieve a paginated list of all companies

Upstream documentation: http://dev.desk.com/API/companies/#list

Companies.search(q, per_page=None, page=None, sort_field=None, sort_direction=None)

Search companies based on a search parameter with pagination.

Upstream documentation: http://dev.desk.com/API/companies/#search

Company

Desk.company(company_id)

Return the resource corresponding to a single company.

Cases

Company.cases()

Cases.get(embed=None, fields=None, per_page=None, page=None)

Retrieve a paginated list of all cases.

Upstream documentation: http://dev.desk.com/API/cases#list

Cases.search(name=None, first_name=None, last_name=None, email=None, phone=None, company=None, twitter=None, labels=None, case_id=None, subject=None, description=None, status=None, priority=None, assigned_group=None, assigned_user=None, channels=None, notes=None, attachments=None, created=None, updated=None, since_created_at=None, max_created_at=None, since_updated_at=None, max_updated_at=None, since_id=None, max_id=None, per_page=None, page=None, embed=None, fields=None, **case_custom_fields)

Search cases based on a combination of parameters with pagination.

Upstream documentation: http://dev.desk.com/API/cases#search

Customers

Company.customers()

Customers.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Customers.get(embed=None, fields=None, per_page=None, page=None)

Retrieve a paginated list of all customers

Upstream documentation: http://dev.desk.com/API/customers#list

Customers.search(first_name=None, last_name=None, full_name=None, email=None, phone=None, twitter=None, external_id=None, since_created_at=None, max_created_at=None, since_updated_at=None, max_updated_at=None, since_id=None, max_id=None, per_page=None, page=None, **custom_fields)

Search customers based on a combination of parameters with pagination.

Upstream documentation: http://dev.desk.com/API/customers#search

Company.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Company.get(embed=None, fields=None)

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

Upstream documentation: http://dev.desk.com/API/using-the-api/

Company.update(obj)

Customer

Desk.customer(customer_id=None)

Return the resource corresponding to a single customer.

Cases

Customer.cases()

Cases.get(embed=None, fields=None, per_page=None, page=None)

Retrieve a paginated list of all cases.

Upstream documentation: http://dev.desk.com/API/cases#list

Cases.search(name=None, first_name=None, last_name=None, email=None, phone=None, company=None, twitter=None, labels=None, case_id=None, subject=None, description=None, status=None, priority=None, assigned_group=None, assigned_user=None, channels=None, notes=None, attachments=None, created=None, updated=None, since_created_at=None, max_created_at=None, since_updated_at=None, max_updated_at=None, since_id=None, max_id=None, per_page=None, page=None, embed=None, fields=None, **case_custom_fields)

Search cases based on a combination of parameters with pagination.

Upstream documentation: http://dev.desk.com/API/cases#search

Customer.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Customer.get(embed=None, fields=None)

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

Upstream documentation: http://dev.desk.com/API/using-the-api/

Customer.update(obj)

Customers

Desk.customers()

Return the resource corresponding to all customers.

Customers.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Customers.get(embed=None, fields=None, per_page=None, page=None)

Retrieve a paginated list of all customers

Upstream documentation: http://dev.desk.com/API/customers#list

Customers.search(first_name=None, last_name=None, full_name=None, email=None, phone=None, twitter=None, external_id=None, since_created_at=None, max_created_at=None, since_updated_at=None, max_updated_at=None, since_id=None, max_id=None, per_page=None, page=None, **custom_fields)

Search customers based on a combination of parameters with pagination.

Upstream documentation: http://dev.desk.com/API/customers#search

Group

Desk.group(group_id)

Return the resource corresponding to a single group.

Group.get(embed=None, fields=None)

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

Upstream documentation: http://dev.desk.com/API/using-the-api/

Group.group_filters(per_page=None, page=None)

Retrieve a paginated list of all filters for the given group.

Upstream documentation: http://dev.desk.com/API/groups#list-filters

Group.users(per_page=None, page=None)

Retrieve a paginated list of all users for the given group.

Upstream documentation: http://dev.desk.com/API/groups#list-users

Groups

Desk.groups()

Return the resource corresponding to all groups.

Groups.get(embed=None, fields=None, per_page=None, page=None)

Returns a paginated list of elements

Upstream documentation: http://dev.desk.com/API/using-the-api/

Insights

Desk.insights()

Return the resource corresponding to insights.

Insights.meta()

Retrieve Insights meta data for the authenticated site.

Upstream documentation: http://dev.desk.com/API/insights/#meta-show

Insights.report(resolution=None, min_date=None, max_date=None, dimension1_name=None, dimension1_values=None, dimension2_name=None, dimension2_values=None, metrics=None, sort_by=None, sort_order=None, dimension1_per_page=None, dimension1_page=None)

Create a report.

Upstream documentation: http://dev.desk.com/API/insights/#report-create

Macro

Desk.macro(macro_id)

Return the resource corresponding to a single macro.

Actions

Macro.action(action_id)

Return the resource corresponding to single macro action

Actions.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Actions.delete()

Delete this resource.

Actions.get(embed=None, fields=None, per_page=None, page=None)

Returns a paginated list of elements

Upstream documentation: http://dev.desk.com/API/using-the-api/

Actions.update(obj)

Actions

Macro.actions()

Return the resource corresponding to macro actions

Actions.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Actions.delete()

Delete this resource.

Actions.get(embed=None, fields=None, per_page=None, page=None)

Returns a paginated list of elements

Upstream documentation: http://dev.desk.com/API/using-the-api/

Actions.update(obj)

Macro.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Macro.delete()

Delete this resource.

Macro.get(embed=None, fields=None)

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

Upstream documentation: http://dev.desk.com/API/using-the-api/

Macro.update(obj)

Macros

Desk.macros()

Return the resource corresponding to all macros.

Macros.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Macros.delete()

Delete this resource.

Macros.get(embed=None, fields=None, per_page=None, page=None)

Returns a paginated list of elements

Upstream documentation: http://dev.desk.com/API/using-the-api/

SiteSettings

Desk.site_settings()

Return the resource corresponding to the site settings.

SiteSettings.get(embed=None, fields=None, per_page=None, page=None)

Returns a paginated list of elements

Upstream documentation: http://dev.desk.com/API/using-the-api/

Topic

Desk.topic(topic_id)

Return the resource corresponding to a single topic.

Articles

Topic.articles()

Return the resource corresponding to topic articles

Translation

Articles.translation(translation_id)

Return the resource corresponding to a single translation

Translation.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Translation.delete()

Delete this resource.

Translation.get(embed=None, fields=None)

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

Upstream documentation: http://dev.desk.com/API/using-the-api/

Translation.update(obj)

Translations

Articles.translations()

Return the resource corresponding to the article translations

Translations.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Translations.delete()

Delete this resource.

Translations.get(embed=None, fields=None, per_page=None, page=None)

Returns a paginated list of elements

Upstream documentation: http://dev.desk.com/API/using-the-api/

Translations.update(obj)

Articles.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Articles.delete()

Delete this resource.

Articles.get(embed=None, fields=None, per_page=None, page=None)

Returns a paginated list of elements

Upstream documentation: http://dev.desk.com/API/using-the-api/

Articles.search(text=None, topic_ids=None, per_page=None, page=None)

Perform a search across all public articles.

Upstream documentation: http://dev.desk.com/API/articles#search

Articles.update(obj)

Translation

Topic.translation(translation_id)

Return the resource corresponding to a single translation

Translation.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Translation.delete()

Delete this resource.

Translation.get(embed=None, fields=None)

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

Upstream documentation: http://dev.desk.com/API/using-the-api/

Translation.update(obj)

Translations

Topic.translations()

Return the resource corresponding to the topic translations

Translations.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Translations.delete()

Delete this resource.

Translations.get(embed=None, fields=None, per_page=None, page=None)

Returns a paginated list of elements

Upstream documentation: http://dev.desk.com/API/using-the-api/

Translations.update(obj)

Topic.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Topic.delete()

Delete this resource.

Topic.get(embed=None, fields=None)

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

Upstream documentation: http://dev.desk.com/API/using-the-api/

Topic.update(obj)

Topics

Desk.topics()

Return the resource corresponding to all topics.

Topics.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Topics.delete()

Delete this resource.

Topics.get(embed=None, fields=None, per_page=None, page=None)

Returns a paginated list of elements

Upstream documentation: http://dev.desk.com/API/using-the-api/

User

Desk.user(user_id)

Return the resource corresponding to a single user.

User.get(embed=None, fields=None)

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

Upstream documentation: http://dev.desk.com/API/using-the-api/

User.preference(preference_id)

Show a single user preference

Upstream documentation: http://dev.desk.com/API/users/#preferences-show

User.preferences(per_page=None, page=None)

List all of the user’s preferences.

Upstream documentation: http://dev.desk.com/API/users/#preferences-list

User.update_preference(preference_id, obj)

Update a user preference

Upstream documentation: http://dev.desk.com/API/users/#preferences

Users

Desk.users()

Return the resource corresponding to all users.

Users.get(embed=None, fields=None, per_page=None, page=None)

Returns a paginated list of elements

Upstream documentation: http://dev.desk.com/API/using-the-api/

Ducksboard

class ducksboard.Ducksboard(apikey_or_username, password='')

Create a Ducksboard service.

Variables:

• apikey_or_username (str) – Your apikey or your username if you want to get or reset your API key.
• password (str) – Only used with your username to get or reset your API key.

Account

Ducksboard.account(account_id)

Return the resource corresponding to a single account.

Account.delete()

Delete this resource.

Account.get()

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

Accounts

Ducksboard.accounts()

Return the resource corresponding to all the accounts.

Accounts.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Accounts.get()

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

Dashboard

Ducksboard.dashboard(slug)

Return the resource corresponding to a single dashboard.

Token

Dashboard.token(token)

Token.delete()

Delete this resource.

Token.get()

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

Tokens

Dashboard.tokens()

Tokens.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Tokens.get()

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

Dashboard.accessed()

Update the access time of a dashboard. The last accessed dashboard is the one that gets displayed by default when accessing the application.

Dashboard.delete()

Delete this resource.

Dashboard.get()

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

Dashboard.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Dashboard.widgets()

Get a collection of widgets from a dashboard.

Dashboards

Ducksboard.dashboards()

Return the resource corresponding to all the dashboards.

Dashboards.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Dashboards.get()

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

Datasource

Ducksboard.data_source(label)

Return the resource corresponding to a datasource. Datasources can only be accesed using the API key

Datasource.delete()

Delete all data for a given data source.

Datasource.last(count=None)

Get the last count values for a given data source, ordered by their timestamp, newest data first. This resource can be used for all data sources.

Variables:count (int) – The amount of data returned. It might be less than the count parameter. The default value for count is 3 and the maximum is 100.

Datasource.push(obj)

Send a value or a list of values. Each value can have a timestamp associated with it. Timestamps should be UNIX timestamps expressed as numbers. If no timestamp is specified, the value is assumed to be timestamped with the current time.

Variables:obj – a Python object representing the value to push to the data source. See http://dev.ducksboard.com/apidoc/push-api/#post-values-label

Datasource.since(seconds=None)

Get the values from up to seconds ago for a given data source, ordered by their timestamp, newest data first. This resource can be used for all data sources.

Variables:seconds (int) – The first value returned might actually be from later than seconds ago. The default value for seconds is 3600 and the maximum is 7776000.

Datasource.timespan(timespan=None, timezone=None)

Get the last value for a series of periods for a given data source. The number of values returned depends on the timespan parameter. If a certain period is empty, meaning that no values from inside of it are found, the value of the previous period is substituted, or null if no previous values were found. See http://dev.ducksboard.com/apidoc/pull-api-http/#get-values-label-timespan-timespan-timespan-timezone-timezone

Variables:

• timespan (str) – The allowed values for timespan are daily, weekly and monthly, with the default of monthly.
• timezone (str) – The limits of periods are actually dependent on the timezone parameter, as depending on which timezone you want to see the data in, the last value of each period might be different. The default for timezone is UTC.

Account

Ducksboard.user()

Return the resource corresponding to your user.

Account.delete()

Delete this resource.

Account.get()

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

Widget

Ducksboard.widget(widget_id)

Return the resource corresponding to a single widget.

Widget.copy(dashboard_slug)

Copy a widget to another dashboard, specified by a slug. A new widget is created, with the same parameters as the copied one. The position is chosen automatically if not specified.

Variables:dashboard_slug (str) – dashboard slug destination

Widget.delete()

Delete this resource.

Widget.get()

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

Widget.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Widgets

Ducksboard.widgets()

Return the resource corresponding to all the widgets.

Widgets.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Widgets.get()

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

Widgets.positions(positions)

Update the positions of multiple widgets at once.

Variables:positions (dict) – The object keys are widget IDs. the values should include a row and column field. Both of them default to 1 if not present.

Flurry

class flurry.Flurry(api_access_code)

Create a Flurry service.

Variables:api_access_code (str) – The API access code.

Application

Flurry.application(application_api_key)

Returns the resource corresponding to a single application.

Event

Application.event(event_name)

Returns the resource corresponding to a single event.

Event.get(start_date, end_date, version_name=None)

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

Variables:

• start_date (str) – the first date to look metrics for.
• end_date (str) – the last date to look metrics for.
• version_name (str) – optional parameter indicating application’s version.

Events

Application.events()

Return the resource corresponding to all events.

Events.get(start_date, end_date, version_name=None)

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

Variables:

• start_date (str) – the first date to look metrics for.
• end_date (str) – the last date to look metrics for.
• version_name (str) – optional parameter indicating application’s version.

Metrics

Application.metrics()

Returns the resource corresponding to all metrics.

Metrics.active_users(*args, **kwargs)

Returns the total number of unique users who accessed the application per day.

Variables:

• start_date (str) – the first date to look metrics for.
• end_date (str) – the last date to look metrics for.
• country (str) – optional parameter indicating user’s country.
• version_name (str) – optional parameter indicating application’s version.
• group_by (str) – group data by DAYS, WEEKS or MONTHS. By default, it will group data by days.

Metrics.active_users_by_month(*args, **kwargs)

Returns the total number of unique users who accessed the application per month.

Variables:

• start_date (str) – the first date to look metrics for.
• end_date (str) – the last date to look metrics for.
• country (str) – optional parameter indicating user’s country.
• version_name (str) – optional parameter indicating application’s version.
• group_by (str) – group data by DAYS, WEEKS or MONTHS. By default, it will group data by days.

Metrics.active_users_by_week(*args, **kwargs)

Returns the total number of unique users who accessed the application per week

Variables:

• start_date (str) – the first date to look metrics for.
• end_date (str) – the last date to look metrics for.
• country (str) – optional parameter indicating user’s country.
• version_name (str) – optional parameter indicating application’s version.
• group_by (str) – group data by DAYS, WEEKS or MONTHS. By default, it will group data by days.

Metrics.avg_page_views_per_session(*args, **kwargs)

Returns the average page views per session for each day.

Variables:

• start_date (str) – the first date to look metrics for.
• end_date (str) – the last date to look metrics for.
• country (str) – optional parameter indicating user’s country.
• version_name (str) – optional parameter indicating application’s version.
• group_by (str) – group data by DAYS, WEEKS or MONTHS. By default, it will group data by days.

Metrics.avg_session_length(*args, **kwargs)

Returns the average length of a user session per day.

Variables:

• start_date (str) – the first date to look metrics for.
• end_date (str) – the last date to look metrics for.
• country (str) – optional parameter indicating user’s country.
• version_name (str) – optional parameter indicating application’s version.
• group_by (str) – group data by DAYS, WEEKS or MONTHS. By default, it will group data by days.

Metrics.median_session_length(*args, **kwargs)

Returns the median length of a user session per day.

Variables:

• start_date (str) – the first date to look metrics for.
• end_date (str) – the last date to look metrics for.
• country (str) – optional parameter indicating user’s country.
• version_name (str) – optional parameter indicating application’s version.
• group_by (str) – group data by DAYS, WEEKS or MONTHS. By default, it will group data by days.

Metrics.new_users(*args, **kwargs)

Returns the total number of unique users who used the application for the first time per day.

Variables:

• start_date (str) – the first date to look metrics for.
• end_date (str) – the last date to look metrics for.
• country (str) – optional parameter indicating user’s country.
• version_name (str) – optional parameter indicating application’s version.
• group_by (str) – group data by DAYS, WEEKS or MONTHS. By default, it will group data by days.

Metrics.page_views(*args, **kwargs)

Returns the total number of page views per day.

Variables:

• start_date (str) – the first date to look metrics for.
• end_date (str) – the last date to look metrics for.
• country (str) – optional parameter indicating user’s country.
• version_name (str) – optional parameter indicating application’s version.
• group_by (str) – group data by DAYS, WEEKS or MONTHS. By default, it will group data by days.

Metrics.retained_users(*args, **kwargs)

Returns the total number of users who remain active users of the application per day.

Variables:

• start_date (str) – the first date to look metrics for.
• end_date (str) – the last date to look metrics for.
• country (str) – optional parameter indicating user’s country.
• version_name (str) – optional parameter indicating application’s version.
• group_by (str) – group data by DAYS, WEEKS or MONTHS. By default, it will group data by days.

Metrics.sessions(*args, **kwargs)

Returns the total number of times users accessed the application per day.

Variables:

• start_date (str) – the first date to look metrics for.
• end_date (str) – the last date to look metrics for.
• country (str) – optional parameter indicating user’s country.
• version_name (str) – optional parameter indicating application’s version.
• group_by (str) – group data by DAYS, WEEKS or MONTHS. By default, it will group data by days.

Application.get()

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

Applications

Flurry.applications()

Return the resource corresponding to all applications.

Applications.get()

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

Fullcontact

class fullcontact.Fullcontact(api_key)

Create a Fullcontact service.

Variables:api_key (str) – The API key.

Enhanced

Fullcontact.enhanced(email)

Return the resource corresponding to a single person

Enhanced.get()

Fetch a single object.

Location

Fullcontact.locations()

Return the resource corresponding to all locations.

Location.enrichment(place, includeZeroPopulation=False, casing=None)

Return a collection of lostructured location data for a indicated place.

Variables:

• place (str) – The place you are interested in.
• includeZeroPopulation (bool) – Will include 0 population census locations.
• casing (str) – One of: uppercase, lowercase or titlecase.

Location.normalizer(place, includeZeroPopulation=False, casing=None)

Return structured location data for a indicated place.

Variables:

• place (str) – The place you are interested in.
• includeZeroPopulation (bool) – Will include 0 population census locations.
• casing (str) – One of: uppercase, lowercase or titlecase.

Name

Fullcontact.names()

Return the resource corresponding to all names.

Name.deducer(email=None, username=None, casing=None)

Take a username or email address provided as a string and attempts to deduce a structured name.

Variables:

• email (str) – It allows you to pass an email address.
• username (str) – It allows you to pass a username.
• casing (str) – One of: uppercase, lowercase or titlecase.

Name.normalizer(q, casing=None)

Take quasi-structured name data provided as a string and outputs the data in a structured manner.

Variables:

• q (str) – Name you would like to be normalized.
• casing (str) – One of: uppercase, lowercase or titlecase.

Name.parser(q, casing=None)

Determine what the given name and family name for a ambiguious name.

Variables:

• q (str) – Name you would like to be parsed.
• casing (str) – One of: uppercase, lowercase or titlecase.

Name.similarity(q1, q2, casing=None)

Return a score indicating how two names are similar.

Variables:

• q1 (str) – First name to compare.
• q2 (str) – Second name to compare.
• casing (str) – One of: uppercase, lowercase or titlecase.

Name.stats(name=None, givenName=None, familyName=None, casing=None)

Determine more about a name.

Variables:

• name (str) – It can be used when you only know a single name and you are uncertain whether it is the given name or family name.
• givenName (str) – It can be used when you know that the name is a first name.
• familyName (str) – It can be used when you know that the name is a last name.
• casing (str) – One of: uppercase, lowercase or titlecase.

Person

Fullcontact.person(email=None, emailMD5=None, phone=None, twitter=None, facebookUsername=None)

Return the resource corresponding to a single person

Person.get(queue=None, style=None, prettyPrint=None, countryCode=None)

Fetch a single object.

Variables:

• queue (int) – Using this parameter notifies FullContact that the query in question will be called later.
• style (str) – The style parameter can be used to control the document structure returned. Only available for email lookups.
• prettyPrint (str) – Used to disable prettyprint formatting response
• countryCode (str) – For phone lookups, it must be passed when using non US/Canada based numbers. Use the ISO-3166 two-digit country code. It defaults to US.

GitHub

class github.GitHub(token_or_username, password=None, apiroot='https://api.github.com')

Create a GitHub service.

Variables:

• token_or_username (str) – Either an OAuth 2.0 token, or the username if you want to use Basic authentication.
• password (str) – Only used with the Basic authentication, leave this as None when using OAuth.
• apiroot (str) – Only used for GitHub Enterprise, defaults to GitHub api url

Authorization

GitHub.authorization(authorization_id)

Return the resource corresponding to a single authorization. Authorizations can only be accessed when using Basic authentication.

Authorization.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Authorization.delete()

Delete this resource.

Authorization.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Authorization.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Authorizations

GitHub.authorizations()

Return the resource corresponding to all the authorizations. Authorizations can only be accessed when using Basic authentication.

Authorizations.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Authorizations.delete()

Delete this resource.

Authorizations.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Authorizations.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Gist

GitHub.gist(gist_id)

Return the resource corresponding to a single gist.

Gist.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Gist.delete()

Delete this resource.

Gist.fork()

Fork this gist.

Gist.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Gist.is_starred()

Check if this gist is starred.

Returns:bool

Gist.star()

Star this gist.

Gist.unstar()

Unstar this gist.

Gist.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Gists

GitHub.gists()

Return the resource corresponding to all the gists.

GistComment

Gists.comment(comment_id)

Return the resource corresponding to a single comment on a gist.

When updating comments, use a simple string as the parameter to update, you don’t have to use {“body”: <comment body>}.

GistComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

GistComment.delete()

Delete this resource.

GistComment.get(format=None, page=None, per_page=None)

GistComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Gists.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Gists.delete()

Delete this resource.

Gists.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Gists.public(page=None, per_page=None)

Fetch public gists. The parameters are the same as for get.

Gists.starred(page=None, per_page=None)

Fetch gists starred by the authenticated user. The parameters are the same as for get.

Gists.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Issues

GitHub.issues()

Return the resource corresponding to all the issues of the authenticated user.

Issues.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Issues.delete()

Delete this resource.

Issues.get(filter='assigned', state='open', labels=None, sort='created', direction='desc', since=None, format=None, page=None, per_page=None)

Fetch the authenticated user’s issues based on the filter parameters, and using the specified format.

For details on the meanings and allowed values for each parameter, see http://developer.github.com/v3/issues/#list-issues.

Issues.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Organizations

GitHub.org(org)

Return the resource corresponding to a single organization.

Member

Organizations.member(user)

Return a resource corresponding to a member of this org.

Member.delete()

Delete this resource.

Member.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Members

Organizations.members()

Return a resource corresponding to members of this org.

Members.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

PublicMember

Organizations.public_member(user)

Return a resource corresponding to a public member of this org.

PublicMember.delete()

Delete this resource.

PublicMember.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

PublicMember.publicize()

PublicMembers

Organizations.public_members()

Return a resource corresponding to public members of this org.

PublicMembers.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

OrganizationRepo

Organizations.repo(repo)

Return a resource corresponding to single repo for this org.

RepoCollaborators

OrganizationRepo.collaborators()

Return a resource corresponding to all collaborators in this repo.

RepoCollaborators.add(user)

Add a collaborator to this repo.

Variables:user (str) – The username of the new collaborator.

RepoCollaborators.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoCollaborators.is_collaborator(user)

Check if a user is a collaborator in this repo.

Variables:user (str) – The username to check. Returns:bool

RepoCollaborators.remove(user)

Remove a collaborator from this repo.

Variables:user (str) – The username of the collaborator.

RepoCommit

OrganizationRepo.commit(sha)

Return a resource corresponding to a single commit in this repo.

RepoCommitsComments

RepoCommit.comments()

Return a resource corresponding to all comments of this commit.

RepoCommitsComments.create(comment)

Create a comment on this commit.

Variables:comment (str) – The comment body.

RepoCommitsComments.delete()

Delete this resource.

RepoCommitsComments.get(format=None, page=None, per_page=None)

Fetch all comments for this commit.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommit.get()

Fetch all commits from this repo.

RepoCommits

OrganizationRepo.commits()

Return a resource corresponding to all commits in this repo.

RepoCommitsComment

RepoCommits.comment(comment_id)

Return the resource corresponding to a single comment of this commit.

RepoCommitsComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommitsComment.delete()

Delete this resource.

RepoCommitsComment.get(format=None)

Fetch the comment.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommitsComments

RepoCommits.comments()

Return the resource corresponding to all comments of this commit.

RepoCommitsComments.create(comment)

Create a comment on this commit.

Variables:comment (str) – The comment body.

RepoCommitsComments.delete()

Delete this resource.

RepoCommitsComments.get(format=None, page=None, per_page=None)

Fetch all comments for this commit.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommits.compare(base, head)

Fetch the comparison of two commits.

Variables:

• base (str) – The commit hash of the first commit.
• head (str) – The commit hash of the second commit.

RepoCommits.get(sha=None, path=None, page=None, per_page=None)

Fetch commits for this repo.

Variables:

• sha (str) – Optional commit hash or branch to start listing commits from.
• path (str) – Optional filter to only include commits that include this file path.

RepoContents

OrganizationRepo.contents()

Return a resource corresponding to repo contents.

RepoContents.archivelink(archive_format, ref=None)

This method will return a URL to download a tarball or zipball archive for a repository.

Variables:

• archive_format – Either tarball or zipball.
• ref – Optional string name of the commit/branch/tag. Defaults to master.

RepoContents.get(path=None, ref=None)

This method returns the contents of any file or directory in a repository.

Variables:

• path (str) – Optional content path.
• ref (str) – Optional string name of the commit/branch/tag. Defaults to master.

RepoContents.readme(ref=None)

This method returns the preferred README for a repository.

Variables:ref (str) – Optional string name of the commit/branch/tag. Defaults to master.

Download

OrganizationRepo.download(download_id)

Return a resource corresponding to a single download in this repo.

Download.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Download.delete()

Delete this resource.

Download.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Downloads

OrganizationRepo.downloads()

Return a resource corresponding to all downloads from this repo.

Downloads.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Downloads.delete()

Delete this resource.

Downloads.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Forks

OrganizationRepo.forks()

Return a resource corresponding to all forks of this repo.

Forks.create()

Fork this repo.

Forks.get(sort='newest', page=None, per_page=None)

Fetch this repo’s forks.

Variables:

• sort (str) – The sort order for the result.
• page (int) – The starting page of the result. If left as None, the first page is returned.
• per_page (int) – The amount of results per page.

RepoHook

OrganizationRepo.hook(hook_id)

Return a resource corresponding to a single hook in this repo.

RepoHook.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHook.delete()

Delete this resource.

RepoHook.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoHook.ping()

Send a ping event to the hook.

RepoHook.test()

Trigger the hook with the latest push to the repository.

RepoHook.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHooks

OrganizationRepo.hooks()

Return a resource corresponding to all hooks of this repo.

RepoHooks.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHooks.delete()

Delete this resource.

RepoHooks.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoHooks.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue

OrganizationRepo.issue(issue_id)

Return a resource corresponding to a single issue from this repo.

IssueComments

RepoIssue.comments()

Return the resource corresponding to the comments of this issue.

When creating comments, use a simple string as the parameter to create, you don’t have to use {“body”: <comment body>}.

IssueComments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComments.delete()

Delete this resource.

IssueComments.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueEvent

RepoIssue.event(event_id)

Return the resource corresponding to a single event of this issue.

IssueEvent.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueEvents

RepoIssue.events()

Return the resource corresponding to all the events of this issue.

IssueEvents.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabel

RepoIssue.label(name)

Return the resource corresponding to a single label of this issue.

IssueLabel.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabel.delete()

Delete this resource.

IssueLabel.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabel.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabels

RepoIssue.labels()

Return the resource corresponding to all labels of this issue.

IssueLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabels.delete()

Delete all labels from this issue.

IssueLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabels.replace(labels)

Replace all labels on this issue with new ones.

Variables:labels (list of str) – A list of labels to use.

IssueLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.delete()

Delete this resource.

RepoIssue.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoIssue.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues

OrganizationRepo.issues()

Return a resource corresponding to all issues from this repo.

IssueComment

RepoIssues.comment(comment_id)

Return the resource corresponding to a single comment of an issue.

When updating comments, use a simple string as the parameter to update, you don’t have to use {“body”: <comment body>}.

IssueComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComment.delete()

Delete this resource.

IssueComment.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueEvents

RepoIssues.events()

Return the resource corresponding to all events of this repo’s issues.

IssueEvents.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoIssues.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues.delete()

Delete this resource.

RepoIssues.get(milestone=None, state='open', assignee=None, mentioned=None, labels=None, sort='created', direction='desc', since=None, page=None, per_page=None)

Fetch issues for this repository based on the filter parameters and using the specified format.

For details on the meanings and allowed values for each parameter, see http://developer.github.com/v3/issues/#list-issues-for-a-repository

RepoIssues.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKey

OrganizationRepo.key(key_id)

Return a resource corresponding to a single key in this repo.

RepoKey.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKey.delete()

Delete this resource.

RepoKey.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoKey.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKeys

OrganizationRepo.keys()

Return a resource corresponding to all SSH keys of this repo.

RepoKeys.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKeys.delete()

Delete this resource.

RepoKeys.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoKeys.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabel

OrganizationRepo.label(name)

Return a resource corresponding to a single label from this repo.

RepoLabel.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabel.delete()

Delete this resource.

RepoLabel.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoLabel.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabels

OrganizationRepo.labels()

Return a resource corresponding to all issues from this repo.

RepoLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabels.delete()

Delete this resource.

RepoLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone

OrganizationRepo.milestone(milestone_id)

Return a resource corresponding to a single milestone in this repo.

MilestoneLabels

Milestone.labels()

Return the resource corresponding to the labels of this milestone.

MilestoneLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

MilestoneLabels.delete()

Delete this resource.

MilestoneLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

MilestoneLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone.delete()

Delete this resource.

Milestone.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Milestone.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestones

OrganizationRepo.milestones()

Return a resource corresponding to all milestones in this repo.

Milestones.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestones.delete()

Delete this resource.

Milestones.get(state='open', sort='due_date', direction='desc', page=None, per_page=None)

Fetch milestones for this repository, based on the filter parameters.

For details on the meanings and allowed values for each parameter, see http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository.

Milestones.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequest

OrganizationRepo.pullrequest(number)

Return a resource corresponding to a single pull request for this repo.

PullRequest.commits()

Fetch commits on this pull request.

PullRequest.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequest.delete()

Delete this resource.

PullRequest.files()

Fetch files on this pull request.

PullRequest.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

PullRequest.is_merged()

Check if this pull request has been merged.

PullRequest.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequests

OrganizationRepo.pullrequests()

Return a resource corresponding to all the pull requests for this repo.

PullRequests.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequests.delete()

Delete this resource.

PullRequests.get(state=None, page=None, per_page=None)

Fetch pull requests.

Variables:state – Optional filter pull requests by state state: open or closed (default is open)

PullRequests.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Release

OrganizationRepo.release(release_id)

Return a resource corresponding to a single release in this repo.

ReleaseAsset

Release.asset(asset_id)

ReleaseAsset.delete()

Delete this resource.

ReleaseAsset.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

ReleaseAsset.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReleaseAssets

Release.assets()

ReleaseAssets.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Release.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Release.delete()

Delete this resource.

Release.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Release.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Releases

OrganizationRepo.releases()

Return a resource corresponding to all releases from this repo.

Releases.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Releases.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

OrganizationRepo.branches()

Fetch the branches for this repo.

OrganizationRepo.contributors(anon=False)

Fetch the contributors from this repo.

Variables:anon (bool) – Include anonymous contributors.

OrganizationRepo.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

OrganizationRepo.delete()

Delete this resource.

OrganizationRepo.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

OrganizationRepo.languages()

Fetch the languages for this repo.

OrganizationRepo.tags()

Fetch the tags for this repo.

OrganizationRepo.teams()

Fetch the teams for this repo.

OrganizationRepo.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Repo

Organizations.repos()

Return a resource corresponding to repos for this org.

RepoCollaborators

Repo.collaborators()

Return a resource corresponding to all collaborators in this repo.

RepoCollaborators.add(user)

Add a collaborator to this repo.

Variables:user (str) – The username of the new collaborator.

RepoCollaborators.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoCollaborators.is_collaborator(user)

Check if a user is a collaborator in this repo.

Variables:user (str) – The username to check. Returns:bool

RepoCollaborators.remove(user)

Remove a collaborator from this repo.

Variables:user (str) – The username of the collaborator.

RepoCommit

Repo.commit(sha)

Return a resource corresponding to a single commit in this repo.

RepoCommitsComments

RepoCommit.comments()

Return a resource corresponding to all comments of this commit.

RepoCommitsComments.create(comment)

Create a comment on this commit.

Variables:comment (str) – The comment body.

RepoCommitsComments.delete()

Delete this resource.

RepoCommitsComments.get(format=None, page=None, per_page=None)

Fetch all comments for this commit.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommit.get()

Fetch all commits from this repo.

RepoCommits

Repo.commits()

Return a resource corresponding to all commits in this repo.

RepoCommitsComment

RepoCommits.comment(comment_id)

Return the resource corresponding to a single comment of this commit.

RepoCommitsComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommitsComment.delete()

Delete this resource.

RepoCommitsComment.get(format=None)

Fetch the comment.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommitsComments

RepoCommits.comments()

Return the resource corresponding to all comments of this commit.

RepoCommitsComments.create(comment)

Create a comment on this commit.

Variables:comment (str) – The comment body.

RepoCommitsComments.delete()

Delete this resource.

RepoCommitsComments.get(format=None, page=None, per_page=None)

Fetch all comments for this commit.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommits.compare(base, head)

Fetch the comparison of two commits.

Variables:

• base (str) – The commit hash of the first commit.
• head (str) – The commit hash of the second commit.

RepoCommits.get(sha=None, path=None, page=None, per_page=None)

Fetch commits for this repo.

Variables:

• sha (str) – Optional commit hash or branch to start listing commits from.
• path (str) – Optional filter to only include commits that include this file path.

RepoContents

Repo.contents()

Return a resource corresponding to repo contents.

RepoContents.archivelink(archive_format, ref=None)

This method will return a URL to download a tarball or zipball archive for a repository.

Variables:

• archive_format – Either tarball or zipball.
• ref – Optional string name of the commit/branch/tag. Defaults to master.

RepoContents.get(path=None, ref=None)

This method returns the contents of any file or directory in a repository.

Variables:

• path (str) – Optional content path.
• ref (str) – Optional string name of the commit/branch/tag. Defaults to master.

RepoContents.readme(ref=None)

This method returns the preferred README for a repository.

Variables:ref (str) – Optional string name of the commit/branch/tag. Defaults to master.

Download

Repo.download(download_id)

Return a resource corresponding to a single download in this repo.

Download.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Download.delete()

Delete this resource.

Download.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Downloads

Repo.downloads()

Return a resource corresponding to all downloads from this repo.

Downloads.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Downloads.delete()

Delete this resource.

Downloads.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Forks

Repo.forks()

Return a resource corresponding to all forks of this repo.

Forks.create()

Fork this repo.

Forks.get(sort='newest', page=None, per_page=None)

Fetch this repo’s forks.

Variables:

• sort (str) – The sort order for the result.
• page (int) – The starting page of the result. If left as None, the first page is returned.
• per_page (int) – The amount of results per page.

RepoHook

Repo.hook(hook_id)

Return a resource corresponding to a single hook in this repo.

RepoHook.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHook.delete()

Delete this resource.

RepoHook.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoHook.ping()

Send a ping event to the hook.

RepoHook.test()

Trigger the hook with the latest push to the repository.

RepoHook.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHooks

Repo.hooks()

Return a resource corresponding to all hooks of this repo.

RepoHooks.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHooks.delete()

Delete this resource.

RepoHooks.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoHooks.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue

Repo.issue(issue_id)

Return a resource corresponding to a single issue from this repo.

IssueComments

RepoIssue.comments()

Return the resource corresponding to the comments of this issue.

When creating comments, use a simple string as the parameter to create, you don’t have to use {“body”: <comment body>}.

IssueComments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComments.delete()

Delete this resource.

IssueComments.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueEvent

RepoIssue.event(event_id)

Return the resource corresponding to a single event of this issue.

IssueEvent.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueEvents

RepoIssue.events()

Return the resource corresponding to all the events of this issue.

IssueEvents.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabel

RepoIssue.label(name)

Return the resource corresponding to a single label of this issue.

IssueLabel.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabel.delete()

Delete this resource.

IssueLabel.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabel.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabels

RepoIssue.labels()

Return the resource corresponding to all labels of this issue.

IssueLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabels.delete()

Delete all labels from this issue.

IssueLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabels.replace(labels)

Replace all labels on this issue with new ones.

Variables:labels (list of str) – A list of labels to use.

IssueLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.delete()

Delete this resource.

RepoIssue.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoIssue.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues

Repo.issues()

Return a resource corresponding to all issues from this repo.

IssueComment

RepoIssues.comment(comment_id)

Return the resource corresponding to a single comment of an issue.

When updating comments, use a simple string as the parameter to update, you don’t have to use {“body”: <comment body>}.

IssueComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComment.delete()

Delete this resource.

IssueComment.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueEvents

RepoIssues.events()

Return the resource corresponding to all events of this repo’s issues.

IssueEvents.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoIssues.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues.delete()

Delete this resource.

RepoIssues.get(milestone=None, state='open', assignee=None, mentioned=None, labels=None, sort='created', direction='desc', since=None, page=None, per_page=None)

Fetch issues for this repository based on the filter parameters and using the specified format.

For details on the meanings and allowed values for each parameter, see http://developer.github.com/v3/issues/#list-issues-for-a-repository

RepoIssues.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKey

Repo.key(key_id)

Return a resource corresponding to a single key in this repo.

RepoKey.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKey.delete()

Delete this resource.

RepoKey.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoKey.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKeys

Repo.keys()

Return a resource corresponding to all SSH keys of this repo.

RepoKeys.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKeys.delete()

Delete this resource.

RepoKeys.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoKeys.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabel

Repo.label(name)

Return a resource corresponding to a single label from this repo.

RepoLabel.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabel.delete()

Delete this resource.

RepoLabel.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoLabel.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabels

Repo.labels()

Return a resource corresponding to all issues from this repo.

RepoLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabels.delete()

Delete this resource.

RepoLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone

Repo.milestone(milestone_id)

Return a resource corresponding to a single milestone in this repo.

MilestoneLabels

Milestone.labels()

Return the resource corresponding to the labels of this milestone.

MilestoneLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

MilestoneLabels.delete()

Delete this resource.

MilestoneLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

MilestoneLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone.delete()

Delete this resource.

Milestone.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Milestone.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestones

Repo.milestones()

Return a resource corresponding to all milestones in this repo.

Milestones.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestones.delete()

Delete this resource.

Milestones.get(state='open', sort='due_date', direction='desc', page=None, per_page=None)

Fetch milestones for this repository, based on the filter parameters.

For details on the meanings and allowed values for each parameter, see http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository.

Milestones.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequest

Repo.pullrequest(number)

Return a resource corresponding to a single pull request for this repo.

PullRequest.commits()

Fetch commits on this pull request.

PullRequest.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequest.delete()

Delete this resource.

PullRequest.files()

Fetch files on this pull request.

PullRequest.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

PullRequest.is_merged()

Check if this pull request has been merged.

PullRequest.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequests

Repo.pullrequests()

Return a resource corresponding to all the pull requests for this repo.

PullRequests.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequests.delete()

Delete this resource.

PullRequests.get(state=None, page=None, per_page=None)

Fetch pull requests.

Variables:state – Optional filter pull requests by state state: open or closed (default is open)

PullRequests.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Release

Repo.release(release_id)

Return a resource corresponding to a single release in this repo.

ReleaseAsset

Release.asset(asset_id)

ReleaseAsset.delete()

Delete this resource.

ReleaseAsset.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

ReleaseAsset.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReleaseAssets

Release.assets()

ReleaseAssets.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Release.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Release.delete()

Delete this resource.

Release.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Release.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Releases

Repo.releases()

Return a resource corresponding to all releases from this repo.

Releases.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Releases.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Repo.branches()

Fetch the branches for this repo.

Repo.contributors(anon=False)

Fetch the contributors from this repo.

Variables:anon (bool) – Include anonymous contributors.

Repo.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Repo.delete()

Delete this resource.

Repo.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Repo.languages()

Fetch the languages for this repo.

Repo.tags()

Fetch the tags for this repo.

Repo.teams()

Fetch the teams for this repo.

Repo.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Teams

Organizations.teams()

Return a resource corresponding to this org’s teams.

Teams.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Teams.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Organizations.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Organizations.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Repo

GitHub.repo(user, repo)

Return the resource corresponding to a single repo.

RepoCollaborators

Repo.collaborators()

Return a resource corresponding to all collaborators in this repo.

RepoCollaborators.add(user)

Add a collaborator to this repo.

Variables:user (str) – The username of the new collaborator.

RepoCollaborators.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoCollaborators.is_collaborator(user)

Check if a user is a collaborator in this repo.

Variables:user (str) – The username to check. Returns:bool

RepoCollaborators.remove(user)

Remove a collaborator from this repo.

Variables:user (str) – The username of the collaborator.

RepoCommit

Repo.commit(sha)

Return a resource corresponding to a single commit in this repo.

RepoCommitsComments

RepoCommit.comments()

Return a resource corresponding to all comments of this commit.

RepoCommitsComments.create(comment)

Create a comment on this commit.

Variables:comment (str) – The comment body.

RepoCommitsComments.delete()

Delete this resource.

RepoCommitsComments.get(format=None, page=None, per_page=None)

Fetch all comments for this commit.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommit.get()

Fetch all commits from this repo.

RepoCommits

Repo.commits()

Return a resource corresponding to all commits in this repo.

RepoCommitsComment

RepoCommits.comment(comment_id)

Return the resource corresponding to a single comment of this commit.

RepoCommitsComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommitsComment.delete()

Delete this resource.

RepoCommitsComment.get(format=None)

Fetch the comment.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommitsComments

RepoCommits.comments()

Return the resource corresponding to all comments of this commit.

RepoCommitsComments.create(comment)

Create a comment on this commit.

Variables:comment (str) – The comment body.

RepoCommitsComments.delete()

Delete this resource.

RepoCommitsComments.get(format=None, page=None, per_page=None)

Fetch all comments for this commit.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommits.compare(base, head)

Fetch the comparison of two commits.

Variables:

• base (str) – The commit hash of the first commit.
• head (str) – The commit hash of the second commit.

RepoCommits.get(sha=None, path=None, page=None, per_page=None)

Fetch commits for this repo.

Variables:

• sha (str) – Optional commit hash or branch to start listing commits from.
• path (str) – Optional filter to only include commits that include this file path.

RepoContents

Repo.contents()

Return a resource corresponding to repo contents.

RepoContents.archivelink(archive_format, ref=None)

This method will return a URL to download a tarball or zipball archive for a repository.

Variables:

• archive_format – Either tarball or zipball.
• ref – Optional string name of the commit/branch/tag. Defaults to master.

RepoContents.get(path=None, ref=None)

This method returns the contents of any file or directory in a repository.

Variables:

• path (str) – Optional content path.
• ref (str) – Optional string name of the commit/branch/tag. Defaults to master.

RepoContents.readme(ref=None)

This method returns the preferred README for a repository.

Variables:ref (str) – Optional string name of the commit/branch/tag. Defaults to master.

Download

Repo.download(download_id)

Return a resource corresponding to a single download in this repo.

Download.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Download.delete()

Delete this resource.

Download.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Downloads

Repo.downloads()

Return a resource corresponding to all downloads from this repo.

Downloads.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Downloads.delete()

Delete this resource.

Downloads.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Forks

Repo.forks()

Return a resource corresponding to all forks of this repo.

Forks.create()

Fork this repo.

Forks.get(sort='newest', page=None, per_page=None)

Fetch this repo’s forks.

Variables:

• sort (str) – The sort order for the result.
• page (int) – The starting page of the result. If left as None, the first page is returned.
• per_page (int) – The amount of results per page.

RepoHook

Repo.hook(hook_id)

Return a resource corresponding to a single hook in this repo.

RepoHook.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHook.delete()

Delete this resource.

RepoHook.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoHook.ping()

Send a ping event to the hook.

RepoHook.test()

Trigger the hook with the latest push to the repository.

RepoHook.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHooks

Repo.hooks()

Return a resource corresponding to all hooks of this repo.

RepoHooks.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHooks.delete()

Delete this resource.

RepoHooks.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoHooks.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue

Repo.issue(issue_id)

Return a resource corresponding to a single issue from this repo.

IssueComments

RepoIssue.comments()

Return the resource corresponding to the comments of this issue.

When creating comments, use a simple string as the parameter to create, you don’t have to use {“body”: <comment body>}.

IssueComments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComments.delete()

Delete this resource.

IssueComments.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueEvent

RepoIssue.event(event_id)

Return the resource corresponding to a single event of this issue.

IssueEvent.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueEvents

RepoIssue.events()

Return the resource corresponding to all the events of this issue.

IssueEvents.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabel

RepoIssue.label(name)

Return the resource corresponding to a single label of this issue.

IssueLabel.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabel.delete()

Delete this resource.

IssueLabel.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabel.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabels

RepoIssue.labels()

Return the resource corresponding to all labels of this issue.

IssueLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabels.delete()

Delete all labels from this issue.

IssueLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabels.replace(labels)

Replace all labels on this issue with new ones.

Variables:labels (list of str) – A list of labels to use.

IssueLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.delete()

Delete this resource.

RepoIssue.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoIssue.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues

Repo.issues()

Return a resource corresponding to all issues from this repo.

IssueComment

RepoIssues.comment(comment_id)

Return the resource corresponding to a single comment of an issue.

When updating comments, use a simple string as the parameter to update, you don’t have to use {“body”: <comment body>}.

IssueComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComment.delete()

Delete this resource.

IssueComment.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueEvents

RepoIssues.events()

Return the resource corresponding to all events of this repo’s issues.

IssueEvents.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoIssues.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues.delete()

Delete this resource.

RepoIssues.get(milestone=None, state='open', assignee=None, mentioned=None, labels=None, sort='created', direction='desc', since=None, page=None, per_page=None)

Fetch issues for this repository based on the filter parameters and using the specified format.

For details on the meanings and allowed values for each parameter, see http://developer.github.com/v3/issues/#list-issues-for-a-repository

RepoIssues.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKey

Repo.key(key_id)

Return a resource corresponding to a single key in this repo.

RepoKey.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKey.delete()

Delete this resource.

RepoKey.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoKey.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKeys

Repo.keys()

Return a resource corresponding to all SSH keys of this repo.

RepoKeys.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKeys.delete()

Delete this resource.

RepoKeys.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoKeys.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabel

Repo.label(name)

Return a resource corresponding to a single label from this repo.

RepoLabel.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabel.delete()

Delete this resource.

RepoLabel.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoLabel.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabels

Repo.labels()

Return a resource corresponding to all issues from this repo.

RepoLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabels.delete()

Delete this resource.

RepoLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone

Repo.milestone(milestone_id)

Return a resource corresponding to a single milestone in this repo.

MilestoneLabels

Milestone.labels()

Return the resource corresponding to the labels of this milestone.

MilestoneLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

MilestoneLabels.delete()

Delete this resource.

MilestoneLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

MilestoneLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone.delete()

Delete this resource.

Milestone.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Milestone.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestones

Repo.milestones()

Return a resource corresponding to all milestones in this repo.

Milestones.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestones.delete()

Delete this resource.

Milestones.get(state='open', sort='due_date', direction='desc', page=None, per_page=None)

Fetch milestones for this repository, based on the filter parameters.

For details on the meanings and allowed values for each parameter, see http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository.

Milestones.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequest

Repo.pullrequest(number)

Return a resource corresponding to a single pull request for this repo.

PullRequest.commits()

Fetch commits on this pull request.

PullRequest.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequest.delete()

Delete this resource.

PullRequest.files()

Fetch files on this pull request.

PullRequest.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

PullRequest.is_merged()

Check if this pull request has been merged.

PullRequest.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequests

Repo.pullrequests()

Return a resource corresponding to all the pull requests for this repo.

PullRequests.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequests.delete()

Delete this resource.

PullRequests.get(state=None, page=None, per_page=None)

Fetch pull requests.

Variables:state – Optional filter pull requests by state state: open or closed (default is open)

PullRequests.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Release

Repo.release(release_id)

Return a resource corresponding to a single release in this repo.

ReleaseAsset

Release.asset(asset_id)

ReleaseAsset.delete()

Delete this resource.

ReleaseAsset.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

ReleaseAsset.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReleaseAssets

Release.assets()

ReleaseAssets.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Release.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Release.delete()

Delete this resource.

Release.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Release.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Releases

Repo.releases()

Return a resource corresponding to all releases from this repo.

Releases.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Releases.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Repo.branches()

Fetch the branches for this repo.

Repo.contributors(anon=False)

Fetch the contributors from this repo.

Variables:anon (bool) – Include anonymous contributors.

Repo.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Repo.delete()

Delete this resource.

Repo.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Repo.languages()

Fetch the languages for this repo.

Repo.tags()

Fetch the tags for this repo.

Repo.teams()

Fetch the teams for this repo.

Repo.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Repos

GitHub.repos()

Return the resource corresponding to all the repos.

Repos.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Repos.delete()

Delete this resource.

Repos.get(type='all', page=None, per_page=None)

Fetch repos for this user.

Variables:type – What type of repos to fetch. For details of allowed values, see http://developer.github.com/v3/repos/#list-user-repositories.

Repos.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Team

GitHub.team(team)

Return the resource corresponding to a single team.

TeamMembership

Team.member(user)

Return a resource corresponding to a single member of a team.

TeamMembership.add()

TeamMembership.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

TeamMembership.delete()

Delete this resource.

TeamMembership.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

TeamMembership.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Members

Team.members()

Return a resource corresponding to a team’s members.

Members.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

TeamRepo

Team.repo(user, repo)

Return a resource corresponding to a single repo to determine if it is managed by this team.

RepoCollaborators

TeamRepo.collaborators()

Return a resource corresponding to all collaborators in this repo.

RepoCollaborators.add(user)

Add a collaborator to this repo.

Variables:user (str) – The username of the new collaborator.

RepoCollaborators.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoCollaborators.is_collaborator(user)

Check if a user is a collaborator in this repo.

Variables:user (str) – The username to check. Returns:bool

RepoCollaborators.remove(user)

Remove a collaborator from this repo.

Variables:user (str) – The username of the collaborator.

RepoCommit

TeamRepo.commit(sha)

Return a resource corresponding to a single commit in this repo.

RepoCommitsComments

RepoCommit.comments()

Return a resource corresponding to all comments of this commit.

RepoCommitsComments.create(comment)

Create a comment on this commit.

Variables:comment (str) – The comment body.

RepoCommitsComments.delete()

Delete this resource.

RepoCommitsComments.get(format=None, page=None, per_page=None)

Fetch all comments for this commit.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommit.get()

Fetch all commits from this repo.

RepoCommits

TeamRepo.commits()

Return a resource corresponding to all commits in this repo.

RepoCommitsComment

RepoCommits.comment(comment_id)

Return the resource corresponding to a single comment of this commit.

RepoCommitsComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommitsComment.delete()

Delete this resource.

RepoCommitsComment.get(format=None)

Fetch the comment.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommitsComments

RepoCommits.comments()

Return the resource corresponding to all comments of this commit.

RepoCommitsComments.create(comment)

Create a comment on this commit.

Variables:comment (str) – The comment body.

RepoCommitsComments.delete()

Delete this resource.

RepoCommitsComments.get(format=None, page=None, per_page=None)

Fetch all comments for this commit.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommits.compare(base, head)

Fetch the comparison of two commits.

Variables:

• base (str) – The commit hash of the first commit.
• head (str) – The commit hash of the second commit.

RepoCommits.get(sha=None, path=None, page=None, per_page=None)

Fetch commits for this repo.

Variables:

• sha (str) – Optional commit hash or branch to start listing commits from.
• path (str) – Optional filter to only include commits that include this file path.

RepoContents

TeamRepo.contents()

Return a resource corresponding to repo contents.

RepoContents.archivelink(archive_format, ref=None)

This method will return a URL to download a tarball or zipball archive for a repository.

Variables:

• archive_format – Either tarball or zipball.
• ref – Optional string name of the commit/branch/tag. Defaults to master.

RepoContents.get(path=None, ref=None)

This method returns the contents of any file or directory in a repository.

Variables:

• path (str) – Optional content path.
• ref (str) – Optional string name of the commit/branch/tag. Defaults to master.

RepoContents.readme(ref=None)

This method returns the preferred README for a repository.

Variables:ref (str) – Optional string name of the commit/branch/tag. Defaults to master.

Download

TeamRepo.download(download_id)

Return a resource corresponding to a single download in this repo.

Download.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Download.delete()

Delete this resource.

Download.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Downloads

TeamRepo.downloads()

Return a resource corresponding to all downloads from this repo.

Downloads.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Downloads.delete()

Delete this resource.

Downloads.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Forks

TeamRepo.forks()

Return a resource corresponding to all forks of this repo.

Forks.create()

Fork this repo.

Forks.get(sort='newest', page=None, per_page=None)

Fetch this repo’s forks.

Variables:

• sort (str) – The sort order for the result.
• page (int) – The starting page of the result. If left as None, the first page is returned.
• per_page (int) – The amount of results per page.

RepoHook

TeamRepo.hook(hook_id)

Return a resource corresponding to a single hook in this repo.

RepoHook.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHook.delete()

Delete this resource.

RepoHook.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoHook.ping()

Send a ping event to the hook.

RepoHook.test()

Trigger the hook with the latest push to the repository.

RepoHook.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHooks

TeamRepo.hooks()

Return a resource corresponding to all hooks of this repo.

RepoHooks.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHooks.delete()

Delete this resource.

RepoHooks.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoHooks.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue

TeamRepo.issue(issue_id)

Return a resource corresponding to a single issue from this repo.

IssueComments

RepoIssue.comments()

Return the resource corresponding to the comments of this issue.

When creating comments, use a simple string as the parameter to create, you don’t have to use {“body”: <comment body>}.

IssueComments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComments.delete()

Delete this resource.

IssueComments.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueEvent

RepoIssue.event(event_id)

Return the resource corresponding to a single event of this issue.

IssueEvent.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueEvents

RepoIssue.events()

Return the resource corresponding to all the events of this issue.

IssueEvents.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabel

RepoIssue.label(name)

Return the resource corresponding to a single label of this issue.

IssueLabel.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabel.delete()

Delete this resource.

IssueLabel.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabel.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabels

RepoIssue.labels()

Return the resource corresponding to all labels of this issue.

IssueLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabels.delete()

Delete all labels from this issue.

IssueLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabels.replace(labels)

Replace all labels on this issue with new ones.

Variables:labels (list of str) – A list of labels to use.

IssueLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.delete()

Delete this resource.

RepoIssue.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoIssue.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues

TeamRepo.issues()

Return a resource corresponding to all issues from this repo.

IssueComment

RepoIssues.comment(comment_id)

Return the resource corresponding to a single comment of an issue.

When updating comments, use a simple string as the parameter to update, you don’t have to use {“body”: <comment body>}.

IssueComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComment.delete()

Delete this resource.

IssueComment.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueEvents

RepoIssues.events()

Return the resource corresponding to all events of this repo’s issues.

IssueEvents.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoIssues.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues.delete()

Delete this resource.

RepoIssues.get(milestone=None, state='open', assignee=None, mentioned=None, labels=None, sort='created', direction='desc', since=None, page=None, per_page=None)

Fetch issues for this repository based on the filter parameters and using the specified format.

For details on the meanings and allowed values for each parameter, see http://developer.github.com/v3/issues/#list-issues-for-a-repository

RepoIssues.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKey

TeamRepo.key(key_id)

Return a resource corresponding to a single key in this repo.

RepoKey.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKey.delete()

Delete this resource.

RepoKey.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoKey.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKeys

TeamRepo.keys()

Return a resource corresponding to all SSH keys of this repo.

RepoKeys.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKeys.delete()

Delete this resource.

RepoKeys.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoKeys.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabel

TeamRepo.label(name)

Return a resource corresponding to a single label from this repo.

RepoLabel.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabel.delete()

Delete this resource.

RepoLabel.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoLabel.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabels

TeamRepo.labels()

Return a resource corresponding to all issues from this repo.

RepoLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabels.delete()

Delete this resource.

RepoLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone

TeamRepo.milestone(milestone_id)

Return a resource corresponding to a single milestone in this repo.

MilestoneLabels

Milestone.labels()

Return the resource corresponding to the labels of this milestone.

MilestoneLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

MilestoneLabels.delete()

Delete this resource.

MilestoneLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

MilestoneLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone.delete()

Delete this resource.

Milestone.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Milestone.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestones

TeamRepo.milestones()

Return a resource corresponding to all milestones in this repo.

Milestones.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestones.delete()

Delete this resource.

Milestones.get(state='open', sort='due_date', direction='desc', page=None, per_page=None)

Fetch milestones for this repository, based on the filter parameters.

For details on the meanings and allowed values for each parameter, see http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository.

Milestones.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequest

TeamRepo.pullrequest(number)

Return a resource corresponding to a single pull request for this repo.

PullRequest.commits()

Fetch commits on this pull request.

PullRequest.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequest.delete()

Delete this resource.

PullRequest.files()

Fetch files on this pull request.

PullRequest.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

PullRequest.is_merged()

Check if this pull request has been merged.

PullRequest.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequests

TeamRepo.pullrequests()

Return a resource corresponding to all the pull requests for this repo.

PullRequests.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequests.delete()

Delete this resource.

PullRequests.get(state=None, page=None, per_page=None)

Fetch pull requests.

Variables:state – Optional filter pull requests by state state: open or closed (default is open)

PullRequests.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Release

TeamRepo.release(release_id)

Return a resource corresponding to a single release in this repo.

ReleaseAsset

Release.asset(asset_id)

ReleaseAsset.delete()

Delete this resource.

ReleaseAsset.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

ReleaseAsset.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReleaseAssets

Release.assets()

ReleaseAssets.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Release.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Release.delete()

Delete this resource.

Release.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Release.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Releases

TeamRepo.releases()

Return a resource corresponding to all releases from this repo.

Releases.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Releases.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

TeamRepo.add()

TeamRepo.branches()

Fetch the branches for this repo.

TeamRepo.contributors(anon=False)

Fetch the contributors from this repo.

Variables:anon (bool) – Include anonymous contributors.

TeamRepo.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

TeamRepo.delete()

Delete this resource.

TeamRepo.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

TeamRepo.languages()

Fetch the languages for this repo.

TeamRepo.tags()

Fetch the tags for this repo.

TeamRepo.teams()

Fetch the teams for this repo.

TeamRepo.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

TeamRepos

Team.repos()

Return a resource corresponding to the repos manged by this team.

TeamRepos.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

TeamRepos.delete()

Delete this resource.

TeamRepos.get(type='all', page=None, per_page=None)

Fetch repos for this user.

Variables:type – What type of repos to fetch. For details of allowed values, see http://developer.github.com/v3/repos/#list-user-repositories.

TeamRepos.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Team.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Team.delete()

Delete this resource.

Team.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Team.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

User, CurrentUser

GitHub.user(name=None)

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

Organizations

User.orgs()

Return a resource corresponding to user’s organizations.

Member

Organizations.member(user)

Return a resource corresponding to a member of this org.

Member.delete()

Delete this resource.

Member.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Members

Organizations.members()

Return a resource corresponding to members of this org.

Members.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

PublicMember

Organizations.public_member(user)

Return a resource corresponding to a public member of this org.

PublicMember.delete()

Delete this resource.

PublicMember.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

PublicMember.publicize()

PublicMembers

Organizations.public_members()

Return a resource corresponding to public members of this org.

PublicMembers.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

OrganizationRepo

Organizations.repo(repo)

Return a resource corresponding to single repo for this org.

RepoCollaborators

OrganizationRepo.collaborators()

Return a resource corresponding to all collaborators in this repo.

RepoCollaborators.add(user)

Add a collaborator to this repo.

Variables:user (str) – The username of the new collaborator.

RepoCollaborators.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoCollaborators.is_collaborator(user)

Check if a user is a collaborator in this repo.

Variables:user (str) – The username to check. Returns:bool

RepoCollaborators.remove(user)

Remove a collaborator from this repo.

Variables:user (str) – The username of the collaborator.

RepoCommit

OrganizationRepo.commit(sha)

Return a resource corresponding to a single commit in this repo.

RepoCommitsComments

RepoCommit.comments()

Return a resource corresponding to all comments of this commit.

RepoCommitsComments.create(comment)

Create a comment on this commit.

Variables:comment (str) – The comment body.

RepoCommitsComments.delete()

Delete this resource.

RepoCommitsComments.get(format=None, page=None, per_page=None)

Fetch all comments for this commit.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommit.get()

Fetch all commits from this repo.

RepoCommits

OrganizationRepo.commits()

Return a resource corresponding to all commits in this repo.

RepoCommitsComment

RepoCommits.comment(comment_id)

Return the resource corresponding to a single comment of this commit.

RepoCommitsComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommitsComment.delete()

Delete this resource.

RepoCommitsComment.get(format=None)

Fetch the comment.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommitsComments

RepoCommits.comments()

Return the resource corresponding to all comments of this commit.

RepoCommitsComments.create(comment)

Create a comment on this commit.

Variables:comment (str) – The comment body.

RepoCommitsComments.delete()

Delete this resource.

RepoCommitsComments.get(format=None, page=None, per_page=None)

Fetch all comments for this commit.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommits.compare(base, head)

Fetch the comparison of two commits.

Variables:

• base (str) – The commit hash of the first commit.
• head (str) – The commit hash of the second commit.

RepoCommits.get(sha=None, path=None, page=None, per_page=None)

Fetch commits for this repo.

Variables:

• sha (str) – Optional commit hash or branch to start listing commits from.
• path (str) – Optional filter to only include commits that include this file path.

RepoContents

OrganizationRepo.contents()

Return a resource corresponding to repo contents.

RepoContents.archivelink(archive_format, ref=None)

This method will return a URL to download a tarball or zipball archive for a repository.

Variables:

• archive_format – Either tarball or zipball.
• ref – Optional string name of the commit/branch/tag. Defaults to master.

RepoContents.get(path=None, ref=None)

This method returns the contents of any file or directory in a repository.

Variables:

• path (str) – Optional content path.
• ref (str) – Optional string name of the commit/branch/tag. Defaults to master.

RepoContents.readme(ref=None)

This method returns the preferred README for a repository.

Variables:ref (str) – Optional string name of the commit/branch/tag. Defaults to master.

Download

OrganizationRepo.download(download_id)

Return a resource corresponding to a single download in this repo.

Download.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Download.delete()

Delete this resource.

Download.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Downloads

OrganizationRepo.downloads()

Return a resource corresponding to all downloads from this repo.

Downloads.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Downloads.delete()

Delete this resource.

Downloads.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Forks

OrganizationRepo.forks()

Return a resource corresponding to all forks of this repo.

Forks.create()

Fork this repo.

Forks.get(sort='newest', page=None, per_page=None)

Fetch this repo’s forks.

Variables:

• sort (str) – The sort order for the result.
• page (int) – The starting page of the result. If left as None, the first page is returned.
• per_page (int) – The amount of results per page.

RepoHook

OrganizationRepo.hook(hook_id)

Return a resource corresponding to a single hook in this repo.

RepoHook.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHook.delete()

Delete this resource.

RepoHook.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoHook.ping()

Send a ping event to the hook.

RepoHook.test()

Trigger the hook with the latest push to the repository.

RepoHook.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHooks

OrganizationRepo.hooks()

Return a resource corresponding to all hooks of this repo.

RepoHooks.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHooks.delete()

Delete this resource.

RepoHooks.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoHooks.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue

OrganizationRepo.issue(issue_id)

Return a resource corresponding to a single issue from this repo.

IssueComments

RepoIssue.comments()

Return the resource corresponding to the comments of this issue.

When creating comments, use a simple string as the parameter to create, you don’t have to use {“body”: <comment body>}.

IssueComments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComments.delete()

Delete this resource.

IssueComments.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueEvent

RepoIssue.event(event_id)

Return the resource corresponding to a single event of this issue.

IssueEvent.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueEvents

RepoIssue.events()

Return the resource corresponding to all the events of this issue.

IssueEvents.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabel

RepoIssue.label(name)

Return the resource corresponding to a single label of this issue.

IssueLabel.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabel.delete()

Delete this resource.

IssueLabel.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabel.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabels

RepoIssue.labels()

Return the resource corresponding to all labels of this issue.

IssueLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabels.delete()

Delete all labels from this issue.

IssueLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabels.replace(labels)

Replace all labels on this issue with new ones.

Variables:labels (list of str) – A list of labels to use.

IssueLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.delete()

Delete this resource.

RepoIssue.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoIssue.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues

OrganizationRepo.issues()

Return a resource corresponding to all issues from this repo.

IssueComment

RepoIssues.comment(comment_id)

Return the resource corresponding to a single comment of an issue.

When updating comments, use a simple string as the parameter to update, you don’t have to use {“body”: <comment body>}.

IssueComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComment.delete()

Delete this resource.

IssueComment.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueEvents

RepoIssues.events()

Return the resource corresponding to all events of this repo’s issues.

IssueEvents.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoIssues.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues.delete()

Delete this resource.

RepoIssues.get(milestone=None, state='open', assignee=None, mentioned=None, labels=None, sort='created', direction='desc', since=None, page=None, per_page=None)

Fetch issues for this repository based on the filter parameters and using the specified format.

For details on the meanings and allowed values for each parameter, see http://developer.github.com/v3/issues/#list-issues-for-a-repository

RepoIssues.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKey

OrganizationRepo.key(key_id)

Return a resource corresponding to a single key in this repo.

RepoKey.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKey.delete()

Delete this resource.

RepoKey.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoKey.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKeys

OrganizationRepo.keys()

Return a resource corresponding to all SSH keys of this repo.

RepoKeys.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKeys.delete()

Delete this resource.

RepoKeys.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoKeys.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabel

OrganizationRepo.label(name)

Return a resource corresponding to a single label from this repo.

RepoLabel.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabel.delete()

Delete this resource.

RepoLabel.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoLabel.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabels

OrganizationRepo.labels()

Return a resource corresponding to all issues from this repo.

RepoLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabels.delete()

Delete this resource.

RepoLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone

OrganizationRepo.milestone(milestone_id)

Return a resource corresponding to a single milestone in this repo.

MilestoneLabels

Milestone.labels()

Return the resource corresponding to the labels of this milestone.

MilestoneLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

MilestoneLabels.delete()

Delete this resource.

MilestoneLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

MilestoneLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone.delete()

Delete this resource.

Milestone.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Milestone.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestones

OrganizationRepo.milestones()

Return a resource corresponding to all milestones in this repo.

Milestones.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestones.delete()

Delete this resource.

Milestones.get(state='open', sort='due_date', direction='desc', page=None, per_page=None)

Fetch milestones for this repository, based on the filter parameters.

For details on the meanings and allowed values for each parameter, see http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository.

Milestones.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequest

OrganizationRepo.pullrequest(number)

Return a resource corresponding to a single pull request for this repo.

PullRequest.commits()

Fetch commits on this pull request.

PullRequest.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequest.delete()

Delete this resource.

PullRequest.files()

Fetch files on this pull request.

PullRequest.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

PullRequest.is_merged()

Check if this pull request has been merged.

PullRequest.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequests

OrganizationRepo.pullrequests()

Return a resource corresponding to all the pull requests for this repo.

PullRequests.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequests.delete()

Delete this resource.

PullRequests.get(state=None, page=None, per_page=None)

Fetch pull requests.

Variables:state – Optional filter pull requests by state state: open or closed (default is open)

PullRequests.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Release

OrganizationRepo.release(release_id)

Return a resource corresponding to a single release in this repo.

ReleaseAsset

Release.asset(asset_id)

ReleaseAsset.delete()

Delete this resource.

ReleaseAsset.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

ReleaseAsset.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReleaseAssets

Release.assets()

ReleaseAssets.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Release.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Release.delete()

Delete this resource.

Release.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Release.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Releases

OrganizationRepo.releases()

Return a resource corresponding to all releases from this repo.

Releases.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Releases.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

OrganizationRepo.branches()

Fetch the branches for this repo.

OrganizationRepo.contributors(anon=False)

Fetch the contributors from this repo.

Variables:anon (bool) – Include anonymous contributors.

OrganizationRepo.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

OrganizationRepo.delete()

Delete this resource.

OrganizationRepo.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

OrganizationRepo.languages()

Fetch the languages for this repo.

OrganizationRepo.tags()

Fetch the tags for this repo.

OrganizationRepo.teams()

Fetch the teams for this repo.

OrganizationRepo.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Repo

Organizations.repos()

Return a resource corresponding to repos for this org.

RepoCollaborators

Repo.collaborators()

Return a resource corresponding to all collaborators in this repo.

RepoCollaborators.add(user)

Add a collaborator to this repo.

Variables:user (str) – The username of the new collaborator.

RepoCollaborators.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoCollaborators.is_collaborator(user)

Check if a user is a collaborator in this repo.

Variables:user (str) – The username to check. Returns:bool

RepoCollaborators.remove(user)

Remove a collaborator from this repo.

Variables:user (str) – The username of the collaborator.

RepoCommit

Repo.commit(sha)

Return a resource corresponding to a single commit in this repo.

RepoCommitsComments

RepoCommit.comments()

Return a resource corresponding to all comments of this commit.

RepoCommitsComments.create(comment)

Create a comment on this commit.

Variables:comment (str) – The comment body.

RepoCommitsComments.delete()

Delete this resource.

RepoCommitsComments.get(format=None, page=None, per_page=None)

Fetch all comments for this commit.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommit.get()

Fetch all commits from this repo.

RepoCommits

Repo.commits()

Return a resource corresponding to all commits in this repo.

RepoCommitsComment

RepoCommits.comment(comment_id)

Return the resource corresponding to a single comment of this commit.

RepoCommitsComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommitsComment.delete()

Delete this resource.

RepoCommitsComment.get(format=None)

Fetch the comment.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommitsComments

RepoCommits.comments()

Return the resource corresponding to all comments of this commit.

RepoCommitsComments.create(comment)

Create a comment on this commit.

Variables:comment (str) – The comment body.

RepoCommitsComments.delete()

Delete this resource.

RepoCommitsComments.get(format=None, page=None, per_page=None)

Fetch all comments for this commit.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommits.compare(base, head)

Fetch the comparison of two commits.

Variables:

• base (str) – The commit hash of the first commit.
• head (str) – The commit hash of the second commit.

RepoCommits.get(sha=None, path=None, page=None, per_page=None)

Fetch commits for this repo.

Variables:

• sha (str) – Optional commit hash or branch to start listing commits from.
• path (str) – Optional filter to only include commits that include this file path.

RepoContents

Repo.contents()

Return a resource corresponding to repo contents.

RepoContents.archivelink(archive_format, ref=None)

This method will return a URL to download a tarball or zipball archive for a repository.

Variables:

• archive_format – Either tarball or zipball.
• ref – Optional string name of the commit/branch/tag. Defaults to master.

RepoContents.get(path=None, ref=None)

This method returns the contents of any file or directory in a repository.

Variables:

• path (str) – Optional content path.
• ref (str) – Optional string name of the commit/branch/tag. Defaults to master.

RepoContents.readme(ref=None)

This method returns the preferred README for a repository.

Variables:ref (str) – Optional string name of the commit/branch/tag. Defaults to master.

Download

Repo.download(download_id)

Return a resource corresponding to a single download in this repo.

Download.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Download.delete()

Delete this resource.

Download.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Downloads

Repo.downloads()

Return a resource corresponding to all downloads from this repo.

Downloads.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Downloads.delete()

Delete this resource.

Downloads.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Forks

Repo.forks()

Return a resource corresponding to all forks of this repo.

Forks.create()

Fork this repo.

Forks.get(sort='newest', page=None, per_page=None)

Fetch this repo’s forks.

Variables:

• sort (str) – The sort order for the result.
• page (int) – The starting page of the result. If left as None, the first page is returned.
• per_page (int) – The amount of results per page.

RepoHook

Repo.hook(hook_id)

Return a resource corresponding to a single hook in this repo.

RepoHook.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHook.delete()

Delete this resource.

RepoHook.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoHook.ping()

Send a ping event to the hook.

RepoHook.test()

Trigger the hook with the latest push to the repository.

RepoHook.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHooks

Repo.hooks()

Return a resource corresponding to all hooks of this repo.

RepoHooks.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHooks.delete()

Delete this resource.

RepoHooks.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoHooks.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue

Repo.issue(issue_id)

Return a resource corresponding to a single issue from this repo.

IssueComments

RepoIssue.comments()

Return the resource corresponding to the comments of this issue.

When creating comments, use a simple string as the parameter to create, you don’t have to use {“body”: <comment body>}.

IssueComments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComments.delete()

Delete this resource.

IssueComments.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueEvent

RepoIssue.event(event_id)

Return the resource corresponding to a single event of this issue.

IssueEvent.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueEvents

RepoIssue.events()

Return the resource corresponding to all the events of this issue.

IssueEvents.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabel

RepoIssue.label(name)

Return the resource corresponding to a single label of this issue.

IssueLabel.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabel.delete()

Delete this resource.

IssueLabel.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabel.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabels

RepoIssue.labels()

Return the resource corresponding to all labels of this issue.

IssueLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabels.delete()

Delete all labels from this issue.

IssueLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabels.replace(labels)

Replace all labels on this issue with new ones.

Variables:labels (list of str) – A list of labels to use.

IssueLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.delete()

Delete this resource.

RepoIssue.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoIssue.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues

Repo.issues()

Return a resource corresponding to all issues from this repo.

IssueComment

RepoIssues.comment(comment_id)

Return the resource corresponding to a single comment of an issue.

When updating comments, use a simple string as the parameter to update, you don’t have to use {“body”: <comment body>}.

IssueComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComment.delete()

Delete this resource.

IssueComment.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueEvents

RepoIssues.events()

Return the resource corresponding to all events of this repo’s issues.

IssueEvents.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoIssues.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues.delete()

Delete this resource.

RepoIssues.get(milestone=None, state='open', assignee=None, mentioned=None, labels=None, sort='created', direction='desc', since=None, page=None, per_page=None)

Fetch issues for this repository based on the filter parameters and using the specified format.

For details on the meanings and allowed values for each parameter, see http://developer.github.com/v3/issues/#list-issues-for-a-repository

RepoIssues.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKey

Repo.key(key_id)

Return a resource corresponding to a single key in this repo.

RepoKey.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKey.delete()

Delete this resource.

RepoKey.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoKey.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKeys

Repo.keys()

Return a resource corresponding to all SSH keys of this repo.

RepoKeys.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKeys.delete()

Delete this resource.

RepoKeys.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoKeys.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabel

Repo.label(name)

Return a resource corresponding to a single label from this repo.

RepoLabel.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabel.delete()

Delete this resource.

RepoLabel.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoLabel.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabels

Repo.labels()

Return a resource corresponding to all issues from this repo.

RepoLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabels.delete()

Delete this resource.

RepoLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone

Repo.milestone(milestone_id)

Return a resource corresponding to a single milestone in this repo.

MilestoneLabels

Milestone.labels()

Return the resource corresponding to the labels of this milestone.

MilestoneLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

MilestoneLabels.delete()

Delete this resource.

MilestoneLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

MilestoneLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone.delete()

Delete this resource.

Milestone.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Milestone.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestones

Repo.milestones()

Return a resource corresponding to all milestones in this repo.

Milestones.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestones.delete()

Delete this resource.

Milestones.get(state='open', sort='due_date', direction='desc', page=None, per_page=None)

Fetch milestones for this repository, based on the filter parameters.

For details on the meanings and allowed values for each parameter, see http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository.

Milestones.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequest

Repo.pullrequest(number)

Return a resource corresponding to a single pull request for this repo.

PullRequest.commits()

Fetch commits on this pull request.

PullRequest.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequest.delete()

Delete this resource.

PullRequest.files()

Fetch files on this pull request.

PullRequest.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

PullRequest.is_merged()

Check if this pull request has been merged.

PullRequest.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequests

Repo.pullrequests()

Return a resource corresponding to all the pull requests for this repo.

PullRequests.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequests.delete()

Delete this resource.

PullRequests.get(state=None, page=None, per_page=None)

Fetch pull requests.

Variables:state – Optional filter pull requests by state state: open or closed (default is open)

PullRequests.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Release

Repo.release(release_id)

Return a resource corresponding to a single release in this repo.

ReleaseAsset

Release.asset(asset_id)

ReleaseAsset.delete()

Delete this resource.

ReleaseAsset.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

ReleaseAsset.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReleaseAssets

Release.assets()

ReleaseAssets.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Release.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Release.delete()

Delete this resource.

Release.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Release.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Releases

Repo.releases()

Return a resource corresponding to all releases from this repo.

Releases.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Releases.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Repo.branches()

Fetch the branches for this repo.

Repo.contributors(anon=False)

Fetch the contributors from this repo.

Variables:anon (bool) – Include anonymous contributors.

Repo.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Repo.delete()

Delete this resource.

Repo.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Repo.languages()

Fetch the languages for this repo.

Repo.tags()

Fetch the tags for this repo.

Repo.teams()

Fetch the teams for this repo.

Repo.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Teams

Organizations.teams()

Return a resource corresponding to this org’s teams.

Teams.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Teams.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Organizations.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Organizations.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

UserRepos

User.repos(page=None, per_page=None)

Return the resource corresponding to all the repos of this user.

UserRepos.delete()

Delete this resource.

UserRepos.get(type='all', page=None, per_page=None)

Fetch repos for this user.

Variables:type (str) – What type of repos to fetch. For details of allowed values, see http://developer.github.com/v3/repos/#list-user-repositories.

UserRepos.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

User.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

User.followers(page=None, per_page=None)

Fetch the followers of this user.

User.following(page=None, per_page=None)

Fetch users that this user is following.

User.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

UserEmails

CurrentUser.emails()

Return the resource corresponding to the emails of the authenticated user.

UserEmails.add(emails)

Add emails to the authenticated user.

Variables:emails (list of str) – A list of emails to add.

UserEmails.get()

Fetch all emails of the authenticated user.

UserEmails.remove(emails)

Remove emails from the authenticated user.

Variables:emails (list of str) – A list of emails to remove.

UserMemberships

CurrentUser.memberships()

Return the resource corresponding to the org memberships of the authenticated user.

UserMembership

UserMemberships.org(org)

Return the resource corresponding to the current user’s membership of the specified organization.

UserMembership.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

UserMembership.delete()

Delete this resource.

UserMembership.get()

UserMembership.update(obj)

UserMemberships.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

UserMemberships.delete()

Delete this resource.

UserMemberships.get(state=None)

List your organization memberships.

Variables:state (str) – Specify whether only active or pending memberships are returned. If left as None, all memberships are returned.

UserMemberships.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Organizations

CurrentUser.orgs()

Return a resource corresponding to user’s organizations.

Member

Organizations.member(user)

Return a resource corresponding to a member of this org.

Member.delete()

Delete this resource.

Member.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Members

Organizations.members()

Return a resource corresponding to members of this org.

Members.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

PublicMember

Organizations.public_member(user)

Return a resource corresponding to a public member of this org.

PublicMember.delete()

Delete this resource.

PublicMember.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

PublicMember.publicize()

PublicMembers

Organizations.public_members()

Return a resource corresponding to public members of this org.

PublicMembers.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

OrganizationRepo

Organizations.repo(repo)

Return a resource corresponding to single repo for this org.

RepoCollaborators

OrganizationRepo.collaborators()

Return a resource corresponding to all collaborators in this repo.

RepoCollaborators.add(user)

Add a collaborator to this repo.

Variables:user (str) – The username of the new collaborator.

RepoCollaborators.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoCollaborators.is_collaborator(user)

Check if a user is a collaborator in this repo.

Variables:user (str) – The username to check. Returns:bool

RepoCollaborators.remove(user)

Remove a collaborator from this repo.

Variables:user (str) – The username of the collaborator.

RepoCommit

OrganizationRepo.commit(sha)

Return a resource corresponding to a single commit in this repo.

RepoCommitsComments

RepoCommit.comments()

Return a resource corresponding to all comments of this commit.

RepoCommitsComments.create(comment)

Create a comment on this commit.

Variables:comment (str) – The comment body.

RepoCommitsComments.delete()

Delete this resource.

RepoCommitsComments.get(format=None, page=None, per_page=None)

Fetch all comments for this commit.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommit.get()

Fetch all commits from this repo.

RepoCommits

OrganizationRepo.commits()

Return a resource corresponding to all commits in this repo.

RepoCommitsComment

RepoCommits.comment(comment_id)

Return the resource corresponding to a single comment of this commit.

RepoCommitsComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommitsComment.delete()

Delete this resource.

RepoCommitsComment.get(format=None)

Fetch the comment.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommitsComments

RepoCommits.comments()

Return the resource corresponding to all comments of this commit.

RepoCommitsComments.create(comment)

Create a comment on this commit.

Variables:comment (str) – The comment body.

RepoCommitsComments.delete()

Delete this resource.

RepoCommitsComments.get(format=None, page=None, per_page=None)

Fetch all comments for this commit.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommits.compare(base, head)

Fetch the comparison of two commits.

Variables:

• base (str) – The commit hash of the first commit.
• head (str) – The commit hash of the second commit.

RepoCommits.get(sha=None, path=None, page=None, per_page=None)

Fetch commits for this repo.

Variables:

• sha (str) – Optional commit hash or branch to start listing commits from.
• path (str) – Optional filter to only include commits that include this file path.

RepoContents

OrganizationRepo.contents()

Return a resource corresponding to repo contents.

RepoContents.archivelink(archive_format, ref=None)

This method will return a URL to download a tarball or zipball archive for a repository.

Variables:

• archive_format – Either tarball or zipball.
• ref – Optional string name of the commit/branch/tag. Defaults to master.

RepoContents.get(path=None, ref=None)

This method returns the contents of any file or directory in a repository.

Variables:

• path (str) – Optional content path.
• ref (str) – Optional string name of the commit/branch/tag. Defaults to master.

RepoContents.readme(ref=None)

This method returns the preferred README for a repository.

Variables:ref (str) – Optional string name of the commit/branch/tag. Defaults to master.

Download

OrganizationRepo.download(download_id)

Return a resource corresponding to a single download in this repo.

Download.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Download.delete()

Delete this resource.

Download.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Downloads

OrganizationRepo.downloads()

Return a resource corresponding to all downloads from this repo.

Downloads.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Downloads.delete()

Delete this resource.

Downloads.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Forks

OrganizationRepo.forks()

Return a resource corresponding to all forks of this repo.

Forks.create()

Fork this repo.

Forks.get(sort='newest', page=None, per_page=None)

Fetch this repo’s forks.

Variables:

• sort (str) – The sort order for the result.
• page (int) – The starting page of the result. If left as None, the first page is returned.
• per_page (int) – The amount of results per page.

RepoHook

OrganizationRepo.hook(hook_id)

Return a resource corresponding to a single hook in this repo.

RepoHook.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHook.delete()

Delete this resource.

RepoHook.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoHook.ping()

Send a ping event to the hook.

RepoHook.test()

Trigger the hook with the latest push to the repository.

RepoHook.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHooks

OrganizationRepo.hooks()

Return a resource corresponding to all hooks of this repo.

RepoHooks.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHooks.delete()

Delete this resource.

RepoHooks.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoHooks.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue

OrganizationRepo.issue(issue_id)

Return a resource corresponding to a single issue from this repo.

IssueComments

RepoIssue.comments()

Return the resource corresponding to the comments of this issue.

When creating comments, use a simple string as the parameter to create, you don’t have to use {“body”: <comment body>}.

IssueComments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComments.delete()

Delete this resource.

IssueComments.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueEvent

RepoIssue.event(event_id)

Return the resource corresponding to a single event of this issue.

IssueEvent.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueEvents

RepoIssue.events()

Return the resource corresponding to all the events of this issue.

IssueEvents.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabel

RepoIssue.label(name)

Return the resource corresponding to a single label of this issue.

IssueLabel.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabel.delete()

Delete this resource.

IssueLabel.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabel.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabels

RepoIssue.labels()

Return the resource corresponding to all labels of this issue.

IssueLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabels.delete()

Delete all labels from this issue.

IssueLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabels.replace(labels)

Replace all labels on this issue with new ones.

Variables:labels (list of str) – A list of labels to use.

IssueLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.delete()

Delete this resource.

RepoIssue.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoIssue.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues

OrganizationRepo.issues()

Return a resource corresponding to all issues from this repo.

IssueComment

RepoIssues.comment(comment_id)

Return the resource corresponding to a single comment of an issue.

When updating comments, use a simple string as the parameter to update, you don’t have to use {“body”: <comment body>}.

IssueComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComment.delete()

Delete this resource.

IssueComment.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueEvents

RepoIssues.events()

Return the resource corresponding to all events of this repo’s issues.

IssueEvents.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoIssues.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues.delete()

Delete this resource.

RepoIssues.get(milestone=None, state='open', assignee=None, mentioned=None, labels=None, sort='created', direction='desc', since=None, page=None, per_page=None)

Fetch issues for this repository based on the filter parameters and using the specified format.

For details on the meanings and allowed values for each parameter, see http://developer.github.com/v3/issues/#list-issues-for-a-repository

RepoIssues.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKey

OrganizationRepo.key(key_id)

Return a resource corresponding to a single key in this repo.

RepoKey.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKey.delete()

Delete this resource.

RepoKey.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoKey.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKeys

OrganizationRepo.keys()

Return a resource corresponding to all SSH keys of this repo.

RepoKeys.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKeys.delete()

Delete this resource.

RepoKeys.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoKeys.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabel

OrganizationRepo.label(name)

Return a resource corresponding to a single label from this repo.

RepoLabel.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabel.delete()

Delete this resource.

RepoLabel.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoLabel.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabels

OrganizationRepo.labels()

Return a resource corresponding to all issues from this repo.

RepoLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabels.delete()

Delete this resource.

RepoLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone

OrganizationRepo.milestone(milestone_id)

Return a resource corresponding to a single milestone in this repo.

MilestoneLabels

Milestone.labels()

Return the resource corresponding to the labels of this milestone.

MilestoneLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

MilestoneLabels.delete()

Delete this resource.

MilestoneLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

MilestoneLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone.delete()

Delete this resource.

Milestone.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Milestone.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestones

OrganizationRepo.milestones()

Return a resource corresponding to all milestones in this repo.

Milestones.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestones.delete()

Delete this resource.

Milestones.get(state='open', sort='due_date', direction='desc', page=None, per_page=None)

Fetch milestones for this repository, based on the filter parameters.

For details on the meanings and allowed values for each parameter, see http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository.

Milestones.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequest

OrganizationRepo.pullrequest(number)

Return a resource corresponding to a single pull request for this repo.

PullRequest.commits()

Fetch commits on this pull request.

PullRequest.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequest.delete()

Delete this resource.

PullRequest.files()

Fetch files on this pull request.

PullRequest.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

PullRequest.is_merged()

Check if this pull request has been merged.

PullRequest.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequests

OrganizationRepo.pullrequests()

Return a resource corresponding to all the pull requests for this repo.

PullRequests.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequests.delete()

Delete this resource.

PullRequests.get(state=None, page=None, per_page=None)

Fetch pull requests.

Variables:state – Optional filter pull requests by state state: open or closed (default is open)

PullRequests.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Release

OrganizationRepo.release(release_id)

Return a resource corresponding to a single release in this repo.

ReleaseAsset

Release.asset(asset_id)

ReleaseAsset.delete()

Delete this resource.

ReleaseAsset.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

ReleaseAsset.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReleaseAssets

Release.assets()

ReleaseAssets.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Release.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Release.delete()

Delete this resource.

Release.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Release.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Releases

OrganizationRepo.releases()

Return a resource corresponding to all releases from this repo.

Releases.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Releases.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

OrganizationRepo.branches()

Fetch the branches for this repo.

OrganizationRepo.contributors(anon=False)

Fetch the contributors from this repo.

Variables:anon (bool) – Include anonymous contributors.

OrganizationRepo.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

OrganizationRepo.delete()

Delete this resource.

OrganizationRepo.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

OrganizationRepo.languages()

Fetch the languages for this repo.

OrganizationRepo.tags()

Fetch the tags for this repo.

OrganizationRepo.teams()

Fetch the teams for this repo.

OrganizationRepo.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Repo

Organizations.repos()

Return a resource corresponding to repos for this org.

RepoCollaborators

Repo.collaborators()

Return a resource corresponding to all collaborators in this repo.

RepoCollaborators.add(user)

Add a collaborator to this repo.

Variables:user (str) – The username of the new collaborator.

RepoCollaborators.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoCollaborators.is_collaborator(user)

Check if a user is a collaborator in this repo.

Variables:user (str) – The username to check. Returns:bool

RepoCollaborators.remove(user)

Remove a collaborator from this repo.

Variables:user (str) – The username of the collaborator.

RepoCommit

Repo.commit(sha)

Return a resource corresponding to a single commit in this repo.

RepoCommitsComments

RepoCommit.comments()

Return a resource corresponding to all comments of this commit.

RepoCommitsComments.create(comment)

Create a comment on this commit.

Variables:comment (str) – The comment body.

RepoCommitsComments.delete()

Delete this resource.

RepoCommitsComments.get(format=None, page=None, per_page=None)

Fetch all comments for this commit.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommit.get()

Fetch all commits from this repo.

RepoCommits

Repo.commits()

Return a resource corresponding to all commits in this repo.

RepoCommitsComment

RepoCommits.comment(comment_id)

Return the resource corresponding to a single comment of this commit.

RepoCommitsComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommitsComment.delete()

Delete this resource.

RepoCommitsComment.get(format=None)

Fetch the comment.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommitsComments

RepoCommits.comments()

Return the resource corresponding to all comments of this commit.

RepoCommitsComments.create(comment)

Create a comment on this commit.

Variables:comment (str) – The comment body.

RepoCommitsComments.delete()

Delete this resource.

RepoCommitsComments.get(format=None, page=None, per_page=None)

Fetch all comments for this commit.

Variables:format – Which format should be requested, either raw, text, html or full. For details on formats, see http://developer.github.com/v3/mime/#comment-body-properties.

RepoCommitsComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoCommits.compare(base, head)

Fetch the comparison of two commits.

Variables:

• base (str) – The commit hash of the first commit.
• head (str) – The commit hash of the second commit.

RepoCommits.get(sha=None, path=None, page=None, per_page=None)

Fetch commits for this repo.

Variables:

• sha (str) – Optional commit hash or branch to start listing commits from.
• path (str) – Optional filter to only include commits that include this file path.

RepoContents

Repo.contents()

Return a resource corresponding to repo contents.

RepoContents.archivelink(archive_format, ref=None)

This method will return a URL to download a tarball or zipball archive for a repository.

Variables:

• archive_format – Either tarball or zipball.
• ref – Optional string name of the commit/branch/tag. Defaults to master.

RepoContents.get(path=None, ref=None)

This method returns the contents of any file or directory in a repository.

Variables:

• path (str) – Optional content path.
• ref (str) – Optional string name of the commit/branch/tag. Defaults to master.

RepoContents.readme(ref=None)

This method returns the preferred README for a repository.

Variables:ref (str) – Optional string name of the commit/branch/tag. Defaults to master.

Download

Repo.download(download_id)

Return a resource corresponding to a single download in this repo.

Download.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Download.delete()

Delete this resource.

Download.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Downloads

Repo.downloads()

Return a resource corresponding to all downloads from this repo.

Downloads.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Downloads.delete()

Delete this resource.

Downloads.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Forks

Repo.forks()

Return a resource corresponding to all forks of this repo.

Forks.create()

Fork this repo.

Forks.get(sort='newest', page=None, per_page=None)

Fetch this repo’s forks.

Variables:

• sort (str) – The sort order for the result.
• page (int) – The starting page of the result. If left as None, the first page is returned.
• per_page (int) – The amount of results per page.

RepoHook

Repo.hook(hook_id)

Return a resource corresponding to a single hook in this repo.

RepoHook.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHook.delete()

Delete this resource.

RepoHook.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoHook.ping()

Send a ping event to the hook.

RepoHook.test()

Trigger the hook with the latest push to the repository.

RepoHook.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHooks

Repo.hooks()

Return a resource corresponding to all hooks of this repo.

RepoHooks.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoHooks.delete()

Delete this resource.

RepoHooks.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoHooks.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue

Repo.issue(issue_id)

Return a resource corresponding to a single issue from this repo.

IssueComments

RepoIssue.comments()

Return the resource corresponding to the comments of this issue.

When creating comments, use a simple string as the parameter to create, you don’t have to use {“body”: <comment body>}.

IssueComments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComments.delete()

Delete this resource.

IssueComments.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueComments.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueEvent

RepoIssue.event(event_id)

Return the resource corresponding to a single event of this issue.

IssueEvent.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueEvents

RepoIssue.events()

Return the resource corresponding to all the events of this issue.

IssueEvents.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabel

RepoIssue.label(name)

Return the resource corresponding to a single label of this issue.

IssueLabel.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabel.delete()

Delete this resource.

IssueLabel.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabel.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabels

RepoIssue.labels()

Return the resource corresponding to all labels of this issue.

IssueLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueLabels.delete()

Delete all labels from this issue.

IssueLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueLabels.replace(labels)

Replace all labels on this issue with new ones.

Variables:labels (list of str) – A list of labels to use.

IssueLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssue.delete()

Delete this resource.

RepoIssue.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoIssue.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues

Repo.issues()

Return a resource corresponding to all issues from this repo.

IssueComment

RepoIssues.comment(comment_id)

Return the resource corresponding to a single comment of an issue.

When updating comments, use a simple string as the parameter to update, you don’t have to use {“body”: <comment body>}.

IssueComment.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueComment.delete()

Delete this resource.

IssueComment.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

IssueComment.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IssueEvents

RepoIssues.events()

Return the resource corresponding to all events of this repo’s issues.

IssueEvents.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoIssues.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoIssues.delete()

Delete this resource.

RepoIssues.get(milestone=None, state='open', assignee=None, mentioned=None, labels=None, sort='created', direction='desc', since=None, page=None, per_page=None)

Fetch issues for this repository based on the filter parameters and using the specified format.

For details on the meanings and allowed values for each parameter, see http://developer.github.com/v3/issues/#list-issues-for-a-repository

RepoIssues.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKey

Repo.key(key_id)

Return a resource corresponding to a single key in this repo.

RepoKey.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKey.delete()

Delete this resource.

RepoKey.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoKey.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKeys

Repo.keys()

Return a resource corresponding to all SSH keys of this repo.

RepoKeys.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoKeys.delete()

Delete this resource.

RepoKeys.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoKeys.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabel

Repo.label(name)

Return a resource corresponding to a single label from this repo.

RepoLabel.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabel.delete()

Delete this resource.

RepoLabel.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoLabel.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabels

Repo.labels()

Return a resource corresponding to all issues from this repo.

RepoLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

RepoLabels.delete()

Delete this resource.

RepoLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

RepoLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone

Repo.milestone(milestone_id)

Return a resource corresponding to a single milestone in this repo.

MilestoneLabels

Milestone.labels()

Return the resource corresponding to the labels of this milestone.

MilestoneLabels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

MilestoneLabels.delete()

Delete this resource.

MilestoneLabels.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

MilestoneLabels.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestone.delete()

Delete this resource.

Milestone.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Milestone.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestones

Repo.milestones()

Return a resource corresponding to all milestones in this repo.

Milestones.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Milestones.delete()

Delete this resource.

Milestones.get(state='open', sort='due_date', direction='desc', page=None, per_page=None)

Fetch milestones for this repository, based on the filter parameters.

For details on the meanings and allowed values for each parameter, see http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository.

Milestones.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequest

Repo.pullrequest(number)

Return a resource corresponding to a single pull request for this repo.

PullRequest.commits()

Fetch commits on this pull request.

PullRequest.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequest.delete()

Delete this resource.

PullRequest.files()

Fetch files on this pull request.

PullRequest.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

PullRequest.is_merged()

Check if this pull request has been merged.

PullRequest.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequests

Repo.pullrequests()

Return a resource corresponding to all the pull requests for this repo.

PullRequests.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PullRequests.delete()

Delete this resource.

PullRequests.get(state=None, page=None, per_page=None)

Fetch pull requests.

Variables:state – Optional filter pull requests by state state: open or closed (default is open)

PullRequests.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Release

Repo.release(release_id)

Return a resource corresponding to a single release in this repo.

ReleaseAsset

Release.asset(asset_id)

ReleaseAsset.delete()

Delete this resource.

ReleaseAsset.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

ReleaseAsset.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReleaseAssets

Release.assets()

ReleaseAssets.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Release.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Release.delete()

Delete this resource.

Release.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Release.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Releases

Repo.releases()

Return a resource corresponding to all releases from this repo.

Releases.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Releases.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Repo.branches()

Fetch the branches for this repo.

Repo.contributors(anon=False)

Fetch the contributors from this repo.

Variables:anon (bool) – Include anonymous contributors.

Repo.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Repo.delete()

Delete this resource.

Repo.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Repo.languages()

Fetch the languages for this repo.

Repo.tags()

Fetch the tags for this repo.

Repo.teams()

Fetch the teams for this repo.

Repo.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Teams

Organizations.teams()

Return a resource corresponding to this org’s teams.

Teams.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Teams.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Organizations.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

Organizations.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Teams

CurrentUser.teams()

Return the resource corresponding to the teams that the current user belongs to.

Teams.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Teams.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

CurrentUser.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

CurrentUser.follow(name)

Start following the given user.

CurrentUser.followers(page=None, per_page=None)

Fetch the followers of this user.

CurrentUser.following(page=None, per_page=None)

Fetch users that this user is following.

CurrentUser.follows(name)

Check if the authenticated user follows the given user.

Returns:bool

CurrentUser.get(page=None, per_page=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. The maximum is 100. If left as None, 30 objects are returned.

CurrentUser.unfollow(name)

Stop following the given user.

CurrentUser.update(obj)

GoogleAnalytics

class googleanalytics.GoogleAnalytics(access_token=None)

Create a Google Analytics service.

Variables:access_token –

Management

GoogleAnalytics.management()

Return the resource corresponding to the management API

Account

Management.account(account_id)

Return the resource corresponding to a single account

WebProperties

Account.webproperties()

Return the resource corresponding to all web properties

WebProperties.get(max_results=None, start_index=None, userIp=None, quotaUser=None)

List resource

Variables:

• max-results (int) – The maximum number of rows to include in the response
• start-index (int) – The first row of data to retrieve, starting at 1. Use this parameter as a pagination mechanism along with the max-results parameter.
• userIp (str) – Specifies IP address of the end user for whom the API call is being made. Used to cap usage per IP.
• quotaUser (str) – Alternative to userIp in cases when the user’s IP address is unknown.

WebProperty

Account.webproperty(webproperty_id)

Return the resource corresponding to a single property

View

WebProperty.view(profile_id)

Return the resource corresponding to a single view

Goal

View.goal(goal_id)

Return the resource corresponding to a single goal

Goal.get(userIp=None, quotaUser=None)

Get resource

Variables:

• userIp (str) – Specifies IP address of the end user for whom the API call is being made. Used to cap usage per IP.
• quotaUser (str) – Alternative to userIp in cases when the user’s IP address is unknown.

Goals

View.goals()

Return the resource corresponding to all goals

Goals.get(max_results=None, start_index=None, userIp=None, quotaUser=None)

List resource

Variables:

• max-results (int) – The maximum number of rows to include in the response
• start-index (int) – The first row of data to retrieve, starting at 1. Use this parameter as a pagination mechanism along with the max-results parameter.
• userIp (str) – Specifies IP address of the end user for whom the API call is being made. Used to cap usage per IP.
• quotaUser (str) – Alternative to userIp in cases when the user’s IP address is unknown.

View.get(userIp=None, quotaUser=None)

Get resource

Variables:

• userIp (str) – Specifies IP address of the end user for whom the API call is being made. Used to cap usage per IP.
• quotaUser (str) – Alternative to userIp in cases when the user’s IP address is unknown.

Views

WebProperty.views()

Return the resource corresponding to all views

Views.get(max_results=None, start_index=None, userIp=None, quotaUser=None)

List resource

Variables:

• max-results (int) – The maximum number of rows to include in the response
• start-index (int) – The first row of data to retrieve, starting at 1. Use this parameter as a pagination mechanism along with the max-results parameter.
• userIp (str) – Specifies IP address of the end user for whom the API call is being made. Used to cap usage per IP.
• quotaUser (str) – Alternative to userIp in cases when the user’s IP address is unknown.

WebProperty.get(userIp=None, quotaUser=None)

Get resource

Variables:

• userIp (str) – Specifies IP address of the end user for whom the API call is being made. Used to cap usage per IP.
• quotaUser (str) – Alternative to userIp in cases when the user’s IP address is unknown.

Account.get(userIp=None, quotaUser=None)

Get resource

Variables:

• userIp (str) – Specifies IP address of the end user for whom the API call is being made. Used to cap usage per IP.
• quotaUser (str) – Alternative to userIp in cases when the user’s IP address is unknown.

Accounts

Management.accounts()

Return the resource corresponding to all accounts

Accounts.get(max_results=None, start_index=None, userIp=None, quotaUser=None)

List resource

Variables:

• max-results (int) – The maximum number of rows to include in the response
• start-index (int) – The first row of data to retrieve, starting at 1. Use this parameter as a pagination mechanism along with the max-results parameter.
• userIp (str) – Specifies IP address of the end user for whom the API call is being made. Used to cap usage per IP.
• quotaUser (str) – Alternative to userIp in cases when the user’s IP address is unknown.

Segments

Management.segments()

Return the resource corresponding to all segments

Segments.get(max_results=None, start_index=None, userIp=None, quotaUser=None)

List resource

Variables:

• max-results (int) – The maximum number of rows to include in the response
• start-index (int) – The first row of data to retrieve, starting at 1. Use this parameter as a pagination mechanism along with the max-results parameter.
• userIp (str) – Specifies IP address of the end user for whom the API call is being made. Used to cap usage per IP.
• quotaUser (str) – Alternative to userIp in cases when the user’s IP address is unknown.

Reporting

GoogleAnalytics.reporting()

Return the resource corresponding to the reporting API

Reporting.core(ids, start_date, end_date, metrics, dimensions=None, sort=None, filters=None, segment=None, start_index=None, max_results=None, fields=None, prettyPrint=None, userIp=None, quotaUser=None, access_token=None, key=None)

Query the Core Reporting API for Google Analytics report data.

Variables:

• ids (str) – The unique table ID of the form ga:XXXX, where XXXX is the Analytics view (profile) ID for which the query will retrieve the data.
• start-date (str) – The first date of the date range for which you are requesting the data.
• end-date (str) – The first last of the date range for which you are requesting the data.
• metrics (str) – A list of comma-separated metrics, such as ga:visits,ga:bounces.
• dimensions (str) – A list of comma-separated dimensions for your Analytics data, such as ga:browser,ga:city.

:var sort A list of comma-separated dimensions and metrics indicating

the sorting order and sorting direction for the returned data.

Variables:

• filters (str) – Dimension or metric filters that restrict the data returned for your request.
• segment (str) – Segments the data returned for your request.
• start-index (int) – The first row of data to retrieve, starting at 1. Use this parameter as a pagination mechanism along with the max-results parameter.
• max-results (int) – The maximum number of rows to include in the response
• fields – Selector specifying a subset of fields to include in the response.
• prettyPrint (bool) – Returns response with indentations and line breaks. Default false.
• userIp (str) – Specifies IP address of the end user for whom the API call is being made. Used to cap usage per IP.
• quotaUser (str) – Alternative to userIp in cases when the user’s IP address is unknown.
• access_token (str) – One possible way to provide an OAuth 2.0 token.
• key (str) – Used for OAuth 1.0a authorization to specify your application to get quota. For example: key=AldefliuhSFADSfasdfasdfASdf.

Reporting.realtime(ids, metrics, dimensions=None, sort=None, filters=None, max_results=None, fields=None, prettyPrint=None, userIp=None, quotaUser=None, access_token=None, key=None)

Returns real-time data for a view (profile)

Variables:

• ids (str) – The unique table ID of the form ga:XXXX, where XXXX is the Analytics view (profile) ID for which the query will retrieve the data.
• metrics (str) – A list of comma-separated metrics, such as ga:visits,ga:bounces.
• dimensions (str) – A list of comma-separated dimensions for your Analytics data, such as ga:browser,ga:city.

:var sort A list of comma-separated dimensions and metrics indicating

the sorting order and sorting direction for the returned data.

Variables:

• filters (str) – Dimension or metric filters that restrict the data returned for your request.
• max-results (int) – The maximum number of rows to include in the response
• fields – Selector specifying a subset of fields to include in the response.
• prettyPrint (bool) – Returns response with indentations and line breaks. Default false.
• userIp (str) – Specifies IP address of the end user for whom the API call is being made. Used to cap usage per IP.
• quotaUser (str) – Alternative to userIp in cases when the user’s IP address is unknown.

GoogleCalendar

class googlecalendar.GoogleCalendar(access_token=None)

Create a Google Calendar service.

Variables:access_token –

Calendar

GoogleCalendar.calendar(calendar_id)

Return the resource corresponding to a single calendar

Event

Calendar.event(event_id)

Return the resource corresponding to a single event

Event.delete(sendNotifications=None)

Delete this resource.

Variables:sendNotifications (str) – Whether to send notifications. The default is False.

Event.get(alwaysIncludeEmail=None, maxAttendees=None, timeZone=None)

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

Variables:

• alwaysIncludeEmail (str) – Whether to always include a value in the “email” field for the organizer, creator and attendees, even if no real email is available. The default is False.
• maxAttendees (int) – The maximum number of attendees to include in the response. If none is indicated, only the participant is returned.
• timeZone (str) – Time zone used in the response. The default is the time zone of the calendar.

Event.instances(alwaysIncludeEmail=None, maxAttendees=None, maxResults=None, originalStart=None, pageToken=None, showDeleted=None, timeZone=None)

Fetch all instances of the recurring event.

Variables:

• alwaysIncludeEmail (str) – Whether to always include a value in the “email” field for the organizer, creator and attendees, even if no real email is available. The default is False.
• maxAttendees (int) – The maximum number of attendees to include in the response. If none is indicated, only the participant is returned.
• maxResults (int) – Maximum number of instances returned.
• originalStart (str) – The original start time of the instance in the result.
• pageToken (str) – Token specifying which result page to return.
• showDeleted (str) – Whether to include deleted instances. The default is False.
• timeZone (str) – Time zone used in the response. The default is the time zone of the calendar.

Event.move(destination, sendNotifications=None)

Move an event to another calendar.

Variables:

• destination (str) – Calendar identifier of the target calendar where the event is to be moved to.
• sendNotifications (str) – Whether to send notifications. The default is False.

Event.patch(obj, alwaysIncludeEmail=None, sendNotifications=None)

Patch this resource.

Variables:

• obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
• alwaysIncludeEmail (str) – Whether to always include a value in the “email” field for the organizer, creator and attendees, even if no real email is available. The default is False.
• sendNotifications (str) – Whether to send notifications. The default is False.

Event.update(obj, alwaysIncludeEmail=None, sendNotifications=None)

Update this resource.

Variables:

• obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
• alwaysIncludeEmail (str) – Whether to always include a value in the “email” field for the organizer, creator and attendees, even if no real email is available. The default is False.
• sendNotifications (str) – Whether to send notifications. The default is False.

Events

Calendar.events()

Return the resource corresponding to all the events

Events.create(obj, sendNotifications=None)

Create a new resource.

Variables:

• obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
• sendNotifications (str) – Whether to send notifications. The default is False.

Events.get(alwaysIncludeEmail=None, iCalUID=None, maxAttendees=None, maxResults=None, orderBy=None, pageToken=None, q=None, showDeleted=None, showHiddenInvitations=None, singleEvents=None, timeMax=None, timeMin=None, timeZone=None, updateMin=None)

Fetch all events on the calendar.

Variables:

• alwaysIncludeEmail (str) – Whether to always include a value in the “email” field for the organizer, creator and attendees, even if no real email is available. The default is False.
• iCalUID (str) – Specifies iCalendar UID of events to be included.
• maxAttendees (int) – The maximum number of attendees to include in the response. If none is indicated, only the participant is returned.
• maxResults (int) – Maximum number of events returned.
• orderBy (str) – The order of the events returned in the result. The default is an unspecified, stable order.
• pageToken (str) – Token specifying which result page to return.
• q (str) – Free text search terms to find events that match these terms.
• showDeleted (str) – Whether to include deleted events. The default is False.
• showHiddenInvitations (str) – Whether to include hidden invitations. The default is False.
• singleEvents (str) – Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. The default is False.

. :var timeMax: Upper bound for an event’s start time to filter by.

The default is not to filter by start time.

Variables:

• timeMin (str) – Lower bound for an event’s end time to filter by. The default is not to filter by end time.
• timeZone (str) – Time zone used in the response. The default is the time zone of the calendar.
• updatedMin – Lower bound for an event’s last modification timestamp to filter by. Optional. The default is not to filter by last modification time.

Events.importing(obj)

Import an event.

Variables:obj – a Python object representing the imported event.

Events.quick_add(text, sendNotifications=None)

Import an event.

Variables:

• text (str) – The text describing the event to be created.
• sendNotifications (str) – Whether to send notifications. The default is False.

Acl

Calendar.rule(rule_id)

Return the resource corresponding to a single rule

Acl.delete()

Delete this resource.

Acl.get()

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

Acl.patch(obj)

Update this resource’s metadata.

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

Acl.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Acls

Calendar.rules()

Return the resource corresponding to all the rules

Acls.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Acls.get()

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

Calendar.clear()

Clear this calendar.

Calendar.delete()

Delete this resource.

Calendar.get()

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

Calendar.patch(obj)

Update this resource’s metadata.

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

Calendar.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Calendars

GoogleCalendar.calendars()

Return the resource corresponding to all the calendars

Calendars.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ColorsResource

GoogleCalendar.colors()

Return the resource corresponding to all the colors

ColorsResource.get()

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

FreeBusyResource

GoogleCalendar.freebusy()

Return the resource corresponding to all the free/busy info

FreeBusyResource.query(obj)

Return free/busy info for a set of calendars.

Variables:obj – a Python object representing the query.

User

GoogleCalendar.me()

Return the resource corresponding to the current user

CalendarList

User.calendar_list(calendar_id)

Return the resource corresponding to a single calendar list

CalendarList.delete()

Delete this resource.

CalendarList.get()

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

CalendarList.patch(obj)

Update this resource’s metadata.

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

CalendarList.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

CalendarLists

User.calendar_lists()

Return the resource corresponding to all the calendar lists

CalendarLists.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

CalendarLists.get()

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

SettingResource

User.setting(setting)

Return the resource corresponding to a single setting

SettingResource.get()

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

SettingResource

User.settings()

Return the resource corresponding to all the settings

SettingResource.get()

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

GoogleOAuth2

class googleoauth2.GoogleOAuth2(client_id, client_secret)

Create a Google Analytics service.

Variables:

• client_id – The client_id obtained from the APIs Console. Indicates the client that is making the request. The value passed in this parameter must exactly match the value shown in the APIs Console.
• client_id – str

Service methods

GoogleOAuth2.access_token(code, redirect_uri)

Get the access and/or refresh token

Variables:

• code (str) – The authorization code returned from the initial request
• redirect_uri (str) – The URI registered with the application

GoogleOAuth2.refresh_token(refresh_token)

Refresh the access token

Variables:refresh_token – The refresh token returned from the authorization code exchange

GoogleSpreadsheets

class googlespreadsheets.GoogleSpreadsheets(access_token=None)

Create a Google Spreadsheets service.

Variables:access_token –

Spreadsheet

GoogleSpreadsheets.spreadsheet(key)

Return the resource corresponding to a single spreadsheet

Worksheet

Spreadsheet.worksheet(worksheet_id, visibility, projection)

Return the resource corresponding to a single worksheet

Cell

Worksheet.cell(cell_id)

Return the resource corresponding to a single cell

Cell.get()

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

Cell.update(version, obj)

Update this resource.

Variables:

• version (str) – the resource version you want to update.
• obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Cells

Worksheet.cells()

Return the resource corresponding to all the cells

Cells.get(min_row=None, max_row=None, min_col=None, max_col=None)

Fetch cells for the worksheet.

Variables:

• min_row (int) – To get cells above the indicated row.
• max_row (int) – To get cells below the given row.
• min_col (int) – To get cells from the indicated column.
• max_col (int) – To get cells to the given column.

Row

Worksheet.row(row_id)

Return the resource corresponding to a single row

Row.delete(version)

Delete this resource.

Variables:version (str) – the resource version you want to delete.

Row.update(version, obj)

Update this resource.

Variables:

• version (str) – the resource version you want to update.
• obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Rows

Worksheet.rows()

Return the resource corresponding to all the rows

Rows.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same as returned from get. Refer to the upstream documentation for details.

Rows.get(reverse=None, orderby=None, sq=None)

Fetch rows for the worksheet.

Variables:

• reverse (bool) – To get rows in reverse order
• orderby (str) – To sort the values in ascending order by a particular column.
• sq (str) – Use it to produce a feed with entries that meet the specified criteria.

Worksheet.delete(version)

Delete this resource.

Variables:version (str) – the resource version you want to delete.

Worksheet.get()

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

Worksheet.update(version, obj)

Update this resource.

Variables:

• version (str) – the resource version you want to update.
• obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Worksheets

Spreadsheet.worksheets(visibility, projection)

Return the resource corresponding to all the worksheets

Worksheets.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same as returned from get. Refer to the upstream documentation for details.

Worksheets.get()

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

Spreadsheets

GoogleSpreadsheets.spreadsheets()

Return the resource corresponding to all the spreadsheets

Spreadsheets.get()

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

Instagram

class instagram.Instagram(client_id=None, access_token=None)

Create an Instagram service.

Variables:

• client_id (str) – Associates your script with a specific application. Required if no access_token.
• access_token (str) – For some requests, specifically those made on behalf of a user, authentication is needed. Required if no client_id.

AuthenticatedUser

Instagram.authenticated_user()

Return the resource corresponding to the authenticated user.

Feed

AuthenticatedUser.feed()

Return the resource corresponding to all entries for the user.

Feed.get(count=None, min_id=None, max_id=None)

Fetch all of the objects.

Variables:

• count (int) – Count of media to return.
• min_id (int) – Return media later than this min_id.
• max_id (int) – Return media earlier than this max_id.

LikedMedia

AuthenticatedUser.liked_media()

Return the resource corresponding to all liked media for the user.

LikedMedia.get(count=None, max_liked_id=None)

Fetch all of the objects.

Variables:

• count (int) – Count of media to return.
• max_like_id (int) – Return media liked before this id.

RequestedBy

AuthenticatedUser.requested_by()

Return the resource corresponding to all requests for the user.

RequestedBy.get()

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

AuthenticatedUser.get()

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

Geography

Instagram.geography(geo_id)

Return the resource corresponding to a single geography

RecentMedia

Geography.recent_media()

Return the resource corresponding to all recent media for the greography.

RecentMedia.get(count=None, max_timestamp=None, min_timestamp=None, min_id=None, max_id=None)

Fetch all of the objects.

Variables:

• count (int) – Count of media to return.
• max_timestamp (int) – Return media before this UNIX timestamp.
• min_timestamp (int) – Return media after this UNIX timestamp.
• min_id (int) – Return media later than this min_id.
• max_id (int) – Return media earlier than this max_id.

Location

Instagram.location(location_id)

Return the resource corresponding to a single location.

RecentMedia

Location.recent_media()

Return the resource corresponding to all recent media for the location.

RecentMedia.get(count=None, max_timestamp=None, min_timestamp=None, min_id=None, max_id=None)

Fetch all of the objects.

Variables:

• count (int) – Count of media to return.
• max_timestamp (int) – Return media before this UNIX timestamp.
• min_timestamp (int) – Return media after this UNIX timestamp.
• min_id (int) – Return media later than this min_id.
• max_id (int) – Return media earlier than this max_id.

Location.get()

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

Locations

Instagram.locations()

Return the resource corresponding to all locations.

Locations.get(lat=None, distance=None, lng=None, foursquare_v2_id=None, foursquare_id=None)

fetch all locations by geographic coordinate.

Variables:

• lat (float) – Latitude of the center search coordinate. If used, lng is required.
• distance (int) – Default is 1km (distance=1000), max distance is 5km.
• lng (float) – Longitude of the center search coordinate. If used, lat is required.
• foursquare_v2_id (str) – A foursquare v2 api location id. If used, you are not required to use lat and ln
• foursquare_id (str) – A foursquare v1 api location id. If used, you are not required to use lat and lng. Note that this method is deprecated; you should use the new foursquare IDs with V2 of their API.

Media

Instagram.media(media_id)

Return the resource corresponding to a single media.

Comment

Media.comment(comment_id)

Return the resource corresponding to a single comment for the media.

Comment.delete()

Delete this resource.

Comments

Media.comments()

Return the resource corresponding to all comments for the media.

Comments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Comments.get()

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

Likes

Media.likes()

Return the resource corresponding to all likes for the media.

Likes.create()

Set a like on this media by the currently authenticated user.

Likes.delete()

Remove a like on this media by the currently authenticated user.

Likes.get()

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

Media.get()

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

Medias

Instagram.medias()

Return the resource corresponding to all medias.

Medias.get(lat=None, max_timestamp=None, min_timestamp=None, lng=None, distance=None)

Fetch all of the objects.

Variables:

• lat (float) – Latitude of the center search coordinate. If used, lng is required.
• max_timestamp (int) – A unix timestamp. All media returned will be taken later than this timestamp.
• min_timestamp (int) – A unix timestamp. All media returned will be taken earlier than this timestamp.
• lng (float) – Longitude of the center search coordinate. If used, lat is required.
• distance (int) – Default is 1km (distance=1000), max distance is 5km.

PopularMedia

Instagram.popular_media()

Return the resource corresponding to all most popular media.

PopularMedia.get()

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

Tag

Instagram.tag(tag_name)

Return the resource corresponding to a single tag.

RecentMedia

Tag.recent_media()

Return the resource corresponding to all recent media for the tag.

RecentMedia.get(count=None, max_timestamp=None, min_timestamp=None, min_id=None, max_id=None)

Fetch all of the objects.

Variables:

• count (int) – Count of media to return.
• max_timestamp (int) – Return media before this UNIX timestamp.
• min_timestamp (int) – Return media after this UNIX timestamp.
• min_id (int) – Return media later than this min_id.
• max_id (int) – Return media earlier than this max_id.

Tag.get()

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

Tags

Instagram.tags()

Return the resource corresponding to all tags.

Tags.get(query)

fetch all tags by name.

Variables:query (str) – A valid tag name without a leading #. (eg. snow, nofilter).

User

Instagram.user(user_id)

Return the resource corresponding to a single user.

FollowedBy

User.followed_by()

Return the resource corresponding to all followers for the user.

FollowedBy.get()

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

Follows

User.follows()

Return the resource corresponding to all follows for the user.

Follows.get()

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

RecentMedia

User.recent_media()

Return the resource corresponding to all recent media for the user.

RecentMedia.get(count=None, max_timestamp=None, min_timestamp=None, min_id=None, max_id=None)

Fetch all of the objects.

Variables:

• count (int) – Count of media to return.
• max_timestamp (int) – Return media before this UNIX timestamp.
• min_timestamp (int) – Return media after this UNIX timestamp.
• min_id (int) – Return media later than this min_id.
• max_id (int) – Return media earlier than this max_id.

Relationship

User.relationship()

Return the resource corresponding to all relationships for the user.

Relationship.get()

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

Relationship.update(action)

Modifies the relationship between the current user and the target user.

Variables:action (str) – One of follow/unfollow/block/unblock/approve/deny.

User.get()

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

Users

Instagram.users()

Return the resource corresponding to all users.

Users.get(query, count=None)

Fetch all users by name.

Variables:

• query (str) – A query string.
• count (int) – Number of users to return.

Intercom

class intercom.Intercom(app_id, api_key)

Create a Intercom service.

Variables:

• app_id (str) – The APP identifier.
• api_key (str) – The API key.

Companies

Intercom.companies()

Return the resource corresponding to all companies.

Companies.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

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

Fetch all of the objects.

Variables:

• page (int) – The page that should be returned. If left as None, first page are returned.
• per_page (int) – How many objects should be returned. The maximum is 500. If left as None, 500 objects are returned.

Company

Intercom.company(id)

Return the resource corresponding to a single company.

Company.get()

Fetch the company’s data.

Company.users()

Fetch the company’s users.

Counts

Intercom.counts()

Return the resource corresponding to all counts.

Counts.get(type=None, count=None)

Get counts of users and companies filtered by certain criteria.

Variables:

• type (str) – The count’s type
• count (str) – The count’s filter criteria

Events

Intercom.events()

Return the resource corresponding to all events.

Events.create(event_name, created_at, user_id=None, email=None, metadata=None)

Create a new Event object.

Variables:

• event_name (str) – The name of the event that occurred.
• created_at (int) – The time the event occurred as a UTC Unix timestamp.
• user_id (int) – The user_id of the user which messages should be returned. Required if no email.
• email (str) – The email of the user which messages that should be returned. Required if no user_id.
• metadata (dict) – Optional metadata about the event.

Impressions

Intercom.impressions()

Return the resource corresponding to all impressions.

Impressions.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

MessageThread

Intercom.message_thread()

Return the resource corresponding to a single message thread.

MessageThread.get(thread_id, user_id=None, email=None)

Fetch all a single object.

Variables:

• thread_id (int) – The thread_id of the message that should be returned.
• user_id (int) – The user_id of the user which message should be returned. Required if no email.
• email (str) – The email of the user which message that should be returned. Required if no user_id.

MessageThreads

Intercom.message_threads()

Return the resource corresponding to all message threads.

MessageThreads.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

MessageThreads.get(user_id=None, email=None)

Fetch all of the objects for the user.

Variables:

• user_id (int) – The user_id of the user which messages should be returned. Required if no email.
• email (str) – The email of the user which messages that should be returned. Required if no user_id.

MessageThreads.reply(obj)

Reply to a message thread from an admin from a user

User

Intercom.user()

Return the resource corresponding to a single user.

User.get(user_id=None, email=None)

Fetch the object’s data.

Variables:

• user_id (int) – The user_id of the user that should be returned. Required if no email.
• email (str) – The email of the user that should be returned. Required if no user_id.

Users

Intercom.users()

Return the resource corresponding to all users.

Users.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

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

Fetch all of the objects.

Variables:

• page (int) – The page that should be returned. If left as None, first page are returned.
• per_page (int) – How many objects should be returned. The maximum is 500. If left as None, 500 objects are returned.

Users.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Mailchimp

class mailchimp.Mailchimp(api_key)

Create a Mailchimp service.

Variables:api_key (str) – The API key including the region, for instance 8ac789caf98879caf897a678fa76daf-us2.

Service methods

Mailchimp.apikeyAdd(username, password)

Call Mailchimp’s apikeyAdd method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/apikeyadd.func.php

Mailchimp.apikeyExpire(username, password)

Call Mailchimp’s apikeyExpire method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/apikeyexpire.func.php

Mailchimp.apikeys(username, password, apikey, expired=False)

Call Mailchimp’s apikeys method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/apikeys.func.php

Mailchimp.campaignAbuseReports(cid, since=None, start=None, limit=None)

Call Mailchimp’s campaignAbuseReports method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignabusereports.func.php

Mailchimp.campaignAdvice(cid)

Call Mailchimp’s campaignAdvice method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignadvice.func.php

Mailchimp.campaignAnalytics(cid)

Call Mailchimp’s campaignAnalytics method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignanalytics.func.php

Mailchimp.campaignBounceMessage(cid, email)

Call Mailchimp’s campaignBounceMessage method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignbouncemessage.func.php

Mailchimp.campaignBounceMessages(cid, start=None, limit=None, since=None)

Call Mailchimp’s campaignBounceMessages method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignbouncemessages.func.php

Mailchimp.campaignClickDetailAIM(cid, url, start=None, limit=None)

Call Mailchimp’s campaignClickDetailAIM method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignclickdetailaim.func.php

Mailchimp.campaignClickStats(cid)

Call Mailchimp’s campaignClickStats method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignclickstats.func.php

Mailchimp.campaignContent(cid, for_archive=True)

Call Mailchimp’s campaignContent method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaigncontent.func.php

Mailchimp.campaignCreate(type, options, content, segment_opts={}, type_opts={})

Call Mailchimp’s campaignCreate method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaigncreate.func.php

Mailchimp.campaignDelete(cid)

Call Mailchimp’s campaignDelete method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaigndelete.func.php

Mailchimp.campaignEcommOrderAdd(order)

Call Mailchimp’s campaignEcommOrderAdd method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignecommorderadd.func.php

Mailchimp.campaignEcommOrders(cid, start=None, limit=None, since=None)

Call Mailchimp’s campaignEcommOrders method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignecommorders.func.php

Mailchimp.campaignEepUrlStats(cid)

Call Mailchimp’s campaignEepUrlStats method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaigneepurlstats.func.php

Mailchimp.campaignEmailStatsAIM(cid, email_address=[])

Call Mailchimp’s campaignEmailStatsAIM method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignemailstatsaim.func.php

Mailchimp.campaignGeoOpens(cid)

Call Mailchimp’s campaignGeoOpens method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaigngeoopens.func.php

Mailchimp.campaignGeoOpensForCountry(cid, code)

Call Mailchimp’s campaignGeoOpensForCountry method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaigngeoopensforcountry.func.php

Mailchimp.campaignMembers(cid, status=None, start=None, limit=None)

Call Mailchimp’s campaignMembers method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignmembers.func.php

Mailchimp.campaignNotOpenedAIM(cid, start=None, limit=None)

Call Mailchimp’s campaignNotOpenedAIM method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignnotopenedaim.func.php

Mailchimp.campaignOpenedAIM(cid, start=None, limit=None)

Call Mailchimp’s campaignOpenedAIM method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignopenedaim.func.php

Mailchimp.campaignPause(cid)

Call Mailchimp’s campaignPause method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignpause.func.php

Mailchimp.campaignReplicate(cid)

Call Mailchimp’s campaignReplicate method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignreplicate.func.php

Mailchimp.campaignResume(cid)

Call Mailchimp’s campaignResume method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignresume.func.php

Mailchimp.campaignSchedule(cid, schedule_time, schedule_time_b=None)

Call Mailchimp’s campaignSchedule method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignschedule.func.php

Mailchimp.campaignSegmentTest(list_id, options={})

Call Mailchimp’s campaignSegmentTest method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignsegmenttest.func.php

Mailchimp.campaignSendNow(cid)

Call Mailchimp’s campaignSendNow method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignsendnow.func.php

Mailchimp.campaignSendTest(cid, test_emails=[], send_type=None)

Call Mailchimp’s campaignSendTest method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignsendtest.func.php

Mailchimp.campaignShareReport(cid, opts={})

Call Mailchimp’s campaignShareReport method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignsharereport.func.php

Mailchimp.campaignStats(cid)

Call Mailchimp’s campaignStats method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignstats.func.php

Mailchimp.campaignTemplateContent(cid)

Call Mailchimp’s campaignTemplateContent method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaigntemplatecontent.func.php

Mailchimp.campaignUnschedule(cid)

Call Mailchimp’s campaignUnschedule method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignunschedule.func.php

Mailchimp.campaignUnsubscribes(cid, start=None, limit=None)

Call Mailchimp’s campaignUnsubscribes method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignunsubscribes.func.php

Mailchimp.campaignUpdate(cid, name, value)

Call Mailchimp’s campaignUpdate method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignupdate.func.php

Mailchimp.campaigns(filters={}, start=None, limit=None)

Call Mailchimp’s campaigns method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaigns.func.php

Mailchimp.campaignsForEmail(email_address, options={})

Call Mailchimp’s campaignsForEmail method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/campaignsforemail.func.php

Mailchimp.chimpChatter()

Call Mailchimp’s chimpChatter method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/chimpchatter.func.php

Mailchimp.ecommOrderAdd(order={})

Call Mailchimp’s ecommOrderAdd method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/ecommorderadd.func.php

Mailchimp.ecommOrderDel(store_id, order_id)

Call Mailchimp’s ecommOrderDel method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/ecommorderdel.func.php

Mailchimp.ecommOrders(start=None, limit=None, since=None)

Call Mailchimp’s ecommOrders method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/ecommorders.func.php

Mailchimp.folderAdd(name, type=None)

Call Mailchimp’s folderAdd method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/folderadd.func.php

Mailchimp.folderDel(fid, type=None)

Call Mailchimp’s folderDel method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/folderdel.func.php

Mailchimp.folderUpdate(fid, name, type=None)

Call Mailchimp’s folderUpdate method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/folderupdate.func.php

Mailchimp.folders(type=None)

Call Mailchimp’s folders method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/folders.func.php

Mailchimp.generateText(type, content)

Call Mailchimp’s generateText method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/generatetext.func.php

Mailchimp.getAccountDetails()

Call Mailchimp’s getAccountDetails method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/getaccountdetails.func.php

Mailchimp.gmonkeyActivity()

Call Mailchimp’s gmonkeyActivity method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/gmonkeyactivity.func.php

Mailchimp.gmonkeyAdd(cid, id, email_address=[])

Call Mailchimp’s gmonkeyAdd method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/gmonkeyadd.func.php

Mailchimp.gmonkeyDel(cid, id, email_address=[])

Call Mailchimp’s gmonkeyDel method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/gmonkeydel.func.php

Mailchimp.gmonkeyMembers()

Call Mailchimp’s gmonkeyMembers method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/gmonkeymembers.func.php

Mailchimp.inlineCss(html, strip_css=False)

Call Mailchimp’s inlineCss method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/inlinecss.func.php

Mailchimp.listAbuseReports(id, start=None, limit=None, since=None)

Call Mailchimp’s listAbuseReports method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listabusereports.func.php

Mailchimp.listActivity(id)

Call Mailchimp’s listActivity method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listactivity.func.php

Mailchimp.listBatchSubscribe(id, batch=[], double_optin=True, update_existing=False, replace_interests=True)

Call Mailchimp’s listBatchSubscribe method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listbatchsubscribe.func.php

Mailchimp.listBatchUnsubscribe(id, emails=[], delete_member=False, send_goodbye=True, send_notify=False)

Call Mailchimp’s listBatchUnsubscribe method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listbatchunsubscribe.func.php

Mailchimp.listClients(id)

Call Mailchimp’s listClients method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listclients.func.php

Mailchimp.listGrowthHistory(id)

Call Mailchimp’s listGrowthHistory method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listgrowthhistory.func.php

Mailchimp.listInterestGroupAdd(id, group_name, grouping_id=None)

Call Mailchimp’s listInterestGroupAdd method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listinterestgroupadd.func.php

Mailchimp.listInterestGroupDel(id, group_name, grouping_id=None)

Call Mailchimp’s listInterestGroupDel method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listinterestgroupdel.func.php

Mailchimp.listInterestGroupUpdate(id, old_name, new_name, grouping_id=None)

Call Mailchimp’s listInterestGroupUpdate method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listinterestgroupupdate.func.php

Mailchimp.listInterestGroupingAdd(id, name, type, groups=[])

Call Mailchimp’s listInterestGroupingAdd method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listinterestgroupingadd.func.php

Mailchimp.listInterestGroupingDel(grouping_id)

Call Mailchimp’s listInterestGroupingDel method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listinterestgroupingdel.func.php

Mailchimp.listInterestGroupingUpdate(grouping_id, name, value)

Call Mailchimp’s listInterestGroupingUpdate method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listinterestgroupingupdate.func.php

Mailchimp.listInterestGroupings(id)

Call Mailchimp’s listInterestGroupings method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listinterestgroupings.func.php

Mailchimp.listLocations(id)

Call Mailchimp’s listLocations method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listlocations.func.php

Mailchimp.listMemberActivity(id, email_address=[])

Call Mailchimp’s listMemberActivity method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listmemberactivity.func.php

Mailchimp.listMemberInfo(id, email_address=[])

Call Mailchimp’s listMemberInfo method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listmemberinfo.func.php

Mailchimp.listMembers(id, status='subscribed', since=None, start=None, limit=None)

Call Mailchimp’s listMembers method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listmembers.func.php

Mailchimp.listMergeVarAdd(id, tag, name, options={})

Call Mailchimp’s listMergeVarAdd method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listmergevaradd.func.php

Mailchimp.listMergeVarDel(id, tag)

Call Mailchimp’s listMergeVarDel method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listmergevardel.func.php

Mailchimp.listMergeVarUpdate(id, tag, options={})

Call Mailchimp’s listMergeVarUpdate method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listmergevarupdate.func.php

Mailchimp.listMergeVars(id)

Call Mailchimp’s listMergeVars method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listmergevars.func.php

Mailchimp.listStaticSegmentAdd(id, name)

Call Mailchimp’s listStaticSegmentAdd method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/liststaticsegmentadd.func.php

Mailchimp.listStaticSegmentDel(id, seg_id)

Call Mailchimp’s listStaticSegmentDel method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/liststaticsegmentdel.func.php

Mailchimp.listStaticSegmentMembersAdd(id, seg_id, batch=[])

Call Mailchimp’s listStaticSegmentMembersAdd method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/liststaticsegmentmembersadd.func.php

Mailchimp.listStaticSegmentMembersDel(id, seg_id, batch=[])

Call Mailchimp’s listStaticSegmentMembersDel method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/liststaticsegmentmembersdel.func.php

Mailchimp.listStaticSegmentReset(id, seg_id)

Call Mailchimp’s listStaticSegmentReset method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/liststaticsegmentreset.func.php

Mailchimp.listStaticSegments(id)

Call Mailchimp’s listStaticSegments method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/liststaticsegments.func.php

Mailchimp.listSubscribe(id, email_address, merge_vars={}, email_type='html', double_optin=True, update_existing=False, replace_interests=True, send_welcome=False)

Call Mailchimp’s listSubscribe method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listsubscribe.func.php

Mailchimp.listUnsubscribe(id, email_address, delete_member=False, send_goodbye=True, send_notify=True)

Call Mailchimp’s listUnsubscribe method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listunsubscribe.func.php

Mailchimp.listUpdateMember(id, email_address, merge_vars={}, email_type=None, replace_interests=True)

Call Mailchimp’s listUpdateMember method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listupdatemember.func.php

Mailchimp.listWebhookAdd(id, url, actions={}, sources={})

Call Mailchimp’s listWebhookAdd method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listwebhookadd.func.php

Mailchimp.listWebhookDel(id, url)

Call Mailchimp’s listWebhookDel method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listwebhookdel.func.php

Mailchimp.listWebhooks(id)

Call Mailchimp’s listWebhooks method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listwebhooks.func.php

Mailchimp.lists(filters={}, start=None, limit=None)

Call Mailchimp’s lists method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/lists.func.php

Mailchimp.listsForEmail(email_address)

Call Mailchimp’s listsForEmail method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/listsforemail.func.php

Mailchimp.ping()

Call Mailchimp’s ping method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/ping.func.php

Mailchimp.templateAdd(name, html)

Call Mailchimp’s templateAdd method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/templateadd.func.php

Mailchimp.templateDel(id)

Call Mailchimp’s templateDel method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/templatedel.func.php

Mailchimp.templateInfo(tid, type='user')

Call Mailchimp’s templateInfo method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/templateinfo.func.php

Mailchimp.templateUndel(id)

Call Mailchimp’s templateUndel method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/templateundel.func.php

Mailchimp.templateUpdate(id, values={})

Call Mailchimp’s templateUpdate method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/templateupdate.func.php

Mailchimp.templates(types=None, category=None, inactives=None)

Call Mailchimp’s templates method.

Upstream documentation: http://apidocs.mailchimp.com/api/rtfm/templates.func.php

Mixpanel

class mixpanel.Mixpanel(token=None, api_key=None, api_secret=None)

Create a Mixpanel service.

Variables:

• token (str or None) – Optional token used for tracking events. If you leave this as None, you won’t be able to track events through this service object.
• api_key (str or None) – Optional API key. If you leave this as None, you won’t be able to export data through this service object.
• api_secret (str or None) – Optional API secret. If you leave this as None, you won’t be able to export data through this service object.

Events

Mixpanel.events()

Return the resource corresponding to events.

Events.get(event, type, unit, interval)

Fetch event data.

Upstream documentation: https://mixpanel.com/docs/api-documentation/data-export-api#events-default

Events.names(type, limit=None)

Fetch the most common events over the last 31 days.

Upstream documentation: https://mixpanel.com/docs/api-documentation/data-export-api#events-names

Events.top(type, limit=None)

Fetch the top events for today.

Upstream documentation: https://mixpanel.com/docs/api-documentation/data-export-api#events-top

Funnels

Mixpanel.funnels()

Return the resource corresponding to funnels.

Funnels.get(funnel_id, from_date=None, to_date=None, length=None, interval=None, unit=None, on=None, where=None, limit=None)

Fetch data for a funnel.

Upstream documentation: https://mixpanel.com/docs/api-documentation/data-export-api#funnels-default

Funnels.list()

Fetch the list of all funnels.

Upstream documentation: https://mixpanel.com/docs/api-documentation/data-export-api#funnels-list

Properties

Mixpanel.properties()

Return the resource corresponding to events properties.

Properties.get(event, name, type, unit, interval, values=None, limit=None)

Fetch data of a single event.

Upstream documentation: https://mixpanel.com/docs/api-documentation/data-export-api#event-properties-default

Properties.top(event, limit=None)

Fetch top property names for an event.

Upstream documentation: https://mixpanel.com/docs/api-documentation/data-export-api#event-properties-top

Properties.values(event, name, limit=None, bucket=None)

Fetch top values for a property.

Upstream documentation: https://mixpanel.com/docs/api-documentation/data-export-api#event-properties-values

Retention

Mixpanel.retention()

Return the resource corresponding to retention (cohort analysis).

Retention.get(from_date, to_date, retention_type=None, born_event=None, event=None, born_Where=None, where=None, interval=None, interval_count=None, unit=None, on=None, limit=None)

Fetch cohort analysis.

Upstream documentation: https://mixpanel.com/docs/api-documentation/data-export-api#retention-default

Segmentation

Mixpanel.segmentation()

Return the resource corresponding to segmentation.

Segmentation.average(event, from_date, to_date, on, unit=None, where=None)

Fetch the average of an expression for an event per time unit.

Upstream documentation: https://mixpanel.com/docs/api-documentation/data-export-api#segmentation-average

Segmentation.get(event, from_date, to_date, on=None, unit=None, where=None, limit=None, type=None)

Fetch segmented and filtered data for an event.

Upstream documentation: https://mixpanel.com/docs/api-documentation/data-export-api#segmentation-default

Segmentation.multiseg(event, type, from_date, to_date, inner, outer, limit=None, unit=None)

Fetch the average of an expression for an event per time unit.

Upstream documentation: https://mixpanel.com/docs/api-documentation/data-export-api#segmentation-multiseg

Segmentation.numeric(event, from_date, to_date, on, buckets, unit=None, where=None, type=None)

Fetch segmented and filtered data for an event, sorted into numeric buckets.

Upstream documentation: https://mixpanel.com/docs/api-documentation/data-export-api#segmentation-numeric

Segmentation.sum(event, from_date, to_date, on, unit=None, where=None)

Fetch the sum of an expression for an event per time unit.

Upstream documentation: https://mixpanel.com/docs/api-documentation/data-export-api#segmentation-sum

Service methods

Mixpanel.engage(distinct_id, data)

Store people properties

Upstream documentation: https://mixpanel.com/docs/people-analytics/people-http-specification-insert-data

Variables:properties (dict) – The user properties, your access token will be inserted into it automatically. Returns:A boolean that tells if the event has been logged.

Mixpanel.export(from_date, to_date, event=None, where=None, bucket=None)

Export raw data from your account.

Upstream documentation: https://mixpanel.com/docs/api-documentation/exporting-raw-data-you-inserted-into-mixpanel#export

Variables:

• from_date (str) – Query start date, in yyyy-mm-dd format.
• to_date (str) – Query finish date, in yyyy-mm-dd format.
• event (list of str) – Optional list of events to export.
• where (str) – A filter expression.
• bucket (str) – Data bucket to query.

Mixpanel.track(event, properties=None, ip=False, test=False)

Track an event.

Upstream documentation: https://mixpanel.com/docs/api-documentation/http-specification-insert-data

Variables:

• event (str) – The name of the event.
• properties (dict) – The event’s properties, your access token will be inserted into it automatically.
• ip (bool) – Should Mixpanel automatically use the incoming request IP.
• test (bool) – Use a high priority rate limited queue for testing.

Returns:

A boolean that tells if the event has been logged.

MixRank

class mixrank.MixRank(api_key)

Create a MixRank service.

Variables:api_key (str) – The MixRank API key.

Advertiser

MixRank.advertiser(advertiser)

Return the resource corresponding to an advertiser.

Variables:advertiser (str) – The advertiser’s domain name. Use the root domain name; in particular, do not prefix with “www.” or any other subdomain.

DisplayAd

Advertiser.displayad(hash)

Return a resource corresponding to a single display ad.

Variables:hash (str) – A unique hash identifying this ad.

DisplayAd.destinations(offset=None, page_size=None, min_times_seen=None, max_times_seen=None, first_seen_before=None, first_seen_after=None, last_seen_before=None, last_seen_after=None, sort_field=None, sort_order=None)

Fetch the Google Display Network destinations for this ad.

Upstream documentation: http://mixrank.com/api/documentation#displayad_destinations

DisplayAd.publishers(offset=None, page_size=None, min_times_seen=None, max_times_seen=None, first_seen_before=None, first_seen_after=None, last_seen_before=None, last_seen_after=None, sort_field=None, sort_order=None)

Fetch the Google Display Network publishers for this ad.

Upstream documentation: http://mixrank.com/api/documentation#displayad_publishers

TextAd

Advertiser.textad(hash)

Return a resource corresponding to a single text ad.

Variables:hash (str) – A unique hash identifying this ad.

TextAd.destinations(offset=None, page_size=None, min_avg_position=None, max_avg_position=None, min_times_seen=None, max_times_seen=None, first_seen_before=None, first_seen_after=None, last_seen_before=None, last_seen_after=None, sort_field=None, sort_order=None)

Fetch the Google Display Network destinations for this ad.

Upstream documentation: http://mixrank.com/api/documentation#textad_destinations

TextAd.publishers(offset=None, page_size=None, min_times_seen=None, max_times_seen=None, first_seen_before=None, first_seen_after=None, last_seen_before=None, last_seen_after=None, sort_field=None, sort_order=None)

Fetch the Google Display Network publishers for this ad.

Upstream documentation: http://mixrank.com/api/documentation#textad_publishers

Advertiser.displayads(offset=None, page_size=None, min_times_seen=None, max_times_seen=None, first_seen_before=None, first_seen_after=None, last_seen_before=None, last_seen_after=None, sort_field=None, sort_order=None)

Fetch the Google Display Network display ads for this advertiser.

Upstream documentation: http://mixrank.com/api/documentation#advertiser_displayads

Advertiser.keywords(offset=None, page_size=None, min_times_seen=None, max_times_seen=None, first_seen_before=None, first_seen_after=None, last_seen_before=None, last_seen_after=None, sort_field=None, sort_order=None)

Fetch the Google Display Network keywords for this advertiser.

Upstream documentation: http://mixrank.com/api/documentation#advertiser_keywords

Advertiser.publishers(offset=None, page_size=None, min_times_seen=None, max_times_seen=None, min_monthly_uniques=None, max_monthly_uniques=None, last_seen_before=None, last_seen_after=None, sort_field=None, sort_order=None)

Fetch the Google Display Network publishers for this advertiser.

Upstream documentation: http://mixrank.com/api/documentation#advertiser_publishers

Advertiser.summary()

Fetch the advertiser’s summary.

Upstream documentation: http://mixrank.com/api/documentation#advertiser

Advertiser.textads(offset=None, page_size=None, min_avg_position=None, max_avg_position=None, min_times_seen=None, max_times_seen=None, first_seen_before=None, first_seen_after=None, last_seen_before=None, last_seen_after=None, sort_field=None, sort_order=None)

Fetch the Google Display Network text ads for this advertiser.

Upstream documentation: http://mixrank.com/api/documentation#advertiser_textads

Keyword

MixRank.keyword(keyword)

Return the resource corresponding to a keyword.

Variables:keyword (str) – The keyword, can contain spaces.

Keyword.advertisers(offset=None, page_size=None, min_times_seen=None, max_times_seen=None, first_seen_before=None, first_seen_after=None, last_seen_before=None, last_seen_after=None, sort_field=None, sort_order=None)

Fetch the advertisers that show ads for this keyword.

Upstream documentation: http://mixrank.com/api/documentation#keyword_advertisers

Keyword.displayads(offset=None, page_size=None, min_times_seen=None, max_times_seen=None, first_seen_before=None, first_seen_after=None, last_seen_before=None, last_seen_after=None, sort_field=None, sort_order=None)

Fetch the Google Display Network display ads targeting at this keyword.

Upstream documentation: http://mixrank.com/api/documentation#keyword_displayads

Keyword.summary()

Fetch the keyword summary.

Upstream documentation: http://mixrank.com/api/documentation#keyword

Keyword.textads(offset=None, page_size=None, min_avg_position=None, max_avg_position=None, min_times_seen=None, max_times_seen=None, first_seen_before=None, first_seen_after=None, last_seen_before=None, last_seen_after=None, sort_field=None, sort_order=None)

Fetch the Google Display Network text ads targeting this keyword.

Upstream documentation: http://mixrank.com/api/documentation#keyword_textads

Publisher

MixRank.publisher(publisher)

Return the resource corresponding to a publisher.

Variables:publisher (str) – The pubisher’s domain name. Use the root domain name; in particular, do not prefix with “www.” or any other subdomain.

Publisher.advertisers(offset=None, page_size=None, min_times_seen=None, max_times_seen=None, first_seen_before=None, first_seen_after=None, last_seen_before=None, last_seen_after=None, sort_field=None, sort_order=None)

Fetch the advertisers that run ads on this publisher.

Upstream documentation: http://mixrank.com/api/documentation#publisher_advertisers

Publisher.displayads(offset=None, page_size=None, min_times_seen=None, max_times_seen=None, first_seen_before=None, first_seen_after=None, last_seen_before=None, last_seen_after=None, sort_field=None, sort_order=None)

Fetch the Google Display Network display ads for this publisher.

Upstream documentation: http://mixrank.com/api/documentation#publisher_displayads

Publisher.summary()

Fetch the publisher’s summary.

Upstream documentation: http://mixrank.com/api/documentation#publisher

Publisher.textads(offset=None, page_size=None, min_avg_position=None, max_avg_position=None, min_times_seen=None, max_times_seen=None, first_seen_before=None, first_seen_after=None, last_seen_before=None, last_seen_after=None, sort_field=None, sort_order=None)

Fetch the Google Display Network text ads for this publisher.

Upstream documentation: http://mixrank.com/api/documentation#advertiser_textads

Service methods

MixRank.echo()

Verify that the API key is valid.

Mozscape

class mozscape.Mozscape(access_id, secret_key)

Create a Mozscape service.

Variables:

• access_id (str) – Your Mozscape AccessID.
• secret_key (str) – Your Mozscape Secret Key.

Metadata

Mozscape.metadata()

Return the resource responsible for Mozscape Index metadata.

Metadata.index_stats()

Fetch data about the volume of information in the Mozscape Index.

Metadata.last_update()

Fetch the Unix timestamp of the last Mozscape Index update.

Metadata.next_update()

Fetch the Unix timestamp of the next Mozscape Index update.

Service methods

Mozscape.urlmetrics(urls, cols)

Fetch URL metrics for one or more URLs.

Variables:

• urls (str or list of str) – The URLs you’re interested in.
• cols – The sum of column constants for metrics you want to have fetched, taken from libsaas.services.mozscape.constants.

Insights

class newrelic.Insights(account_id, query_key=None, insert_key=None)

Create a New Relic Insights service.

Variables:

• account_id (str) – The account id
• query_key (str) – The query key.
• insert_key (str) – The insert key.

Service methods

Insights.insert(events)

Submit event or events to rubicon

Variables:events – Event data

Upstream documentation: http://docs.newrelic.com/docs/rubicon/inserting-events

Insights.query(nrql)

NRQL query

Variables:nqrl (str) – The nrql query

Upstream documentation: http://docs.newrelic.com/docs/rubicon/using-nrql

Pingdom

class pingdom.Pingdom(username, password, app_key)

Create a Pingdom service.

Variables:

• username (str) – The username for the authenticated user.
• password (str) – The password for the authenticated user.
• app_key (str) – The app_key for the application.

Actions

Pingdom.actions()

Return the resource corresponding to all actions

Actions.get(from_=None, to=None, limit=None, offset=None, checkids=None, contactids=None, status=None, via=None)

Returns a list of actions (alerts) that have been generated for your account.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceActions

Analysis

Pingdom.analysis(checkid)

Return the resource corresponding to the analysis for specified check

Variables:checkid (str) – The check id

Analysis.get(from_=None, to=None, limit=None, offset=None)

Returns a list of the latest root cause analysis results for a specified check.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceAnalysis

Analysis.get_raw_analysis(analysisid)

Get Raw Analysis Results

Variables:analysisid (str) – The specified error analysis id

Check

Pingdom.check(checkid)

Return the resource corresponding to a single check

Variables:checkid (str) – The check id

Analysis

Check.analysis()

Return the resource corresponding to the analysis for the check.

Analysis.get(from_=None, to=None, limit=None, offset=None)

Returns a list of the latest root cause analysis results for a specified check.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceAnalysis

Analysis.get_raw_analysis(analysisid)

Get Raw Analysis Results

Variables:analysisid (str) – The specified error analysis id

Results

Check.results()

Return the resource corresponding to the results for the check.

Results.get(from_=None, to=None, limit=None, offset=None, probes=None, status=None, includeanalysis=None, maxresponse=None, minresponse=None)

Return a list of raw test results for a specified check

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceResults

Summary

Check.summary()

Return the resource corresponding to the summary for the check.

Summary.average(from_=None, to=None, probes=None, includeuptime=None, bycountry=None, byprobe=None)

Get the average time / uptime value for a specified check and time period.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.average

Summary.hoursofday(from_=None, to=None, probes=None, uselocaltime=None)

Returns the average response time for each hour of the day (0-23) for a specific check over a selected time period. I.e. it shows you what an average day looks like during that time period.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.hoursofday

Summary.outage(from_=None, to=None, order=None)

Get a list of status changes for a specified check and time period. If order is speficied to descending, the list is ordered by newest first. (Default is ordered by oldest first.)

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.outage

Summary.performance(from_=None, to=None, resolution=None, includeuptime=None, probes=None, order=None)

For a given interval in time, return a list of sub intervals with the given resolution. Useful for generating graphs. A sub interval may be a week, a day or an hour depending on the choosen resolution.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.performance

Summary.probes(from_=None, to=None)

Get a list of probes that performed tests for a specified check during a specified period.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.probes

Check.delete()

Deletes a check. You will lose all collected data.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodDelete+Check

Check.get()

Returns a detailed description of a specified check.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodGet+Detailed+Check+Information

Check.update(obj)

Modify settings for a check. The provided settings will overwrite previous values. Settings not provided will stay the same as before the update. To clear an existing value, provide an empty value. Please note that you cannot change the type of a check once it has been created.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/MethodModify+Check

Checks

Pingdom.checks()

Return the resource corresponding to all checks

Checks.create(obj)

Creates a new check with settings specified by provided parameters.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodCreate+New+Check

Checks.delete()

Deletes a list of checks. You will lose all collected data.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodDelete+Multiple+Checks

Checks.get(limit=None, offset=None)

Returns a list overview of all checks.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceChecks

Checks.update(obj)

Pause or change resolution for multiple checks in one bulk call.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodModify+Multiple+Checks

Contact

Pingdom.contact(contactid)

Return the resource corresponding to a single contact

Variables:contactid (str) – The contact id

Contact.delete()

Deletes a contact.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodDelete+Contact

Contact.update(obj)

Modify a contact.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/MethodModify+Contact

Contacts

Pingdom.contacts()

Return the resource corresponding to all contacts

Contacts.create(obj)

Creates a new contact with settings specified by provided parameters.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodCreate+Contact

Contacts.delete()

Deletes a list of contacts.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodDelete+Multiple+Contacts

Contacts.get(limit=None, offset=None)

Returns a list of all contacts.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceContacts

Contacts.update(obj)

Modifies a list of contacts.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodModify+Multiple+Contacts

Credits

Pingdom.credits()

Return the resource corresponding to all credits

Credits.get()

Returns information about remaining checks, SMS credits and SMS auto-refill status.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceCredits

Probes

Pingdom.probes()

Return the resource corresponding to all probes

Probes.get(limit=None, offset=None, onlyactive=None, includedeleted=None)

Returns a list of all Pingdom probe servers.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceProbes

Reference

Pingdom.reference()

Return the resource corresponding to the reference of regions

Reference.get()

Get a reference of regions, timezones and date/time/number formats and their identifiers.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceReference

ReportsEmail

Pingdom.report_email(reportid)

Return the resource corresponding to a single email report

Variables:reportid (str) – The report id

ReportsEmail.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsEmail.delete()

Delete this resource.

ReportsEmail.get()

ReportsEmail.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsPublic

Pingdom.report_public(reportid)

Return the resource corresponding to a single public report

Variables:reportid (str) – The report id

ReportsPublic.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsPublic.delete()

Delete this resource.

ReportsPublic.get()

ReportsPublic.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsShared

Pingdom.report_shared(reportid)

Return the resource corresponding to a single shared report

Variables:reportid (str) – The report id

ReportsShared.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsShared.delete()

Delete this resource.

ReportsShared.get()

ReportsShared.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsEmail

Pingdom.reports_email()

Return the resource corresponding to the email reports

ReportsEmail.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsEmail.delete()

Delete this resource.

ReportsEmail.get()

ReportsEmail.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsPublic

Pingdom.reports_public()

Return the resource corresponding to the public reports

ReportsPublic.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsPublic.delete()

Delete this resource.

ReportsPublic.get()

ReportsPublic.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsShared

Pingdom.reports_shared()

Return the resource corresponding to the shared reports

ReportsShared.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ReportsShared.delete()

Delete this resource.

ReportsShared.get()

ReportsShared.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Results

Pingdom.results(checkid)

Return the resource corresponding to the raw test results for a specified check

Variables:checkid (str) – The check id

Results.get(from_=None, to=None, limit=None, offset=None, probes=None, status=None, includeanalysis=None, maxresponse=None, minresponse=None)

Return a list of raw test results for a specified check

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceResults

Servertime

Pingdom.servertime()

Return the resource corresponding to the servertime

Servertime.get()

Get the current time of the API server.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceServertime

Settings

Pingdom.settings()

Return the resource corresponding to the settings

Settings.get()

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

Settings.update(obj)

Modify account-specific settings.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#MethodModify+Account+Settings

Single

Pingdom.single()

Return the resource corresponding to the single test

Single.get(**params)

Performs a single test using a specified Pingdom probe against a specified target. Please note that this method is meant to be used sparingly, not to set up your own monitoring solution.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSingle

Summary

Pingdom.summary(checkid)

Return the resource corresponding to the summary for a specified check.

Variables:checkid (str) – The check id

Summary.average(from_=None, to=None, probes=None, includeuptime=None, bycountry=None, byprobe=None)

Get the average time / uptime value for a specified check and time period.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.average

Summary.hoursofday(from_=None, to=None, probes=None, uselocaltime=None)

Returns the average response time for each hour of the day (0-23) for a specific check over a selected time period. I.e. it shows you what an average day looks like during that time period.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.hoursofday

Summary.outage(from_=None, to=None, order=None)

Get a list of status changes for a specified check and time period. If order is speficied to descending, the list is ordered by newest first. (Default is ordered by oldest first.)

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.outage

Summary.performance(from_=None, to=None, resolution=None, includeuptime=None, probes=None, order=None)

For a given interval in time, return a list of sub intervals with the given resolution. Useful for generating graphs. A sub interval may be a week, a day or an hour depending on the choosen resolution.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.performance

Summary.probes(from_=None, to=None)

Get a list of probes that performed tests for a specified check during a specified period.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceSummary.probes

Traceroute

Pingdom.traceroute()

Return the resource corresponding to the traceroute test

Traceroute.get(host=None, probeid=None)

Perform a traceroute to a specified target from a specified Pingdom probe.

Upstream documentation: https://www.pingdom.com/services/api-documentation-rest/#ResourceTraceroute

Pipedrive

class pipedrive.Pipedrive(api_token)

Create a Pipedrive service.

Variables:api_token (str) – The API token

Activities

Pipedrive.activities()

Return the resource corresponding to all activities

Activities.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Activities.delete(ids)

Marks multiple activities as deleted.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Activities

Activities.get(user_id=None, start=None, limit=None, start_date=None, end_date=None)

Returns all activities assigned to a particular user

Upstream documentation: https://developers.pipedrive.com/v1#methods-Activities

Activities.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Activity

Pipedrive.activity(activity_id)

Return the resource corresponding to a single activity

Variables:activity_id (str) – The activity id

Activity.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Activity.delete()

Delete this resource.

Activity.get()

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

Activity.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ActivityType

Pipedrive.activity_type(type_id)

Return the resource corresponding to a single activity type

Variables:type_id (str) – The activity type id

ActivityType.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ActivityType.delete()

Delete this resource.

ActivityType.get()

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

ActivityType.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ActivityTypes

Pipedrive.activity_types()

Return the resource corresponding to all activity types

ActivityTypes.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ActivityTypes.delete(ids)

Marks multiple activities as deleted.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Activities

ActivityTypes.get()

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

ActivityTypes.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Authorizations

Pipedrive.authorizations()

Return the resource corresponding to the user authorizations

Authorizations.get(email, password)

Returns all authorizations for a particular user. Authorization objects contain the API tokens the user has with different company accounts in Pipedrive.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Authorizations

Filter

Pipedrive.condition_filter(filter_id)

Return the resource corresponding to a single filter

Variables:filter_id (str) – The filter id

Filter.delete()

Delete this resource.

Filter.get()

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

Filters

Pipedrive.condition_filters()

Return the resource corresponding to all filters

Filters.delete(ids)

Marks multiple filters as deleted.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Filters

Filters.get(type=None)

Returns all filters.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Filters

Currencies

Pipedrive.currencies()

Return the resource corresponding to the deals currencies

Currencies.get(term=None)

Returns all supported currencies which should be used when saving monetary values with other objects. The ‘code’ parameter of the returning objects is the currency code according to ISO 4217.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Currencies

Deal

Pipedrive.deal(deal_id)

Return the resource corresponding to a single deal

Variables:deal_id (str) – The deal id

Products

Deal.products()

Returns the resource corresponding to the deal products

Products.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Products.delete(product_attachment_id)

Deletes a product attachment from a deal, using the product_attachment_id.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals

Products.get(start=None, limit=None)

Lists products attached to a deal.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals

Products.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Deal.activities(start=None, limit=None, done=None, exclude=None)

Lists activities associated with a deal.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals

Deal.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Deal.delete()

Delete this resource.

Deal.files(start=None, limit=None)

Lists files associated with a deal.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals

Deal.followers()

Lists the followers of a deal.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals

Deal.get()

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

Deal.participants(start=None, limit=None)

Lists participants associated with a deal.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals

Deal.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Deal.updates(start=None, limit=None)

Lists updates about a deal.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals

DealField

Pipedrive.deal_field(field_id)

Return the resource corresponding to a single deal field

Variables:field_id (str) – The deal field id

DealField.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

DealField.delete()

Delete this resource.

DealField.get()

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

DealFields

Pipedrive.deal_fields()

Return the resource corresponding to all deal fields

DealFields.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

DealFields.delete(ids)

Marks multiple activities as deleted.

Upstream documentation: https://developers.pipedrive.com/v1#methods-DealFields

DealFields.get()

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

Deals

Pipedrive.deals()

Return the resource corresponding to all deals

Deals.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Deals.delete(ids)

Marks multiple deals as deleted.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals

Deals.find(term)

Searches all deals by their title.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals

Deals.get(filter_id=None, start=None, limit=None, sort_by=None, sort_mode=None, owned_by_you=None)

Returns all deals

Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals

Deals.timeline(start_date, interval, amount, field_key, user_id=None, pipeline_id=None, filter_id=None)

Returns open and won deals, grouped by defined interval of time set in a date-type dealField (field_key) - e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups - January, February and March - based on the value of the given field_key.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals

Deals.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

File

Pipedrive.file(file_id)

Return the resource corresponding to a single file

Variables:file_id (str) – The file id

File.delete()

Delete this resource.

File.get()

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

File.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Files

Pipedrive.files()

Return the resource corresponding to all files

Files.delete()

Delete this resource.

Files.get(start=None, limit=None)

Returns data about all files.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Files

Files.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Goal

Pipedrive.goal(goal_id)

Return the resource corresponding to a single goal

Variables:goal_id (str) – The goal id

Goal.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Goal.delete()

Delete this resource.

Goal.get()

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

Goal.results(period_start=None, period_end=None)

Lists results of a specific goal.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Goals

Goal.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Goals

Pipedrive.goals()

Return the resource corresponding to all goals

Goals.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Goals.delete()

Delete this resource.

Goals.get()

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

Goals.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Note

Pipedrive.note(note_id)

Return the resource corresponding to a single note

Variables:note_id (str) – The note id

Note.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Note.delete()

Delete this resource.

Note.get()

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

Note.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Notes

Pipedrive.notes()

Return the resource corresponding to all notes

Notes.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Notes.delete()

Delete this resource.

Notes.get(user_id=None, deal_id=None, person_id=None, org_id=None, start=None, limit=None, sort_by=None, sort_mode=None, start_date=None, end_date=None)

Returns all notes.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Notes

Notes.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Organization

Pipedrive.organization(organization_id)

Return the resource corresponding to a single organization

Variables:organization_id (str) – The organization id

Organization.activities(start=None, limit=None, done=None, exclude=None)

Lists activities associated with an organization.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations

Organization.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Organization.deals(start=None, limit=None)

Lists deals associated with an organization.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations

Organization.delete()

Delete this resource.

Organization.files(start=None, limit=None)

Lists files associated with an organization.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations

Organization.followers()

Lists the followers of an organization.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations

Organization.get()

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

Organization.merge(merge_with_id)

Merges an organization with another organization.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations

Organization.persons(start=None, limit=None)

Lists the persons of an organization.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations

Organization.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Organization.updates(start=None, limit=None)

Lists updates about an organization.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations

OrganizationField

Pipedrive.organization_field(field_id)

Return the resource corresponding to a single organization field

Variables:field_id (str) – The organization field id

OrganizationField.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

OrganizationField.delete()

Delete this resource.

OrganizationField.get()

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

OrganizationFields

Pipedrive.organization_fields()

Return the resource corresponding to all organization fields

OrganizationFields.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

OrganizationFields.delete(ids)

Marks multiple activities as deleted.

Upstream documentation: https://developers.pipedrive.com/v1#methods-OrganizationFields

OrganizationFields.get()

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

Organizations

Pipedrive.organizations()

Return the resource corresponding to all organizations

Organizations.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Organizations.delete(ids)

Marks multiple organizations as deleted.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations

Organizations.find(term, start=None, limit=None)

Searches all organizations by their name.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations

Organizations.get(filter_id=None, start=None, limit=None, sort_by=None, sort_mode=None)

Returns all organizations

Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations

Organizations.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Person

Pipedrive.person(person_id)

Return the resource corresponding to a single person

Variables:person_id (str) – The person id

Person.activities(start=None, limit=None, done=None, exclude=None)

Lists activities associated with a person.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons

Person.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Person.deals(start=None, limit=None)

Lists deals associated with a person.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons

Person.delete()

Delete this resource.

Person.files(start=None, limit=None)

Lists files associated with a person.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons

Person.followers()

Lists the followers of a person.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons

Person.get()

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

Person.merge(merge_with_id)

Merges a person with another person.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons

Person.products(start=None, limit=None)

Lists the products of a person.

Upstream documentation: https://developers.pipedrive.com/v1#methods-products

Person.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Person.updates(start=None, limit=None)

Lists updates about a person.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons

PersonField

Pipedrive.person_field(field_id)

Return the resource corresponding to a single person field

Variables:field_id (str) – The person field id

PersonField.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PersonField.delete()

Delete this resource.

PersonField.get()

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

PersonFields

Pipedrive.person_fields()

Return the resource corresponding to all person fields

PersonFields.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

PersonFields.delete(ids)

Marks multiple activities as deleted.

Upstream documentation: https://developers.pipedrive.com/v1#methods-PersonFields

PersonFields.get()

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

Persons

Pipedrive.persons()

Return the resource corresponding to all persons

Persons.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Persons.delete(ids)

Marks multiple persons as deleted.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons

Persons.find(term, org_id=None, start=None, limit=None)

Searches all persons by their name.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons

Persons.get(filter_id=None, start=None, limit=None, sort_by=None, sort_mode=None)

Returns all persons

Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons

Persons.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Pipeline

Pipedrive.pipeline(pipeline_id)

Return the resource corresponding to a single pipeline

Variables:pipeline_id (str) – The pipeline id

Pipeline.conversion_rates(start_date, end_date, user_id=None)

Returns all stage-to-stage conversion and pipeline-to-close rates for given time period.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Pipelines

Pipeline.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Pipeline.deals(filter_id=None, user_id=None, everyone=None, stage_id=None, start=None, limit=None)

Lists deals in a specific pipeline across all its stages.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Pipelines

Pipeline.delete()

Delete this resource.

Pipeline.get()

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

Pipeline.movements(start_date, end_date, user_id=None)

Returns statistics for deals movements for given time period.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Pipelines

Pipeline.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Pipelines

Pipedrive.pipelines()

Return the resource corresponding to all pipelines

Pipelines.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Pipelines.delete()

Delete this resource.

Pipelines.get()

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

Pipelines.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Product

Pipedrive.product(product_id)

Return the resource corresponding to a single product

Variables:product_id (str) – The product id

Product.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Product.deals(start=None, limit=None)

Returns data about a deals that have a product attached to.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Products

Product.delete()

Delete this resource.

Product.get()

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

Product.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ProductField

Pipedrive.product_field(field_id)

Return the resource corresponding to a single product field

Variables:field_id (str) – The product field id

ProductField.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ProductField.delete()

Delete this resource.

ProductField.get()

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

ProductFields

Pipedrive.product_fields()

Return the resource corresponding to all product fields

ProductFields.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

ProductFields.delete(ids)

Marks multiple activities as deleted.

Upstream documentation: https://developers.pipedrive.com/v1#methods-ProductFields

ProductFields.get()

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

Products

Pipedrive.products()

Return the resource corresponding to all products

Products.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Products.delete()

Delete this resource.

Products.find(term, currency=None, start=None, limit=None)

Returns data about the products that were found. If currency was set in request, prices in that currency are served back.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Products

Products.get(start=None, limit=None)

Returns all products

Upstream documentation: https://developers.pipedrive.com/v1#methods-Products

Products.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Stage

Pipedrive.stage(stage_id)

Return the resource corresponding to a single stage

Variables:stage_id (str) – The stage id

Stage.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Stage.deals(filter_id=None, user_id=None, everyone=None, start=None, limit=None)

Lists deals in a specific stage

Upstream documentation: https://developers.pipedrive.com/v1#methods-Stages

Stage.delete()

Delete this resource.

Stage.get()

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

Stage.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Stages

Pipedrive.stages()

Return the resource corresponding to all stages

Stages.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Stages.delete(ids)

Marks multiple stages as deleted.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Stages

Stages.get(pipeline_id=None)

Returns data about all stages

Upstream documentation: https://developers.pipedrive.com/v1#methods-Stages

Stages.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

User

Pipedrive.user(user_id)

Return the resource corresponding to a single user

Variables:user_id (str) – The user id

User.activities(start=None, limit=None, done=None, exclude=None)

Lists activities associated with a user.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Users

User.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

User.followers()

Lists the followers of a user.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Users

User.get()

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

User.merge(merge_with_id)

Merges a user with another user.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Users

User.updates(start=None, limit=None)

Lists updates about a user.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Users

UserConnections

Pipedrive.user_connections()

Return the resource corresponding to the user connections

UserConnections.get()

Returns data about all connections for the authorized user.

Upstream documentation: https://developers.pipedrive.com/v1#methods-UserConnections

Users

Pipedrive.users()

Return the resource corresponding to all users

Users.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Users.find(term)

Searches all users by their name.

Upstream documentation: https://developers.pipedrive.com/v1#methods-Users

Users.get()

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

Service methods

Pipedrive.search(term, start=None, limit=None)

Performs a search across the account and returns SearchResults.

Upstream documentation: https://developers.pipedrive.com/v1#methods-SearchResults

Pipedrive.settings()

Lists settings of authorized user.

Upstream documentation: https://developers.pipedrive.com/v1#methods-UserSettings

Recurly

class recurly.Recurly(api_key)

Create a Recurly service.

Variables:api_key (str) – The API key including.

Account

Recurly.account(account_code)

Return the resource corresponding to a single account.

AccountAdjustments

Account.adjustments()

Return the resource corresponding to all charges and credits issued for the account.

AccountAdjustments.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

AccountAdjustments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same as returned from get. Refer to the upstream documentation for details.

AccountAdjustments.delete()

Delete this resource.

AccountAdjustments.get(type=None, state=None, cursor=None, per_page=None)

Fetch credits and charges for an account.

Variables:

• type (str) – The type of adjustments: ‘charge’ or ‘credit’.
• state (str) – The state of the adjustments to return: ‘pending’ or ‘invoiced’.

BillingInfo

Account.billing_info()

Return the resource corresponding to the account’s current billing information.

BillingInfo.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

BillingInfo.delete()

Delete this resource.

BillingInfo.get(cursor=None, per_page=None)

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

Variables:

• cursor (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. The maximum is 200. If left as None, 50 objects are returned.

BillingInfo.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

AccountInvoices

Account.invoices()

Return the resource corresponding to all invoices for the account.

AccountInvoices.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

AccountInvoices.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same as returned from get. Refer to the upstream documentation for details.

AccountInvoices.get(cursor=None, per_page=None)

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

Variables:

• cursor (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. The maximum is 200. If left as None, 50 objects are returned.

CouponRedemption

Account.redemption()

Return the resource corresponding to the coupon redeemed by the account.

CouponRedemption.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

CouponRedemption.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same as returned from get. Refer to the upstream documentation for details.

CouponRedemption.delete()

Delete this resource.

CouponRedemption.get(cursor=None, per_page=None)

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

Variables:

• cursor (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. The maximum is 200. If left as None, 50 objects are returned.

AccountSubscriptions

Account.subscriptions()

Return the resource corresponding to all subscriptions for the account.

AccountSubscriptions.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

AccountSubscriptions.get(state='live', cursor=None, per_page=None)

Fetch all your subscription.

Variables:state (str) – The state of subscriptions to return: “active”, “canceled”, “expired”, “future”, “in_trial”, “live”, or “past_due”. A subscription will belong to more than one state.

AccountTransactions

Account.transactions()

Return the resource corresponding to all transactions for the account.

AccountTransactions.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

AccountTransactions.get(cursor=None, per_page=None)

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

Variables:

• cursor (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. The maximum is 200. If left as None, 50 objects are returned.

Account.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

Account.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same as returned from get. Refer to the upstream documentation for details.

Account.delete()

Delete this resource.

Account.get(cursor=None, per_page=None)

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

Variables:

• cursor (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. The maximum is 200. If left as None, 50 objects are returned.

Account.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Accounts

Recurly.accounts()

Return the resource corresponding to all accounts.

Accounts.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

Accounts.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same as returned from get. Refer to the upstream documentation for details.

Accounts.get(state='active', cursor=None, per_page=None)

Fetch accounts for your site.

Variables:state (str) – The state of the accounts to return: ‘active’, ‘closed’, ‘past_due’. Defaults to ‘active’.

Adjustment

Recurly.adjustment(uuid)

Return the resource corresponding to a single adjustment.

Adjustment.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

Adjustment.delete()

Delete this resource.

Adjustment.get(cursor=None, per_page=None)

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

Variables:

• cursor (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. The maximum is 200. If left as None, 50 objects are returned.

Coupon

Recurly.coupon(coupon_code)

Return the resource corresponding to a single coupon.

Coupon.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

Coupon.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same as returned from get. Refer to the upstream documentation for details.

Coupon.delete()

Delete this resource.

Coupon.get(cursor=None, per_page=None)

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

Variables:

• cursor (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. The maximum is 200. If left as None, 50 objects are returned.

Coupons

Recurly.coupons()

Return the resource corresponding to all coupons.

Coupons.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

Coupons.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same as returned from get. Refer to the upstream documentation for details.

Coupons.get(state=None, cursor=None, per_page=None)

Fetch all your coupons.

Variables:state (str) – The state of coupons to return: “redeemable”, “expired” or “maxed_out”.

Invoice

Recurly.invoice(invoice_number)

Return the resource corresponding to a single invoice.

Invoice.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

Invoice.get(cursor=None, per_page=None)

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

Variables:

• cursor (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. The maximum is 200. If left as None, 50 objects are returned.

Invoice.get_pdf(language='en-US')

Fetch a PDF blob for the invoice.

Variables:language (str) – The language for the invoice, defaults to “en-US’.

Invoice.mark_failed()

Mark an invoice as failed collection

Invoice.mark_successful()

Mark an invoice as paid successfully

Invoices

Recurly.invoices()

Return the resource corresponding to all invoices.

Invoices.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

Invoices.get(state=None, cursor=None, per_page=None)

Fetch all your invoices.

Variables:state (str) – The state of invoices to return: “open”, “collected”, “failed”, or “past_due”.

Plan

Recurly.plan(plan_code)

Return the resource corresponding to a single plan.

Addon

Plan.addon(add_on_code)

Return the resource corresponding to a single plan’s add-on.

Addon.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

Addon.delete()

Delete this resource.

Addon.get(cursor=None, per_page=None)

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

Variables:

• cursor (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. The maximum is 200. If left as None, 50 objects are returned.

Addon.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Addons

Plan.addons()

Return the resource corresponding to all the add-ons for the plan.

Addons.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

Addons.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same as returned from get. Refer to the upstream documentation for details.

Addons.get(cursor=None, per_page=None)

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

Variables:

• cursor (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. The maximum is 200. If left as None, 50 objects are returned.

Plan.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

Plan.delete()

Delete this resource.

Plan.get(cursor=None, per_page=None)

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

Variables:

• cursor (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. The maximum is 200. If left as None, 50 objects are returned.

Plan.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Plans

Recurly.plans()

Return the resource corresponding to all plans.

Plans.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

Plans.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same as returned from get. Refer to the upstream documentation for details.

Plans.get(cursor=None, per_page=None)

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

Variables:

• cursor (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. The maximum is 200. If left as None, 50 objects are returned.

Subscription

Recurly.subscription(uuid)

Return the resource corresponding to a single subscription.

Subscription.cancel()

Cancel a subscription, remaining it as active until next billing cycle.

Subscription.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

Subscription.get(cursor=None, per_page=None)

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

Variables:

• cursor (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. The maximum is 200. If left as None, 50 objects are returned.

Subscription.postpone(next_renewal_date)

Postpone a subscription

Variables:next_renewal_date (str) – The next renewal date that will be applied

Subscription.reactivate()

Reactivating a canceled subscription.

Subscription.terminate(refund=None)

Terminate a subsciription, removing any stored billing information.

Variables:refund (str) – The type of the refund to perform: ‘full’ or ‘partial’ Defaults to ‘none’.

Subscription.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Subscriptions

Recurly.subscriptions()

Return the resource corresponding to all subscriptions.

Subscriptions.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

Subscriptions.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same as returned from get. Refer to the upstream documentation for details.

Subscriptions.get(state='live', cursor=None, per_page=None)

Fetch all your subscription.

Variables:state (str) – The state of subscriptions to return: “active”, “canceled”, “expired”, “future”, “in_trial”, “live”, or “past_due”. A subscription will belong to more than one state.

Transaction

Recurly.transaction(uuid)

Return the resource corresponding to a single transaction.

Transaction.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

Transaction.get(cursor=None, per_page=None)

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

Variables:

• cursor (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. The maximum is 200. If left as None, 50 objects are returned.

Transaction.refund(amount_in_cents=None)

Refund or void a previous, successful transaction.

Transactions

Recurly.transactions()

Return the resource corresponding to all transactions.

Transactions.count(*args, **kwargs)

Fetch an integer count of the number of objects of a collection. This is an absolute number, regardless of paging limits, so use this if you want to tally up a collection instead of iterating through all of its objects.

For single-object resources, returns one.

Accepts the same arguments as get.

Transactions.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same as returned from get. Refer to the upstream documentation for details.

Transactions.get(state=None, type=None, cursor=None, per_page=None)

Fetch all your transactions.

Variables:

• state (str) – The state of transactions to return: “successful”, “failed”, or “voided”.
• type (str) – The type of transactions to return: “authorization”, “refund”, or “purchase”.

SegmentIO

class segmentio.SegmentIO(api_secret)

Create a SegmentIO service

Variables:api_secret (str) – Your project’s API secret.

User

SegmentIO.user(user_id)

Return the resource corresponding to a single user

User.identify(traits=None, context=None, timestamp=None)

Identify an user.

Variables:

• traits (dict) – A dictionary of traits you know about the user.
• context (dict) – A dictionary of provider specific options.
• timestamp – An ISO 8601 date string representing

when the identify took place. :vartype timestamp: str

User.track(event, properties=None, context=None, timestamp=None)

Track an event.

Variables:

• event (str) – The name of the event you’re tracking.
• properties (dict) – A dictionary of properties for the event.
• context (dict) – A dictionary of provider specific options.
• timestamp – An ISO 8601 date string representing

when the event took place. :vartype timestamp: str

Service methods

SegmentIO.alias(from_user_id, to_user_id, context=None, timestamp=None)

Identify an user.

Variables:

• from_user_id (str) – The anonymous user’s id before they are logged in.
• to_user_id (str) – The identified user’s id after they’re logged in.
• context (dict) – A dictionary of provider specific options.
• timestamp – An ISO 8601 date string representing

when the identify took place. :vartype timestamp: str

SegmentIO.batch_import(batch, context=None)

The import method lets you send a series of identify, group, track, page and screen requests in a single batch

Variables:

• batch (dict) – List of actions.
• context (dict) – A dictionary of provider specific options.

Spotify

class spotify.Spotify

Create a Spotify service.

Lookup

Spotify.lookup()

Return the resource corresponding to the lookup service

Lookup.get(uri, extras=None)

Lookup for an artist, album or track in the Spotify’s music catalogue

Variables:

• uri (str) – Spotify valid uri
• extras (str) – A comma-separated list of words that defines the detail level expected in the response.

See https://developer.spotify.com/technologies/web-api/lookup/

Search

Spotify.search()

Return the resource corresponding to the search service

Search.get(type, q, page=None)

Search in the Spotify’s music catalogue.

See https://developer.spotify.com/technologies/web-api/search/ and http://www.spotify.com/es/about/features/advanced-search-syntax/

Variables:

• type (str) – What to search for, artist, album or track.
• q (str) – Search string.
• page (int) – The page of the result set to return. defaults to 1

Stripe

class stripe.Stripe(api_key)

Create a Stripe service.

Variables:api_key (str) – The API key.

Account

Stripe.account()

Return the resource corresponding to the logged account.

Account.get()

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

BalanceHistory

Stripe.balance_history()

Return the resource corresponding to the balance history.

BalanceHistory.get(limit=None, ending_before=None, starting_after=None)

Fetch all of the objects.

Variables:

• limit – A limit on the number of objects to be returned. Count can range between 1 and 100 objects.
• ending_before (str) – A cursor (object ID) for use in pagination. Fetched objetcs will be newer than the given object.
• starting_after (str) – A cursor (object ID) for use in pagination. Fetched objetcs will be older than the given object.

Charge

Stripe.charge(id)

Return the resource corresponding to a single charge.

Charge.dispute(obj)

Update a dispute

Variables:obj – a Python object representing the updated dispute.

Charge.get()

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

Charge.refund(amount=None)

Refunding a charge

Variables:amount (int) – A positive integer in cents representing how much of this charge to refund. Can only refund up to the unrefunded amount remaining of the charge. Default is entire charge.

Charges

Stripe.charges()

Return the resource corresponding to all charges.

Charges.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Charges.get(customer=None, limit=None, ending_before=None, starting_after=None)

Fetch all of the objects.

Variables:

• customer (str) – Only return charges for the customer specified by this customer ID.
• limit – A limit on the number of objects to be returned. Count can range between 1 and 100 objects.
• ending_before (str) – A cursor (object ID) for use in pagination. Fetched objetcs will be newer than the given object.
• starting_after (str) – A cursor (object ID) for use in pagination. Fetched objetcs will be older than the given object.

Coupon

Stripe.coupon(id)

Return the resource corresponding to a single coupon.

Coupon.delete()

Delete this resource.

Coupon.get()

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

Coupons

Stripe.coupons()

Return the resource corresponding to all coupons.

Coupons.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Coupons.get(limit=None, ending_before=None, starting_after=None)

Fetch all of the objects.

Variables:

• limit – A limit on the number of objects to be returned. Count can range between 1 and 100 objects.
• ending_before (str) – A cursor (object ID) for use in pagination. Fetched objetcs will be newer than the given object.
• starting_after (str) – A cursor (object ID) for use in pagination. Fetched objetcs will be older than the given object.

Customer

Stripe.customer(id)

Return the resource corresponding to a single customer.

DiscountResource

Customer.discount()

Return the resource corresponding to a single discount.

DiscountResource.delete()

Delete this resource.

SubscriptionResource

Customer.subscription(subscription_id)

Return the resource corresponding to a single customer’s subscription.

Variables:subscription_id (str) – The subscription’s id.

SubscriptionResource.delete()

Delete this resource.

SubscriptionResource.get()

Fetch the object’s data.

SubscriptionResource.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

SubscriptionsResource

Customer.subscriptions()

Return the resource corresponding to the customer’s subscriptions.

SubscriptionsResource.get()

Fetch the object’s data.

Customer.delete()

Delete this resource.

Customer.get()

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

Customer.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Customers

Stripe.customers()

Return the resource corresponding to all customers.

Customers.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Customers.get(total_count=False, limit=None, ending_before=None, starting_after=None)

Fetch all of the objects.

Variables:

• total_count (bool) – Include the total count of all customers.
• limit – A limit on the number of objects to be returned. Count can range between 1 and 100 objects.
• ending_before (str) – A cursor (object ID) for use in pagination. Fetched objetcs will be newer than the given object.
• starting_after (str) – A cursor (object ID) for use in pagination. Fetched objetcs will be older than the given object.

Event

Stripe.event(id)

Return the resource corresponding to a single event.

Event.get()

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

Events

Stripe.events()

Return the resource corresponding to all events.

Events.get(type=None, limit=None, ending_before=None, starting_after=None)

Fetch all of the objects.

Variables:

• type (str) – A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.
• limit – A limit on the number of objects to be returned. Count can range between 1 and 100 objects.
• ending_before (str) – A cursor (object ID) for use in pagination. Fetched objetcs will be newer than the given object.
• starting_after (str) – A cursor (object ID) for use in pagination. Fetched objetcs will be older than the given object.

Invoice

Stripe.invoice(id)

Return the resource corresponding to a single invoice.

LineItems

Invoice.lines()

Return the resource corresponding to all invoice’s lines.

LineItems.get(customer=None, limit=None, ending_before=None, starting_after=None)

Fetch all of the objects.

Variables:

• customer (str) – In the case of upcoming invoices, the customer of the upcoming invoice is required. In other cases it is ignored.
• limit – A limit on the number of objects to be returned. Count can range between 1 and 100 objects.
• ending_before (str) – A cursor (object ID) for use in pagination. Fetched objetcs will be newer than the given object.
• starting_after (str) – A cursor (object ID) for use in pagination. Fetched objetcs will be older than the given object.

Invoice.get()

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

Invoice.pay()

Paying an invoice

Invoice.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

InvoiceItem

Stripe.invoiceitem(id)

Return the resource corresponding to a single invoiceitem.

InvoiceItem.delete()

Delete this resource.

InvoiceItem.get()

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

InvoiceItems

Stripe.invoiceitems()

Return the resource corresponding to all invoiceitems.

InvoiceItems.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

InvoiceItems.get(customer=None, limit=None, ending_before=None, starting_after=None)

Fetch all of the objects.

Variables:

• customer (str) – The identifier of the customer whose invoice items to return. If none is provided, all invoices will be returned.
• limit – A limit on the number of objects to be returned. Count can range between 1 and 100 objects.
• ending_before (str) – A cursor (object ID) for use in pagination. Fetched objetcs will be newer than the given object.
• starting_after (str) – A cursor (object ID) for use in pagination. Fetched objetcs will be older than the given object.

Invoices

Stripe.invoices()

Return the resource corresponding to all invoices.

Invoices.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Invoices.get(customer=None, limit=None, ending_before=None, starting_after=None)

Fetch all of the objects.

Variables:

• customer (str) – The identifier of the customer whose invoices to return. If none is provided, all invoices will be returned.
• limit – A limit on the number of objects to be returned. Count can range between 1 and 100 objects.
• ending_before (str) – A cursor (object ID) for use in pagination. Fetched objetcs will be newer than the given object.
• starting_after (str) – A cursor (object ID) for use in pagination. Fetched objetcs will be older than the given object.

Invoices.upcoming(customer)

Fetch a customer’s upcoming invoice.

Variables:customer (str) – The identifier of the customer whose invoices to return. If none is provided, all invoices will be returned.

Plan

Stripe.plan(id)

Return the resource corresponding to a single plan.

Plan.delete()

Delete this resource.

Plan.get()

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

Plan.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Plans

Stripe.plans()

Return the resource corresponding to all plans.

Plans.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Plans.get(limit=10)

Fetch all plans.

Variables:limit (int) – A limit on the number of objects to be returned. Limit can range between 1 and 100 items.

Token

Stripe.token(id)

Return the resource corresponding to a single token.

Token.get()

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

Tokens

Stripe.tokens()

Return the resource corresponding to all tokens.

Tokens.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Trello

class trello.Trello(key, token=None)

Create a Trello service.

Variables:

• key (str) – Your application key
• token (str) – The authorization token from the user (optional).

Action

Trello.action(action_id)

Return the resource corresponding to a single action.

Board

Action.board()

Returns a single board

Board.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Board.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Card

Action.card()

Returns a single card

Card.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Card.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

MemberCreator

Action.creator()

Returns a single creator

MemberCreator.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

MemberCreator.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

List

Action.list()

Returns a single list

List.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

List.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Member

Action.member()

Returns a single member

Member.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Member.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Organization

Action.organization()

Returns a single organization

Organization.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Organization.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Action.delete()

Delete this resource.

Action.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Action.get(fields=None, entities=None, member=None, member_fields=None, memberCreator=None, memberCreator_fields=None)

Fetch a single object.

Upstream documentation: https://trello.com/docs/api/action/index.html#get-1-actions-idaction

Action.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Board

Trello.board(board_id)

Return the resource corresponding to a single board

Actions

Board.actions()

Returns all actions

Actions.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Card

Board.card(card_id)

Returns a single card

Card.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Cards

Board.cards()

Returns all cards

Cards.filter(filter_id)

Fetch a collection filtered.

Variables:filter (str) – a valid resource’s filter.

Cards.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Checklists

Board.checklists()

Returns all checklists

Checklists.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Checklists.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Lists

Board.lists()

Returns all lists

Lists.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Lists.filter(filter_id)

Fetch a collection filtered.

Variables:filter (str) – a valid resource’s filter.

Lists.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Member

Board.member(member_id)

Returns a single member

Member.delete()

Delete this resource.

Member.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Members

Board.members()

Returns all members

Members.filter(filter_id)

Fetch a collection filtered.

Variables:filter (str) – a valid resource’s filter.

Members.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

MembersInvited

Board.members_invited()

Returns all invited members

MembersInvited.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

MembersInvited.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Membership

Board.membership(membership_id)

Returns a single membership

Membership.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Membership.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Memberships

Board.memberships()

Returns all memberships

Memberships.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Organization

Board.organization()

Returns a single organization

Organization.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Organization.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Board.calendar_key()

Generates a calendar key.

Board.email_key()

Generates a email key.

Board.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Board.get(**kwargs)

Fetch a single object.

Upstream documentation: https://trello.com/docs/api/board/index.html#get-1-boards-board-id

Board.mark_as_viewed()

Marks board as viewed.

Board.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Boards

Trello.boards()

Return the resource corresponding to all boards

Boards.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Card

Trello.card(card_id_or_shortlink)

Return the resource corresponding to a single card

Actions

Card.actions()

Returns all actions

Comments

Actions.comments()

Returns all comments

Comments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Comments.delete()

Comments.update(obj)

Actions.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Attachment

Card.attachment(attachment_id)

Returns a single checklist

Attachment.delete()

Delete this resource.

Attachment.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Attachments

Card.attachments()

Returns all attachments

Attachments.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Attachments.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Board

Card.board()

Returns a single board

Board.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Board.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

CheckItemStates

Card.checkitem_states()

Returns all checkitem states

CheckItemStates.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Checklist

Card.checklist(checklist_id)

Returns a single checklist

CheckItem

Checklist.checkitem(checkitem_id)

Returns a single checkitem

CheckItem.convert_to_card()

Converts checkitem to card.

CheckItem.delete()

Delete this resource.

CheckItem.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

CheckItems

Checklist.checkitems()

Returns all checkitems

CheckItems.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Checklists

Card.checklists()

Returns all checklists

Checklists.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Checklists.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Label

Card.label(color)

Returns a single label

Label.delete()

Delete this resource.

Labels

Card.labels()

Returns all labels

Labels.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

List

Card.list()

Returns a single list

List.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

List.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Members

Card.members()

Returns all members

Members.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

MembersVoted

Card.members_voted()

Returns all voted members

MembersVoted.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

MembersVoted.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Sticker

Card.sticker(sticker_id)

Returns a single sticker

Sticker.delete()

Delete this resource.

Sticker.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Sticker.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Stickers

Card.stickers()

Returns all stickers

Stickers.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Stickers.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Card.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Card.get(**kwargs)

Fetch a single object.

Upstream documentation: https://trello.com/docs/api/card/index.html#get-1-cards-card-id-or-shortlink

Card.mark_as_read()

Marks associated notification as read.

Card.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Cards

Trello.cards()

Return the resource corresponding to all cards

Cards.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Checklist

Trello.checklist(checklist_id)

Return the resource corresponding to a single checklist

Board

Checklist.board()

Returns a single board

Board.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Board.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Cards

Checklist.cards()

Returns all cards

Cards.filter(filter_id)

Fetch a collection filtered.

Variables:filter (str) – a valid resource’s filter.

Cards.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

CheckItem

Checklist.checkitem(checkitem_id)

Returns a single checkitem

CheckItem.delete()

Delete this resource.

CheckItem.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

CheckItems

Checklist.checkitems()

Returns all checkitems

CheckItems.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

CheckItems.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Checklist.delete()

Delete this resource.

Checklist.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Checklist.get(**kwargs)

Fetch a single object.

Upstream documentation: https://trello.com/docs/api/checklist/index.html

Checklist.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Checklists

Trello.checklists()

Return the resource corresponding to all checklists

Checklists.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

List

Trello.list(list_id)

Return the resource corresponding to a single list

Actions

List.actions()

Returns all actions

Actions.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Board

List.board()

Returns a single board

Board.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Board.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Cards

List.cards()

Returns all cards

Cards.filter(filter_id)

Fetch a collection filtered.

Variables:filter (str) – a valid resource’s filter.

Cards.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

List.archive_all_cards()

Archive all list cards.

List.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

List.get(**kwargs)

Fetch a single object.

Upstream documentation: https://trello.com/docs/api/list/index.html#get-1-lists-idlist

List.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Lists

Trello.lists()

Return the resource corresponding to all lists

Lists.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Member

Trello.me()

Return the resource corresponding to the current member

Actions

Member.actions()

Returns all actions

Actions.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

BoardBackgrounds

Member.board_background(board_background_id)

Returns a single board background

BoardBackgrounds.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

BoardBackgrounds.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

BoardBackgrounds

Member.board_backgrounds()

Returns all board backgrounds

BoardBackgrounds.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

BoardBackgrounds.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

BoardStar

Member.board_star(board_star_id)

Returns a single board star

BoardStar.delete()

Delete this resource.

BoardStar.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

BoardStars

Member.board_stars()

Returns all board stars

BoardStars.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

BoardStars.get()

Boards

Member.boards()

Returns all boards

Boards.filter(filter_id)

Fetch a collection filtered.

Variables:filter (str) – a valid resource’s filter.

Boards.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Cards

Member.cards()

Returns all cards

Cards.filter(filter_id)

Fetch a collection filtered.

Variables:filter (str) – a valid resource’s filter.

Cards.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

CustomBoardBackground

Member.custom_board_background(board_background_id)

Returns a single custom board background

CustomBoardBackground.delete()

Delete this resource.

CustomBoardBackground.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

CustomBoardBackground.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

CustomBoardBackgrounds

Member.custom_board_backgrounds()

Returns all custom board backgrounds

CustomBoardBackgrounds.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

CustomBoardBackgrounds.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

CustomSticker

Member.custom_sticker(sticker_id)

Returns a single custom stickers

CustomSticker.delete()

Delete this resource.

CustomSticker.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

CustomStickers

Member.custom_stickers()

Returns all custom stickers

CustomStickers.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

CustomStickers.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Notifications

Member.notifications()

Returns all notifications

Notifications.filter(filter_id)

Fetch a collection filtered.

Variables:filter (str) – a valid resource’s filter.

Notifications.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Organizations

Member.organizations()

Returns all organizations

Organizations.filter(filter_id)

Fetch a collection filtered.

Variables:filter (str) – a valid resource’s filter.

Organizations.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Sessions

Member.sessions()

Returns all sessions

Sessions.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Tokens

Member.tokens()

Returns all tokens

Tokens.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Member.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Member.get(**kwargs)

Fetch a single object.

Upstream documentation: https://trello.com/docs/api/member/index.html

Member.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Member

Trello.member(member_id_or_username)

Return the resource corresponding to a single member

Actions

Member.actions()

Returns all actions

Actions.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

BoardBackgrounds

Member.board_background(board_background_id)

Returns a single board background

BoardBackgrounds.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

BoardBackgrounds.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

BoardBackgrounds

Member.board_backgrounds()

Returns all board backgrounds

BoardBackgrounds.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

BoardBackgrounds.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

BoardStar

Member.board_star(board_star_id)

Returns a single board star

BoardStar.delete()

Delete this resource.

BoardStar.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

BoardStars

Member.board_stars()

Returns all board stars

BoardStars.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

BoardStars.get()

Boards

Member.boards()

Returns all boards

Boards.filter(filter_id)

Fetch a collection filtered.

Variables:filter (str) – a valid resource’s filter.

Boards.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Cards

Member.cards()

Returns all cards

Cards.filter(filter_id)

Fetch a collection filtered.

Variables:filter (str) – a valid resource’s filter.

Cards.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

CustomBoardBackground

Member.custom_board_background(board_background_id)

Returns a single custom board background

CustomBoardBackground.delete()

Delete this resource.

CustomBoardBackground.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

CustomBoardBackground.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

CustomBoardBackgrounds

Member.custom_board_backgrounds()

Returns all custom board backgrounds

CustomBoardBackgrounds.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

CustomBoardBackgrounds.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

CustomSticker

Member.custom_sticker(sticker_id)

Returns a single custom stickers

CustomSticker.delete()

Delete this resource.

CustomSticker.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

CustomStickers

Member.custom_stickers()

Returns all custom stickers

CustomStickers.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

CustomStickers.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Notifications

Member.notifications()

Returns all notifications

Notifications.filter(filter_id)

Fetch a collection filtered.

Variables:filter (str) – a valid resource’s filter.

Notifications.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Organizations

Member.organizations()

Returns all organizations

Organizations.filter(filter_id)

Fetch a collection filtered.

Variables:filter (str) – a valid resource’s filter.

Organizations.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Sessions

Member.sessions()

Returns all sessions

Sessions.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Tokens

Member.tokens()

Returns all tokens

Tokens.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Member.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Member.get(**kwargs)

Fetch a single object.

Upstream documentation: https://trello.com/docs/api/member/index.html

Member.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Notification

Trello.notification(notification_id)

Return the resource corresponding to a single notification

Board

Notification.board()

Returns a single board

Board.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Board.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Card

Notification.card()

Returns a single card

Card.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Card.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

MemberCreator

Notification.creator()

Returns a single creator

MemberCreator.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

MemberCreator.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

List

Notification.list()

Returns a single list

List.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

List.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Member

Notification.member()

Returns a single member

Member.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Member.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Organization

Notification.organization()

Returns a single organization

Organization.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Organization.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Notification.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Notification.get(**kwargs)

Fetch a single object.

Upstream documentation: https://trello.com/docs/api/notification/index.html

Notification.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Organization

Trello.organization(organization_id_or_name)

Return the resource corresponding to a single organization

Actions

Organization.actions()

Returns all actions

Actions.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Boards

Organization.boards()

Returns all boards

Boards.filter(filter_id)

Fetch a collection filtered.

Variables:filter (str) – a valid resource’s filter.

Boards.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Member

Organization.member(member_id)

Returns a single member

Member.delete()

Delete this resource.

Member.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Members

Organization.members()

Returns all members

Members.filter(filter_id)

Fetch a collection filtered.

Variables:filter (str) – a valid resource’s filter.

Members.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

MembersInvited

Organization.members_invited()

Returns all invited members

MembersInvited.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

MembersInvited.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Membership

Organization.membership(membership_id)

Returns a single membership

Membership.delete()

Delete this resource.

Membership.get(fields=None)

Fetch a single object.

Variables:fields (list) – all or comma-separated list of fields.

Membership.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Memberships

Organization.memberships()

Returns all memberships

Memberships.get(**kwargs)

Fetch a collection.

Upstream documentation: https://trello.com/docs/api/

Organization.delete()

Delete this resource.

Organization.field(field)

Returns a single resource field.

Variables:field (str) – a valid resource’s field.

Organization.get(**kwargs)

Fetch a single object.

Upstream documentation: https://trello.com/docs/api/organization/index.html

Organization.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Organizations

Trello.organizations()

Return the resource corresponding to all organizations

Organizations.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Twilio

class twilio.Twilio(account_sid, auth_token)

Create a Twilio service.

Variables:

• account_sid (str) – The users’s account SID
• auth_token (str) – THe account’s API token

Account

Twilio.account(sid)

Return the representation of an Account or SubAccount.

Application

Account.application(sid)

Return a Application resource representation, representing an application within this account.

Application.delete()

Delete this resource.

Application.get()

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

Application.update(obj)

Update this resource.

Variables:obj (dict) – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Applications

Account.applications()

Return a list of Application resource representations, each representing an application within this account.

Applications.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Applications.get(FriendlyName=None, Page=None, PageSize=None, AfterSid=None)

Fetch the Applications belonging to an account.

Variables:

• FriendlyName (str) – Only return the Account resources with friendly names that exactly match this name.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

AuthorizedConnectApp

Account.authorized_connect_app(sid)

Return a Connect App resource representation, representing a Connect App you’ve authorized to access this account.

AuthorizedConnectApp.get()

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

AuthorizedConnectApps

Account.authorized_connect_apps()

Return a list of Connect App resource representations, each representing a Connect App you’ve authorized to access this account.

AuthorizedConnectApps.get(Page=None, PageSize=None, AfterSid=None)

Fetch the Authorized Connect Apps belonging to an account.

Variables:

• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

AvailablePhoneNumbers

Account.available_phone_numbers()

Return an AvailablePhoneNumbers resource that allows querying local and toll-free available for this account.

AvailablePhoneNumbersLocal

AvailablePhoneNumbers.local(country_code)

Return a list of local AvailablePhoneNumber resource representations that match the specified filters, each representing a phone number that is currently available for provisioning within this account.

AvailablePhoneNumbersLocal.get(AreaCode=None, Contains=None, InRegion=None, InPostalCode=None, NearLatLong=None, NearNumber=None, InLata=None, InRateCenter=None, Distance=None)

Fetch available local phone numbers for an account.

Variables:

• AreaCode (str) – Find phone numbers in the specified area code.
• Contains (str) – A pattern to match phone numbers on. Valid characters are * and [0-9a-zA-Z]. The * character will match any single digit.
• InRegion (str) – Limit results to a particular region (State/Province). Given a phone number, search within the same Region as that number. (US and Canada only)
• InPostalCode (str) – Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. (US and Canada only)
• NearLatLong (str) – Given a latitude/longitude pair lat,long find geographically close numbers within Distance miles. (US and Canada only)
• NearNumber (str) – Given a phone number, find a geographically close number within Distance miles. Distance defaults to 25 miles. (US and Canada only)
• InLata (str) – Limit results to a specific Local access and transport area (LATA). Given a phone number, search within the same LATA as that number. (US and Canada only)
• InRateCenter (str) – Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires InLata to be set as well. (US and Canada only)
• InDistance (int) – Specifies the search radius for a Near- query in miles. If not specified this defaults to 25 miles. (US and Canada only)

AvailablePhoneNumbersTollFree

AvailablePhoneNumbers.toll_free(country_code)

Return a list of toll-free AvailablePhoneNumber resource representations that match the specified filters, each representing a phone number that is currently available for provisioning within this account.

AvailablePhoneNumbersTollFree.get(AreaCode=None, Contains=None)

Fetch available toll-free phone numbers for an account.

Variables:

• AreaCode (str) – Find phone numbers in the specified area code.
• Contains (str) – A pattern to match phone numbers on. Valid characters are * and [0-9a-zA-Z]. The * character will match any single digit.

Call

Account.call(sid)

Return a phone call made to and from this account.

Notifications

Call.notifications()

Return a list of notifications generated for this call.

Notifications.get(Log=None, MessageDate=None, MessageDateGT=None, MessageDateLT=None, Page=None, PageSize=None, AfterSid=None)

Fetch notifications for an account or call.

Variables:

• Log (int) – Only show notifications for this log, using the integer log values.
• MessageDate (str) – Only show notifications for this date, given as YYYY-MM-DD.
• MessageDateGT (str) – Greater than inequality for MessageDate, use it for messages logged at or after midnight on a date (generates MessageDate>=YYYY-MM-DD).
• MessageDateLT – Lower than inequality for MessageDate, use it for messages logged at or before midnight on a date (generates MessageDate<=YYYY-MM-DD).
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

Recordings

Call.recordings()

Return a list of Recording resource representations, each representing a recording generated during the course of this phone call.

Recordings.get(CallSid=None, DateCreated=None, DateCreatedGT=None, DateCreatedLT=None, Page=None, PageSize=None, AfterSid=None)

Fetch the list of transcriptions for an account or call.

Variables:

• CallSid (str) – Show only recordings made during the call given by this sid.
• DateCreated (str) – Only show recordings created on this date, given as YYYY-MM-DD.
• DateCreatedGT (str) – Greater than inequality for DateCreated, use it for recordings created at or after midnight on a date (generates DateCreated>=YYYY-MM-DD).
• DateCreatedLT – Lower than inequality for DateCreated, use it for recordings created at or before midnight on a date (generates DateCreated<=YYYY-MM-DD).
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

Call.get()

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

Call.update(obj)

Update this resource.

Variables:obj (dict) – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Calls

Account.calls()

Return a list of phone calls made to and from this account.

Calls.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Calls.get(To=None, From=None, Status=None, StartTime=None, StartTimeGT=None, StartTimeLT=None, ParentCallSid=None, Page=None, PageSize=None, AfterSid=None)

Fetch the calls made to or from an account.

Variables:

• To (str) – Only show calls to this phone number or Client identifier.
• From (str) – Only show calls from this phone number or Client identifier.
• Status (str) – Only show calls currently in this status. May be queued, ringing, in-progress, completed, failed, busy or no-answer.
• StartTime (str) – Only show calls that started on this date, given as YYYY-MM-DD.
• StartTimeGT (str) – Greater than inequality for StartTime, use it for calls that started at or after midnight on a date (generates StartTime>=YYYY-MM-DD).
• StartTimeLT – Lower than inequality for StartTime, use it for calls that started at or before midnight on a date (generates StartTime<=YYYY-MM-DD).
• ParentCallSid (str) – Only show calls spawned by the call with this Sid.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

Conference

Account.conference(sid)

Return a conference within this account.

Participant

Conference.participant(sid)

Return a participant in this conference.

Participant.delete()

Delete this resource.

Participant.get()

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

Participant.update(obj)

Update this resource.

Variables:obj (dict) – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Participants

Conference.participants()

Return the list of participants in this conference.

Participants.get(Muted=None, Page=None, PageSize=None, AfterSid=None)

Fetch the participants of a conference.

Variables:

• Muted (bool) – Only show participants that are muted or unmuted. Either True or False.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

Conference.get()

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

Conferences

Account.conferences()

Return a list of conferences within this account.

Conferences.get(Status=None, FriendlyName=None, DateCreated=None, DateCreatedGT=None, DateCreatedLT=None, DateUpdated=None, DateUpdatedGT=None, DateUpdatedLT=None, Page=None, PageSize=None, AfterSid=None)

Fetch the calls made to or from an account.

Variables:

• Status (str) – Only show conferences currently in with this status. May be init, in-progress, or completed.
• FriendlyName (str) – List conferences who’s FriendlyName is the exact match of this string.
• DateCreated (str) – Only show conferences that started on this date, given as YYYY-MM-DD.
• DateCreatedGT (str) – Greater than inequality for DateCreated, use it for conferences that started at or after midnight on a date (generates DateCreated>=YYYY-MM-DD).
• DateCreatedLT – Lower than inequality for DateCreated, use it for conferences that started at or before midnight on a date (generates DateCreated<=YYYY-MM-DD).
• DateUpdated (str) – Only show conferences that were last updated on this date, given as YYYY-MM-DD.
• DateUpdatedGT (str) – Greater than inequality for DateUpdated, use it for conferences that were last updated at or after midnight on a date (generates DateUpdated>=YYYY-MM-DD).
• DateUpdatedLT – Lower than inequality for DateUpdated, use it for conferences that were last updated at or before midnight on a date (generates DateUpdated<=YYYY-MM-DD).
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

ConnectApp

Account.connect_app(sid)

Return a Connect App resource representations, representing a Connect App in this account.

ConnectApp.get()

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

ConnectApp.update(obj)

Update this resource.

Variables:obj (dict) – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ConnectApps

Account.connect_apps()

Return a list of Connect App resource representations, each representing a Connect App in this account.

ConnectApps.get(Page=None, PageSize=None, AfterSid=None)

Fetch the Connect Apps belonging to an account.

Variables:

• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

IncomingPhoneNumber

Account.incoming_phone_number(sid)

Return an IncomingPhoneNumber resource representation, representing a phone number given to this account.

IncomingPhoneNumber.delete()

Delete this resource.

IncomingPhoneNumber.get()

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

IncomingPhoneNumber.update(obj)

Update this resource.

Variables:obj (dict) – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

IncomingPhoneNumbers

Account.incoming_phone_numbers()

Return a list of IncomingPhoneNumber resource representations, each representing a phone number given to this account.

IncomingPhoneNumbersLocal

IncomingPhoneNumbers.local()

IncomingPhoneNumbersLocal.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IncomingPhoneNumbersLocal.get(PhoneNumber=None, FriendlyName=None, Page=None, PageSize=None, AfterSid=None)

Fetch incoming phone numbers list for an account.

Variables:

• PhoneNumber (str) – Only show the incoming phone number resources that match this pattern. You can specify partial numbers and use * as a wildcard for any digit.
• FriendlyName (str) – Only show the incoming phone number resources with friendly names that exactly match this name.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

IncomingPhoneNumbersTollFree

IncomingPhoneNumbers.toll_free()

IncomingPhoneNumbersTollFree.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IncomingPhoneNumbersTollFree.get(PhoneNumber=None, FriendlyName=None, Page=None, PageSize=None, AfterSid=None)

Fetch incoming phone numbers list for an account.

Variables:

• PhoneNumber (str) – Only show the incoming phone number resources that match this pattern. You can specify partial numbers and use * as a wildcard for any digit.
• FriendlyName (str) – Only show the incoming phone number resources with friendly names that exactly match this name.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

IncomingPhoneNumbers.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

IncomingPhoneNumbers.get(PhoneNumber=None, FriendlyName=None, Page=None, PageSize=None, AfterSid=None)

Fetch incoming phone numbers list for an account.

Variables:

• PhoneNumber (str) – Only show the incoming phone number resources that match this pattern. You can specify partial numbers and use * as a wildcard for any digit.
• FriendlyName (str) – Only show the incoming phone number resources with friendly names that exactly match this name.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

Notification

Account.notification(sid)

Return a notification generated for this account.

Notification.delete()

Delete this resource.

Notification.get()

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

Notifications

Account.notifications()

Return a list of notifications generated for this account.

Notifications.get(Log=None, MessageDate=None, MessageDateGT=None, MessageDateLT=None, Page=None, PageSize=None, AfterSid=None)

Fetch notifications for an account or call.

Variables:

• Log (int) – Only show notifications for this log, using the integer log values.
• MessageDate (str) – Only show notifications for this date, given as YYYY-MM-DD.
• MessageDateGT (str) – Greater than inequality for MessageDate, use it for messages logged at or after midnight on a date (generates MessageDate>=YYYY-MM-DD).
• MessageDateLT – Lower than inequality for MessageDate, use it for messages logged at or before midnight on a date (generates MessageDate<=YYYY-MM-DD).
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

OutgoingCallerId

Account.outgoing_caller_id(sid)

Return an OutgoingCallerId resource representation, representing a Caller ID number valid for this account.

OutgoingCallerId.delete()

Delete this resource.

OutgoingCallerId.get()

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

OutgoingCallerId.update(obj)

Update this resource.

Variables:obj (dict) – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

OutgoingCallerIds

Account.outgoing_caller_ids()

Return a list of OutgoingCallerId resource representations, each representing a Caller ID number valid for this account.

OutgoingCallerIds.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

OutgoingCallerIds.get(PhoneNumber=None, FriendlyName=None, Page=None, PageSize=None, AfterSid=None)

Fetch outgoing caller ids for an account.

Variables:

• PhoneNumber (str) – Only show the incoming phone number resources that match this pattern. You can specify partial numbers and use * as a wildcard for any digit.
• FriendlyName (str) – Only show the incoming phone number resources with friendly names that exactly match this name.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

Queue

Account.queue(sid)

Return a queue within this account.

Member

Queue.member(sid)

Return a member in this queue.

Member.get()

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

Member.update(obj)

Update this resource.

Variables:obj (dict) – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Members

Queue.members()

Return the list of members in this queue.

Members.get(Page=None, PageSize=None, AfterSid=None)

Fetch the list of members for a conference.

Variables:

• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

Queue.delete()

Delete this resource.

Queue.get()

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

Queue.update(obj)

Update this resource.

Variables:obj (dict) – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Queues

Account.queues()

Return a list of queues within this account.

Queues.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Queues.get(Page=None, PageSize=None, AfterSid=None)

Fetch the list of conferences of an account.

Variables:

• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

Recording

Account.recording(sid)

Return a Recording resource representation, representing a recording generated during the course of a phone call made to or from this account.

Transcriptions

Recording.transcriptions()

Return a set of Transcription resource representations for this recording.

Transcriptions.get(Page=None, PageSize=None, AfterSid=None)

Fetch the list of transcriptions for an account or call.

Variables:

• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

Recording.delete()

Delete this resource.

Recording.get()

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

Recordings

Account.recordings()

Return a list of Recording resource representations, each representing a recording generated during the course of a phone call made to or from this account.

Recordings.get(CallSid=None, DateCreated=None, DateCreatedGT=None, DateCreatedLT=None, Page=None, PageSize=None, AfterSid=None)

Fetch the list of transcriptions for an account or call.

Variables:

• CallSid (str) – Show only recordings made during the call given by this sid.
• DateCreated (str) – Only show recordings created on this date, given as YYYY-MM-DD.
• DateCreatedGT (str) – Greater than inequality for DateCreated, use it for recordings created at or after midnight on a date (generates DateCreated>=YYYY-MM-DD).
• DateCreatedLT – Lower than inequality for DateCreated, use it for recordings created at or before midnight on a date (generates DateCreated<=YYYY-MM-DD).
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

SMS

Account.sms()

Return a SMS resource to query messages and short codes resources.

Message

SMS.message(sid)

Return a SMS message associated with this account.

Message.get()

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

Messages

SMS.messages()

Return a list of SMS messages associated with this account.

Messages.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Messages.get(To=None, From=None, DateSent=None, DateSentGT=None, DateSentLT=None, Page=None, PageSize=None, AfterSid=None)

Fetch the list of SMS messages associated with an account.

Variables:

• To (str) – Only show SMS messages to this phone number.
• From (str) – Only show SMS messages from this phone number.
• DateSent (str) – Only show SMS messages on this date, given as YYYY-MM-DD.
• DateSentGT (str) – Greater than inequality for DateSent, use it for message sent at or after midnight on a date (generates DateSent>=YYYY-MM-DD).
• DateSentLT – Lower than inequality for DateSent, use it for messages sent at or before midnight on a date (generates DateSent<=YYYY-MM-DD).
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

ShortCode

SMS.short_code(sid)

Return a ShortCode resource representation, representing a short code within this account.

ShortCode.get()

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

ShortCode.update(obj)

Update this resource.

Variables:obj (dict) – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

ShortCodes

SMS.short_codes()

Return a list of ShortCode resource representations, each representing a short code within this account.

ShortCodes.get(ShortCode=None, FriendlyName=None, Page=None, PageSize=None, AfterSid=None)

Fetch the list of short codes for an account.

Variables:

• ShortCode (str) – Only show the ShortCode resources that match this pattern. You can specify partial numbers and use * as a wildcard for any digit.
• FriendlyName (str) – Only show the ShortCode resources with friendly names that exactly match this name.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

Transcription

Account.transcription(sid)

Return a Transcription resource representation for call made to of from this account.

Transcription.get()

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

Transcriptions

Account.transcriptions()

Return a set of Transcription resource representations for this account.

Transcriptions.get(Page=None, PageSize=None, AfterSid=None)

Fetch the list of transcriptions for an account or call.

Variables:

• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

Usage

Account.usage()

Return a usage resource to query records and triggers resources.

Records

Usage.records()

Return a list of usage records.

RecordsAllTime

Records.all_time()

Return a single usage record for each usage category, each representing usage over the date-range specified. This is the same as the root .usage().records().

RecordsAllTime.get(Category=None, StartDate=None, EndDate=None, Page=None, PageSize=None, AfterSid=None)

Fetch a list of usage records.

Variables:

• Category (str) – Only include usage records of this usage category.
• StartDate (str) – Only include usage that has occurred on or after this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, StartDate=-30days will make StartDate be 30 days before today.
• EndDate (str) – Only include usage that has occurred on or before this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, EndDate=+30days will make EndDate be 30 days from today.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

RecordsDaily

Records.daily()

Return multiple usage records for each usage category, each representing usage over a daily time-interval.

RecordsDaily.get(Category=None, StartDate=None, EndDate=None, Page=None, PageSize=None, AfterSid=None)

Fetch a list of usage records.

Variables:

• Category (str) – Only include usage records of this usage category.
• StartDate (str) – Only include usage that has occurred on or after this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, StartDate=-30days will make StartDate be 30 days before today.
• EndDate (str) – Only include usage that has occurred on or before this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, EndDate=+30days will make EndDate be 30 days from today.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

RecordsLastMonth

Records.last_month()

Return a single usage record per usage category, for last month’s usage only.

RecordsLastMonth.get(Category=None, StartDate=None, EndDate=None, Page=None, PageSize=None, AfterSid=None)

Fetch a list of usage records.

Variables:

• Category (str) – Only include usage records of this usage category.
• StartDate (str) – Only include usage that has occurred on or after this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, StartDate=-30days will make StartDate be 30 days before today.
• EndDate (str) – Only include usage that has occurred on or before this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, EndDate=+30days will make EndDate be 30 days from today.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

RecordsMonthly

Records.monthly()

Return multiple usage records for each usage category, each representing usage over a monthly time-interval.

RecordsMonthly.get(Category=None, StartDate=None, EndDate=None, Page=None, PageSize=None, AfterSid=None)

Fetch a list of usage records.

Variables:

• Category (str) – Only include usage records of this usage category.
• StartDate (str) – Only include usage that has occurred on or after this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, StartDate=-30days will make StartDate be 30 days before today.
• EndDate (str) – Only include usage that has occurred on or before this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, EndDate=+30days will make EndDate be 30 days from today.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

RecordsThisMonth

Records.this_month()

Return a single usage record per usage category, for this month’s usage only.

RecordsThisMonth.get(Category=None, StartDate=None, EndDate=None, Page=None, PageSize=None, AfterSid=None)

Fetch a list of usage records.

Variables:

• Category (str) – Only include usage records of this usage category.
• StartDate (str) – Only include usage that has occurred on or after this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, StartDate=-30days will make StartDate be 30 days before today.
• EndDate (str) – Only include usage that has occurred on or before this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, EndDate=+30days will make EndDate be 30 days from today.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

RecordsToday

Records.today()

Return a single usage record per usage category, for today’s usage only.

RecordsToday.get(Category=None, StartDate=None, EndDate=None, Page=None, PageSize=None, AfterSid=None)

Fetch a list of usage records.

Variables:

• Category (str) – Only include usage records of this usage category.
• StartDate (str) – Only include usage that has occurred on or after this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, StartDate=-30days will make StartDate be 30 days before today.
• EndDate (str) – Only include usage that has occurred on or before this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, EndDate=+30days will make EndDate be 30 days from today.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

RecordsYearly

Records.yearly()

Return multiple usage records for each usage category, each representing usage over a yearly time-interval.

RecordsYearly.get(Category=None, StartDate=None, EndDate=None, Page=None, PageSize=None, AfterSid=None)

Fetch a list of usage records.

Variables:

• Category (str) – Only include usage records of this usage category.
• StartDate (str) – Only include usage that has occurred on or after this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, StartDate=-30days will make StartDate be 30 days before today.
• EndDate (str) – Only include usage that has occurred on or before this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, EndDate=+30days will make EndDate be 30 days from today.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

RecordsYesterday

Records.yesterday()

Return a single usage record per usage category, for yesterday’s usage only.

RecordsYesterday.get(Category=None, StartDate=None, EndDate=None, Page=None, PageSize=None, AfterSid=None)

Fetch a list of usage records.

Variables:

• Category (str) – Only include usage records of this usage category.
• StartDate (str) – Only include usage that has occurred on or after this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, StartDate=-30days will make StartDate be 30 days before today.
• EndDate (str) – Only include usage that has occurred on or before this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, EndDate=+30days will make EndDate be 30 days from today.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

Records.get(Category=None, StartDate=None, EndDate=None, Page=None, PageSize=None, AfterSid=None)

Fetch a list of usage records.

Variables:

• Category (str) – Only include usage records of this usage category.
• StartDate (str) – Only include usage that has occurred on or after this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, StartDate=-30days will make StartDate be 30 days before today.
• EndDate (str) – Only include usage that has occurred on or before this date. Format is YYYY-MM-DD. All dates are in GMT. As a convenience, you can also specify offsets to today. For example, EndDate=+30days will make EndDate be 30 days from today.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

Trigger

Usage.trigger(sid)

Return an usage trigger set on this account.

Trigger.delete()

Delete this resource.

Trigger.get()

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

Trigger.update(obj)

Update this resource.

Variables:obj (dict) – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Triggers

Usage.triggers()

Return a list of usage triggers set on this account.

Triggers.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Triggers.get(Recurring=None, UsageCategory=None, TriggerBy=None, Page=None, PageSize=None, AfterSid=None)

Fetch a list of usage triggers resource representations.

Variables:

• Recurring (str) – Only show usage triggers that count over this interval. One of daily, monthly, or yearly. To retrieve non-recurring triggers, leave this empty or use alltime.
• UsageCategory (str) – Only include usage triggers that watch this usage category.
• TriggerBy (str) – Only show usage triggers that trigger by this field in the usage record. Must be one of: count, usage, or price.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

Account.get()

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

Account.update(obj)

Update this resource.

Variables:obj (dict) – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Accounts

Twilio.accounts()

Return the set of Accounts resources belonging to the Account used to make the API request. This list includes that account, along with any subaccounts belonging to it.

You can use the Accounts list resource to create subaccounts and retrieve the subaccounts that exist under your main account.

Accounts.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Accounts.get(FriendlyName=None, Status=None, Page=None, PageSize=None, AfterSid=None)

Fetch the (sub)accounts belonging to this account.

Variables:

• FriendlyName (str) – Only return the Account resources with friendly names that exactly match this name.
• Status (str) – Only return Account resources with the given status. Can be closed, suspended or active.
• Page (int) – The current page number. Zero-indexed, so the first page is 0.
• PageSize (int) – How many resources to return in each list page. The default is 50, and the maximum is 1000.
• AfterSid (str) – The last Sid returned in the previous page, used to avoid listing duplicated resources if new ones are created while paging.

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

UserVoice.instant_answers_search(page=None, per_page=None, query=None)

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.

Analytics

class youtube.Analytics(access_token=None)

The YouTube Analytics API currently provides a single method that lets you retrieve Analytics reports for a YouTube channel.

https://developers.google.com/youtube/analytics/v1/available_reports.html identifies the different reports that you can retrieve. For each report, it lists the dimensions that are used to aggregate data, available metrics, and supported filtering options.

Create a YouTube service.

Variables:access_token –

Service methods

Analytics.get(ids, metrics, start_date, end_date, dimensions=None, filters=None, max_results=None, start_index=None, sort=None)

Retrieve YouTube Analytics data

Variables:

• ids (str) – Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data. To request data for a YouTube user, set the ids parameter value to channel==USER_ID. To request data for a YouTube CMS content owner, set the ids parameter value to contentOwner==OWNER_NAME
• metrics (str) – A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes. See https://developers.google.com/youtube/analytics/v1/available_reports.html for a list of the reports that you can retrieve and the metrics available in each report, and seehttps://developers.google.com/youtube/analytics/v1/dimsmets/mets.html for definitions of those metrics.
• start_date (str) – The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format.
• end_date (str) – The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format.
• dimensions (str) – A comma-separated list of YouTube Analytics dimensions, such as video or ageGroup,gender. See https://developers.google.com/youtube/analytics/v1/available_reports.html for a list of the reports that you can retrieve and the dimensions used for those reports. Also see https://developers.google.com/youtube/analytics/v1/dimsmets/dims for definitions of those dimensions.
• filters (str) – A list of filters that should be applied when retrieving YouTube Analytics data. The https://developers.google.com/youtube/analytics/v1/available_reports.html identifies the dimensions that can be used to filter each report, and https://developers.google.com/youtube/analytics/v1/dimsmets/dims defines those dimensions. If a request uses multiple filters, join them together with a semicolon (;), and the returned result table will satisfy both filters. For example, a filters parameter value of video==dMH0bHeiRNg;country==IT restricts the result set to include data for the given video in Italy.
• max_results (str) – The maximum number of rows to include in the response
• start_index (int) – The 1-based index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
• sort (str) – A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The ‘-‘ prefix causes descending sort order

Zendesk

class zendesk.Zendesk(subdomain, username=None, password=None, access_token=None)

Create a Zendesk service.

Variables:

• subdomain (str) – The account-specific part of the Zendesk domain, for instance use mycompany if your Zendesk domain is mycompany.zendesk.com.
• username (str) – The email of the authenticated agent. Use user@company.com/token for token-based authentication.
• password (str) – The password of the authenticated agent, or an API token if using token-based authentication.
• access_token (str) – An OAuth Access token. Username and password are not required if the OAuth Access token is provided.

Activities

Zendesk.activities()

Return the resource corresponding to all activities.

Activities.get(since=None, page=None, per_page=None)

Fetch the list of activities

Variables:since (str) – Timestamp offset in UTC on ISO8601 form %Y-%m-%dT%H:%M:%SZ

Activity

Zendesk.activity(activity_id)

Return the resource corresponding to a single activity.

Activity.get(page=None, per_page=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. The maximum is 100. If left as None, 100 objects are returned.

Exports

Zendesk.exports()

Return the resource corresponding to exports.

Exports.sample(start_time)

This end point is only to be used for testing the incremental export format. It is more relaxed in terms of rate limiting, but will only return up to 50 records.

Variables:start_time (int) – The time of the oldest ticket you are interested in. Tickets modified on or since this time will be returned. The start time is provided as the number of seconds since epoch UTC.

Exports.tickets(start_time)

Retrieve tickets that changed in Zendesk “since last you asked”

Variables:start_time (int) – The time of the oldest ticket you are interested in. Tickets modified on or since this time will be returned. The start time is provided as the number of seconds since epoch UTC.

Group

Zendesk.group(group_id)

Return the resource corresponding to a single group.

Group.delete()

Delete this resource.

Group.get(page=None, per_page=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. The maximum is 100. If left as None, 100 objects are returned.

Group.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Groups

Zendesk.groups()

Return the resource corresponding to all groups.

Groups.assignable(page=None, per_page=None)

Fetch assignable groups.

Groups.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Groups.get(page=None, per_page=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. The maximum is 100. If left as None, 100 objects are returned.

SatisfactionRating

Zendesk.satisfaction_rating(rating_id)

Return the resource corresponding to a single satisfaction rating.

SatisfactionRating.get(page=None, per_page=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. The maximum is 100. If left as None, 100 objects are returned.

SatisfactionRatings

Zendesk.satisfaction_ratings()

Return the resource corresponding to all satisfaction ratings.

SatisfactionRatings.get(page=None, per_page=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. The maximum is 100. If left as None, 100 objects are returned.

SatisfactionRatings.received(page=None, per_page=None, sort_order=None)

Fetch ratings provided by customers.

Tags

Zendesk.tags()

Return the resource corresponding to tags.

Tags.get(page=None, per_page=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. The maximum is 100. If left as None, 100 objects are returned.

Ticket

Zendesk.ticket(ticket_id)

Return the resource corresponding to a single ticket.

Tags

Ticket.tags()

Return the resource corresponding to tags.

Tags.get(page=None, per_page=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. The maximum is 100. If left as None, 100 objects are returned.

Ticket.audits(page=None, per_page=None)

Fetch the audits on a ticket.

Ticket.collaborators(page=None, per_page=None)

Fetch the collaborators on a ticket.

Ticket.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Ticket.delete()

Delete this resource.

Ticket.get(page=None, per_page=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. The maximum is 100. If left as None, 100 objects are returned.

Ticket.metrics()

Fetch the ticket metrics.

Ticket.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

Tickets

Zendesk.tickets()

Return the resource corresponding to all the tickets.

Tickets.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Tickets.delete()

Delete this resource.

Tickets.get(page=None, per_page=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. The maximum is 100. If left as None, 100 objects are returned.

Tickets.recent(page=None, per_page=None)

Fetch all recent tickets. The parameters are the same as for the get method.

Tickets.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

User, CurrentUser

Zendesk.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.

User.delete()

Delete this resource.

User.get(page=None, per_page=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. The maximum is 100. If left as None, 100 objects are returned.

User.tickets_ccd(page=None, per_page=None)

Fetch tickets where this user is CC’d.

User.tickets_requested(page=None, per_page=None)

Fetch tickets requested by this user.

User.update(obj)

Update this resource.

Variables:obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.

CurrentUser.get()

Users

Zendesk.users()

Return the resource corresponding to all users.

Users.create(obj)

Create a new resource.

Variables:obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.

Users.get(page=None, per_page=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. The maximum is 100. If left as None, 100 objects are returned.

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

Fetch users based on their usernames or email addresses.

Variables:query (str) – A username or an email address.

View

Zendesk.view(view_id)

Return the resource corresponding to a single view.

View.count()

Returns the ticket count for a single view.

View.execute(sort_by=None, sort_order=None)

Get the view output. View output sorting can be controlled by passing the sort_by and sort_order parameters.

Variables:

• sort_by (str) – The field used for sorting. This will either be a title or a custom field id.
• sort_order (str) – The direction the tickets are sorted. May be one of ‘asc’ or ‘desc’

View.get(page=None, per_page=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. The maximum is 100. If left as None, 100 objects are returned.

View.tickets(page=None, per_page=None)

Returns the ticket for a single view.

Views

Zendesk.views()

Return the resource corresponding to all views.

Views.active(page=None, per_page=None)

Fetch active shared and personal Views available to the current user.

Views.count_many(ids)

Calculates the size of the view in terms of number of tickets the view will return. Only returns values for personal and shared views accessible to the user performing the request.

Variables:ids (tuple of int) – List of view ids

Views.get(page=None, per_page=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. The maximum is 100. If left as None, 100 objects are returned.

Views.preview(conditions, columns=None, group_by=None, group_order=None, sort_by=None, sort_order=None)

Views can be previewed by constructing the conditions in the proper format. See http://developer.zendesk.com/documentation/rest_api/views.html#previewing-views.

Variables:

• conditions (dict) – A representation of the conditions that constitute the view. See http://developer.zendesk.com/documentation/rest_api/views.html#conditions.
• columns (tuple of int or str) – The ticket fields to display. System fields are looked up by name, custom fields by title or id.
• group_by (str) – When present, the field by which the tickets are grouped
• group_order (str) – The direction the tickets are grouped. May be one of ‘asc’ or ‘desc’
• sort_by (str) – The field used for sorting. This will either be a title or a custom field id.
• sort_order (str) – The direction the tickets are sorted. May be one of ‘asc’ or ‘desc’

Views.preview_count(conditions)

Views can be previewed by constructing the conditions in the proper format. See http://developer.zendesk.com/documentation/rest_api/views.html#previewing-views.

Variables:

• conditions (dict) – A representation of the conditions that constitute the view. See http://developer.zendesk.com/documentation/rest_api/views.html#conditions.
• columns (tuple of int or str) – The ticket fields to display. System fields are looked up by name, custom fields by title or id.
• group_by (str) – When present, the field by which the tickets are grouped
• group_order (str) – The direction the tickets are grouped. May be one of ‘asc’ or ‘desc’
• sort_by (str) – The field used for sorting. This will either be a title or a custom field id.
• sort_order (str) – The direction the tickets are sorted. May be one of ‘asc’ or ‘desc’

Service methods

Zendesk.search(query, sort_order=None, sort_by=None, page=None, per_page=None)

Fetch the results of a search on your Zendesk account. For details on searching, see http://developer.zendesk.com/documentation/rest_api/search.html

Variables:

• query (str) – A free-form search term.
• sort_order – Optional order in which to sort the results.
• sort_by (str) – Optional term by which to sort the results.

Indices and tables

• Index
• Search Page