gdata.apps.service
index
/usr/local/svn/gdata-python-client/src/gdata/apps/service.py

# Copyright (C) 2007 SIOS Technology, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

 
Modules
       
xml.etree.cElementTree
atom
gdata
urllib

 
Classes
       
exceptions.Exception(exceptions.BaseException)
Error
AppsForYourDomainException
gdata.service.GDataService(atom.service.AtomService)
AppsService
PropertyService

 
class AppsForYourDomainException(Error)
    
Method resolution order:
AppsForYourDomainException
Error
exceptions.Exception
exceptions.BaseException
__builtin__.object

Methods defined here:
__init__(self, response)

Data descriptors inherited from Error:
__weakref__
list of weak references to the object (if defined)

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object at 0x74d100>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
class AppsService(gdata.service.GDataService)
    Client for the Google Apps Provisioning service.
 
 
Method resolution order:
AppsService
gdata.service.GDataService
atom.service.AtomService
__builtin__.object

Methods defined here:
AddAllElementsFromAllPages(self, link_finder, func)
retrieve all pages and add all elements
AddRecipientToEmailList(self, recipient, list_name)
Add a recipient to a email list.
CreateEmailList(self, list_name)
Create a email list.
CreateNickname(self, user_name, nickname)
Create a nickname
CreateUser(self, user_name, family_name, given_name, password, suspended='false', quota_limit=None, password_hash_function=None)
Create a user account.
DeleteEmailList(self, list_name)
Delete a email list
DeleteNickname(self, nickname)
Delete a nickname
DeleteUser(self, user_name)
Delete a user account
GetGeneratorForAllEmailLists(self, num_retries=3, delay=1, backoff=2)
Retrieve a generator for all emaillists in this domain.
GetGeneratorForAllNicknames(self, num_retries=3, delay=1, backoff=2)
Retrieve a generator for all nicknames in this domain.
GetGeneratorForAllNicknamesOfAUser(self, user_name, num_retries=3, delay=1, backoff=2)
Retrieve a generator for all nicknames of a particular user.
GetGeneratorForAllRecipients(self, list_name, num_retries=3, delay=1, backoff=2)
Retrieve a generator for all recipients of a particular emaillist.
GetGeneratorForAllUsers(self, num_retries=3, delay=1, backoff=2)
Retrieve a generator for all users in this domain.
RemoveRecipientFromEmailList(self, recipient, list_name)
Remove recipient from email list.
RestoreUser(self, user_name)
RetrieveAllEmailLists(self)
Retrieve all email list of a domain.
RetrieveAllNicknames(self)
Retrieve all nicknames in the domain
RetrieveAllRecipients(self, list_name)
Retrieve all recipient of an email list.
RetrieveAllUsers(self)
Retrieve all users in this domain. OBSOLETE
RetrieveEmailList(self, list_name)
Retreive a single email list by the list's name.
RetrieveEmailLists(self, recipient)
Retrieve All Email List Subscriptions for an Email Address.
RetrieveNickname(self, nickname)
Retrieve a nickname.
 
Args:
  nickname: string The nickname to retrieve
 
Returns:
  gdata.apps.NicknameEntry
RetrieveNicknames(self, user_name)
Retrieve nicknames of the user
RetrievePageOfEmailLists(self, start_email_list_name=None, num_retries=3, delay=1, backoff=2)
Retrieve one page of email list
RetrievePageOfNicknames(self, start_nickname=None, num_retries=3, delay=1, backoff=2)
Retrieve one page of nicknames in the domain
RetrievePageOfRecipients(self, list_name, start_recipient=None, num_retries=3, delay=1, backoff=2)
Retrieve one page of recipient of an email list.
RetrievePageOfUsers(self, start_username=None, num_retries=3, delay=1, backoff=2)
Retrieve one page of users in this domain.
RetrieveUser(self, user_name)
Retrieve an user account.
 
Args:
  user_name: string The user name to retrieve
 
Returns:
  gdata.apps.UserEntry
SuspendUser(self, user_name)
UpdateUser(self, user_name, user_entry)
Update a user account.
__init__(self, email=None, password=None, domain=None, source=None, server='apps-apis.google.com', additional_headers=None, **kwargs)
Creates a client for the Google Apps Provisioning service.
 
Args:
  email: string (optional) The user's email address, used for
      authentication.
  password: string (optional) The user's password.
  domain: string (optional) The Google Apps domain name.
  source: string (optional) The name of the user's application.
  server: string (optional) The name of the server to which a connection
      will be opened. Default value: 'apps-apis.google.com'.
  **kwargs: The other parameters to pass to gdata.service.GDataService
      constructor.

Methods inherited from gdata.service.GDataService:
AuthSubTokenInfo(self)
Fetches the AuthSub token's metadata from the server.
 
Raises:
  NonAuthSubToken if the user's auth token is not an AuthSub token
ClientLogin(self, username, password, account_type=None, service=None, auth_service_url=None, source=None, captcha_token=None, captcha_response=None)
Convenience method for authenticating using ProgrammaticLogin. 
 
Sets values for email, password, and other optional members.
 
Args:
  username:
  password:
  account_type: string (optional)
  service: string (optional)
  auth_service_url: string (optional)
  captcha_token: string (optional)
  captcha_response: string (optional)
Delete(self, uri, extra_headers=None, url_params=None, escape_params=True, redirects_remaining=4)
Deletes the entry at the given URI.
 
Args:
  uri: string The URI of the entry to be deleted. Example: 
       '/base/feeds/items/ITEM-ID'
  extra_headers: dict (optional) HTTP headers which are to be included.
                 The client automatically sets the Content-Type and
                 Authorization headers.
  url_params: dict (optional) Additional URL parameters to be included
              in the URI. These are translated into query arguments
              in the form '&dict_key=value&...'.
              Example: {'max-results': '250'} becomes &max-results=250
  escape_params: boolean (optional) If false, the calling code has already
                 ensured that the query will form a valid URL (all
                 reserved characters have been escaped). If true, this
                 method will escape the query and any URL parameters
                 provided.
 
Returns:
  True if the entry was deleted.
FetchOAuthRequestToken(self, scopes=None, extra_parameters=None, request_url='https://www.google.com/accounts/OAuthGetRequestToken', oauth_callback=None)
Fetches and sets the OAuth request token and returns it.
 
Args:
  scopes: string or list of string base URL(s) of the service(s) to be
      accessed. If None, then this method tries to determine the
      scope(s) from the current service.
  extra_parameters: dict (optional) key-value pairs as any additional
      parameters to be included in the URL and signature while making a
      request for fetching an OAuth request token. All the OAuth parameters
      are added by default. But if provided through this argument, any
      default parameters will be overwritten. For e.g. a default parameter
      oauth_version 1.0 can be overwritten if
      extra_parameters = {'oauth_version': '2.0'}
  request_url: Request token URL. The default is
      'https://www.google.com/accounts/OAuthGetRequestToken'.
  oauth_callback: str (optional) If set, it is assume the client is using
      the OAuth v1.0a protocol where the callback url is sent in the
      request token step.  If the oauth_callback is also set in
      extra_params, this value will override that one.
 
Returns:
  The fetched request token as a gdata.auth.OAuthToken object.
 
Raises:
  FetchingOAuthRequestTokenFailed if the server responded to the request
  with an error.
GenerateAuthSubURL(self, next, scope, secure=False, session=True, domain='default')
Generate a URL at which the user will login and be redirected back.
 
Users enter their credentials on a Google login page and a token is sent
to the URL specified in next. See documentation for AuthSub login at:
http://code.google.com/apis/accounts/docs/AuthSub.html
 
Args:
  next: string The URL user will be sent to after logging in.
  scope: string or list of strings. The URLs of the services to be 
         accessed.
  secure: boolean (optional) Determines whether or not the issued token
          is a secure token.
  session: boolean (optional) Determines whether or not the issued token
           can be upgraded to a session token.
GenerateOAuthAuthorizationURL(self, request_token=None, callback_url=None, extra_params=None, include_scopes_in_callback=False, scopes_param_prefix='oauth_token_scope', request_url='https://www.google.com/accounts/OAuthAuthorizeToken')
Generates URL at which user will login to authorize the request token.
 
Args:
  request_token: gdata.auth.OAuthToken (optional) OAuth request token.
      If not specified, then the current token will be used if it is of
      type <gdata.auth.OAuthToken>, else it is found by looking in the
      token_store by looking for a token for the current scope.    
  callback_url: string (optional) The URL user will be sent to after
      logging in and granting access.
  extra_params: dict (optional) Additional parameters to be sent.
  include_scopes_in_callback: Boolean (default=False) if set to True, and
      if 'callback_url' is present, the 'callback_url' will be modified to
      include the scope(s) from the request token as a URL parameter. The
      key for the 'callback' URL's scope parameter will be
      OAUTH_SCOPE_URL_PARAM_NAME. The benefit of including the scope URL as
      a parameter to the 'callback' URL, is that the page which receives
      the OAuth token will be able to tell which URLs the token grants
      access to.
  scopes_param_prefix: string (default='oauth_token_scope') The URL
      parameter key which maps to the list of valid scopes for the token.
      This URL parameter will be included in the callback URL along with
      the scopes of the token as value if include_scopes_in_callback=True.
  request_url: Authorization URL. The default is
      'https://www.google.com/accounts/OAuthAuthorizeToken'.
Returns:
  A string URL at which the user is required to login.
 
Raises:
  NonOAuthToken if the user's request token is not an OAuth token or if a
  request token was not available.
Get(self, uri, extra_headers=None, redirects_remaining=4, encoding='UTF-8', converter=None)
Query the GData API with the given URI
 
The uri is the portion of the URI after the server value 
(ex: www.google.com).
 
To perform a query against Google Base, set the server to 
'base.google.com' and set the uri to '/base/feeds/...', where ... is 
your query. For example, to find snippets for all digital cameras uri 
should be set to: '/base/feeds/snippets?bq=digital+camera'
 
Args:
  uri: string The query in the form of a URI. Example:
       '/base/feeds/snippets?bq=digital+camera'.
  extra_headers: dictionary (optional) Extra HTTP headers to be included
                 in the GET request. These headers are in addition to 
                 those stored in the client's additional_headers property.
                 The client automatically sets the Content-Type and 
                 Authorization headers.
  redirects_remaining: int (optional) Tracks the number of additional
      redirects this method will allow. If the service object receives
      a redirect and remaining is 0, it will not follow the redirect. 
      This was added to avoid infinite redirect loops.
  encoding: string (optional) The character encoding for the server's
      response. Default is UTF-8
  converter: func (optional) A function which will transform
      the server's results before it is returned. Example: use 
      GDataFeedFromString to parse the server response as if it
      were a GDataFeed.
 
Returns:
  If there is no ResultsTransformer specified in the call, a GDataFeed 
  or GDataEntry depending on which is sent from the server. If the 
  response is niether a feed or entry and there is no ResultsTransformer,
  return a string. If there is a ResultsTransformer, the returned value 
  will be that of the ResultsTransformer function.
GetAuthSubToken(self)
Returns the AuthSub token as a string.
 
If the token is an gdta.auth.AuthSubToken, the Authorization Label
("AuthSub token") is removed.
 
This method examines the current_token to see if it is an AuthSubToken
or SecureAuthSubToken. If not, it searches the token_store for a token
which matches the current scope.
 
The current scope is determined by the service name string member.
 
Returns:
  If the current_token is set to an AuthSubToken/SecureAuthSubToken,
  return the token string. If there is no current_token, a token string
  for a token which matches the service object's default scope is returned.
  If there are no tokens valid for the scope, returns None.
GetClientLoginToken(self)
Returns the token string for the current token or a token matching the 
service scope.
 
If the current_token is a ClientLoginToken, the token string for 
the current token is returned. If the current_token is not set, this method
searches for a token in the token_store which is valid for the service 
object's current scope.
 
The current scope is determined by the service name string member.
The token string is the end of the Authorization header, it doesn not
include the ClientLogin label.
GetEntry(self, uri, extra_headers=None)
Query the GData API with the given URI and receive an Entry.
 
See also documentation for gdata.service.Get
 
Args:
  uri: string The query in the form of a URI. Example:
       '/base/feeds/snippets?bq=digital+camera'.
  extra_headers: dictionary (optional) Extra HTTP headers to be included
                 in the GET request. These headers are in addition to
                 those stored in the client's additional_headers property.
                 The client automatically sets the Content-Type and
                 Authorization headers.
 
Returns:
  A GDataEntry built from the XML in the server's response.
GetFeed(self, uri, extra_headers=None, converter=<function GDataFeedFromString at 0x7fb9757fcd70>)
Query the GData API with the given URI and receive a Feed.
 
See also documentation for gdata.service.Get
 
Args:
  uri: string The query in the form of a URI. Example:
       '/base/feeds/snippets?bq=digital+camera'.
  extra_headers: dictionary (optional) Extra HTTP headers to be included
                 in the GET request. These headers are in addition to
                 those stored in the client's additional_headers property.
                 The client automatically sets the Content-Type and
                 Authorization headers.
 
Returns:
  A GDataFeed built from the XML in the server's response.
GetGeneratorFromLinkFinder(self, link_finder, func, num_retries=3, delay=1, backoff=2)
returns a generator for pagination
GetMedia(self, uri, extra_headers=None)
Returns a MediaSource containing media and its metadata from the given
URI string.
GetNext(self, feed)
Requests the next 'page' of results in the feed.
 
This method uses the feed's next link to request an additional feed
and uses the class of the feed to convert the results of the GET request.
 
Args:
  feed: atom.Feed or a subclass. The feed should contain a next link and
      the type of the feed will be applied to the results from the 
      server. The new feed which is returned will be of the same class
      as this feed which was passed in.
 
Returns:
  A new feed representing the next set of results in the server's feed.
  The type of this feed will match that of the feed argument.
GetOAuthInputParameters(self)
GetWithRetries(self, uri, extra_headers=None, redirects_remaining=4, encoding='UTF-8', converter=None, num_retries=3, delay=1, backoff=2, logger=None)
This is a wrapper method for Get with retring capability.
 
To avoid various errors while retrieving bulk entities by retring
specified times.
 
Note this method relies on the time module and so may not be usable
by default in Python2.2.
 
Args:
  num_retries: integer The retry count.
  delay: integer The initial delay for retring.
  backoff: integer how much the delay should lengthen after each failure.
  logger: an object which has a debug(str) method to receive logging
          messages. Recommended that you pass in the logging module.
Raises:
  ValueError if any of the parameters has an invalid value.
  RanOutOfTries on failure after number of retries.
Post(self, data, uri, extra_headers=None, url_params=None, escape_params=True, redirects_remaining=4, media_source=None, converter=None)
Insert or update  data into a GData service at the given URI.
 
Args:
  data: string, ElementTree._Element, atom.Entry, or gdata.GDataEntry The
        XML to be sent to the uri.
  uri: string The location (feed) to which the data should be inserted.
       Example: '/base/feeds/items'.
  extra_headers: dict (optional) HTTP headers which are to be included.
                 The client automatically sets the Content-Type,
                 Authorization, and Content-Length headers.
  url_params: dict (optional) Additional URL parameters to be included
              in the URI. These are translated into query arguments
              in the form '&dict_key=value&...'.
              Example: {'max-results': '250'} becomes &max-results=250
  escape_params: boolean (optional) If false, the calling code has already
                 ensured that the query will form a valid URL (all
                 reserved characters have been escaped). If true, this
                 method will escape the query and any URL parameters
                 provided.
  media_source: MediaSource (optional) Container for the media to be sent
      along with the entry, if provided.
  converter: func (optional) A function which will be executed on the
      server's response. Often this is a function like
      GDataEntryFromString which will parse the body of the server's
      response and return a GDataEntry.
 
Returns:
  If the post succeeded, this method will return a GDataFeed, GDataEntry,
  or the results of running converter on the server's result body (if
  converter was specified).
PostOrPut(self, verb, data, uri, extra_headers=None, url_params=None, escape_params=True, redirects_remaining=4, media_source=None, converter=None)
Insert data into a GData service at the given URI.
 
Args:
  verb: string, either 'POST' or 'PUT'
  data: string, ElementTree._Element, atom.Entry, or gdata.GDataEntry The
        XML to be sent to the uri. 
  uri: string The location (feed) to which the data should be inserted. 
       Example: '/base/feeds/items'. 
  extra_headers: dict (optional) HTTP headers which are to be included. 
                 The client automatically sets the Content-Type,
                 Authorization, and Content-Length headers.
  url_params: dict (optional) Additional URL parameters to be included
              in the URI. These are translated into query arguments
              in the form '&dict_key=value&...'.
              Example: {'max-results': '250'} becomes &max-results=250
  escape_params: boolean (optional) If false, the calling code has already
                 ensured that the query will form a valid URL (all
                 reserved characters have been escaped). If true, this
                 method will escape the query and any URL parameters
                 provided.
  media_source: MediaSource (optional) Container for the media to be sent
      along with the entry, if provided.
  converter: func (optional) A function which will be executed on the 
      server's response. Often this is a function like 
      GDataEntryFromString which will parse the body of the server's 
      response and return a GDataEntry.
 
Returns:
  If the post succeeded, this method will return a GDataFeed, GDataEntry,
  or the results of running converter on the server's result body (if
  converter was specified).
ProgrammaticLogin(self, captcha_token=None, captcha_response=None)
Authenticates the user and sets the GData Auth token.
 
Login retreives a temporary auth token which must be used with all
requests to GData services. The auth token is stored in the GData client
object.
 
Login is also used to respond to a captcha challenge. If the user's login
attempt failed with a CaptchaRequired error, the user can respond by
calling Login with the captcha token and the answer to the challenge.
 
Args:
  captcha_token: string (optional) The identifier for the captcha challenge
                 which was presented to the user.
  captcha_response: string (optional) The user's answer to the captch 
                    challenge.
 
Raises:
  CaptchaRequired if the login service will require a captcha response
  BadAuthentication if the login service rejected the username or password
  Error if the login service responded with a 403 different from the above
Put(self, data, uri, extra_headers=None, url_params=None, escape_params=True, redirects_remaining=3, media_source=None, converter=None)
Updates an entry at the given URI.
 
Args:
  data: string, ElementTree._Element, or xml_wrapper.ElementWrapper The 
        XML containing the updated data.
  uri: string A URI indicating entry to which the update will be applied.
       Example: '/base/feeds/items/ITEM-ID'
  extra_headers: dict (optional) HTTP headers which are to be included.
                 The client automatically sets the Content-Type,
                 Authorization, and Content-Length headers.
  url_params: dict (optional) Additional URL parameters to be included
              in the URI. These are translated into query arguments
              in the form '&dict_key=value&...'.
              Example: {'max-results': '250'} becomes &max-results=250
  escape_params: boolean (optional) If false, the calling code has already
                 ensured that the query will form a valid URL (all
                 reserved characters have been escaped). If true, this
                 method will escape the query and any URL parameters
                 provided.
  converter: func (optional) A function which will be executed on the 
      server's response. Often this is a function like 
      GDataEntryFromString which will parse the body of the server's 
      response and return a GDataEntry.
 
Returns:
  If the put succeeded, this method will return a GDataFeed, GDataEntry,
  or the results of running converter on the server's result body (if
  converter was specified).
RevokeAuthSubToken(self)
Revokes an existing AuthSub token.
 
Raises:
  NonAuthSubToken if the user's auth token is not an AuthSub token
RevokeOAuthToken(self, request_url='https://www.google.com/accounts/AuthSubRevokeToken')
Revokes an existing OAuth token.
 
request_url: Token revoke URL. The default is
      'https://www.google.com/accounts/AuthSubRevokeToken'.
Raises:
  NonOAuthToken if the user's auth token is not an OAuth token.
  RevokingOAuthTokenFailed if request for revoking an OAuth token failed.
SetAuthSubToken(self, token, scopes=None, rsa_key=None)
Sets the token sent in requests to an AuthSub token.
 
Sets the current_token and attempts to add the token to the token_store.
 
Only use this method if you have received a token from the AuthSub
service. The auth token is set automatically when UpgradeToSessionToken()
is used. See documentation for Google AuthSub here:
http://code.google.com/apis/accounts/AuthForWebApps.html 
 
Args:
 token: gdata.auth.AuthSubToken or gdata.auth.SecureAuthSubToken or string
        The token returned by the AuthSub service. If the token is an
        AuthSubToken or SecureAuthSubToken, the scope information stored in
        the token is used. If the token is a string, the scopes parameter is
        used to determine the valid scopes.
 scopes: list of URLs for which the token is valid. This is only used
         if the token parameter is a string.
 rsa_key: string (optional) Private key required for RSA_SHA1 signature
          method.  This parameter is necessary if the token is a string
          representing a secure token.
SetClientLoginToken(self, token, scopes=None)
Sets the token sent in requests to a ClientLogin token.
 
This method sets the current_token to a new ClientLoginToken and it 
also attempts to add the ClientLoginToken to the token_store.
 
Only use this method if you have received a token from the ClientLogin
service. The auth_token is set automatically when ProgrammaticLogin()
is used. See documentation for Google ClientLogin here:
http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html
 
Args:
  token: string or instance of a ClientLoginToken.
SetOAuthInputParameters(self, signature_method, consumer_key, consumer_secret=None, rsa_key=None, two_legged_oauth=False, requestor_id=None)
Sets parameters required for using OAuth authentication mechanism.
 
NOTE: Though consumer_secret and rsa_key are optional, either of the two
is required depending on the value of the signature_method.
 
Args:
  signature_method: class which provides implementation for strategy class
      oauth.oauth.OAuthSignatureMethod. Signature method to be used for
      signing each request. Valid implementations are provided as the
      constants defined by gdata.auth.OAuthSignatureMethod. Currently
      they are gdata.auth.OAuthSignatureMethod.RSA_SHA1 and
      gdata.auth.OAuthSignatureMethod.HMAC_SHA1
  consumer_key: string Domain identifying third_party web application.
  consumer_secret: string (optional) Secret generated during registration.
      Required only for HMAC_SHA1 signature method.
  rsa_key: string (optional) Private key required for RSA_SHA1 signature
      method.
  two_legged_oauth: boolean (optional) Enables two-legged OAuth process.
  requestor_id: string (optional) User email adress to make requests on
      their behalf.  This parameter should only be set when two_legged_oauth
      is True.
SetOAuthToken(self, oauth_token)
Attempts to set the current token and add it to the token store.
 
The oauth_token can be any OAuth token i.e. unauthorized request token,
authorized request token or access token.
This method also attempts to add the token to the token store.
Use this method any time you want the current token to point to the
oauth_token passed. For e.g. call this method with the request token
you receive from FetchOAuthRequestToken.
 
Args:
  request_token: gdata.auth.OAuthToken OAuth request token.
UpgradeToOAuthAccessToken(self, authorized_request_token=None, request_url='https://www.google.com/accounts/OAuthGetAccessToken', oauth_version='1.0', oauth_verifier=None)
Upgrades the authorized request token to an access token and returns it
 
Args:
  authorized_request_token: gdata.auth.OAuthToken (optional) OAuth request
      token. If not specified, then the current token will be used if it is
      of type <gdata.auth.OAuthToken>, else it is found by looking in the
      token_store by looking for a token for the current scope.
  request_url: Access token URL. The default is
      'https://www.google.com/accounts/OAuthGetAccessToken'.
  oauth_version: str (default='1.0') oauth_version parameter. All other
      'oauth_' parameters are added by default. This parameter too, is
      added by default but here you can override it's value.
  oauth_verifier: str (optional) If present, it is assumed that the client
    will use the OAuth v1.0a protocol which includes passing the
    oauth_verifier (as returned by the SP) in the access token step.
 
Returns:
  Access token
      
Raises:
  NonOAuthToken if the user's authorized request token is not an OAuth
  token or if an authorized request token was not available.
  TokenUpgradeFailed if the server responded to the request with an 
  error.
UpgradeToSessionToken(self, token=None)
Upgrades a single use AuthSub token to a session token.
 
Args:
  token: A gdata.auth.AuthSubToken or gdata.auth.SecureAuthSubToken
         (optional) which is good for a single use but can be upgraded
         to a session token. If no token is passed in, the token
         is found by looking in the token_store by looking for a token
         for the current scope.
 
Raises:
  NonAuthSubToken if the user's auth token is not an AuthSub token
  TokenUpgradeFailed if the server responded to the request with an 
  error.
upgrade_to_session_token(self, token)
Upgrades a single use AuthSub token to a session token.
 
Args:
  token: A gdata.auth.AuthSubToken or gdata.auth.SecureAuthSubToken
         which is good for a single use but can be upgraded to a
         session token.
 
Returns:
  The upgraded token as a gdata.auth.AuthSubToken object.
 
Raises:
  TokenUpgradeFailed if the server responded to the request with an 
  error.

Data descriptors inherited from gdata.service.GDataService:
captcha_token
Get the captcha token for a login request.
captcha_url
Get the captcha URL for a login request.
source
The source is the name of the application making the request. 
It should be in the form company_id-app_name-app_version

Data and other attributes inherited from gdata.service.GDataService:
auth_token = None
handler = None
tokens = None

Methods inherited from atom.service.AtomService:
UseBasicAuth(self, username, password, for_proxy=False)
Sets an Authenticaiton: Basic HTTP header containing plaintext.
 
Deprecated, use use_basic_auth instead.
 
The username and password are base64 encoded and added to an HTTP header
which will be included in each request. Note that your username and 
password are sent in plaintext.
 
Args:
  username: str
  password: str
request(*args, **kwargs)
# The deprecated_function wraps the actual call to f.
use_basic_auth(self, username, password, scopes=None)

Data descriptors inherited from atom.service.AtomService:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
debug
If True, HTTP debug information is printed.
override_token

Data and other attributes inherited from atom.service.AtomService:
auto_set_current_token = True
auto_store_tokens = True
current_token = None
port = 80
ssl = False

 
class Error(exceptions.Exception)
    
Method resolution order:
Error
exceptions.Exception
exceptions.BaseException
__builtin__.object

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Methods inherited from exceptions.Exception:
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object at 0x74d100>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
class PropertyService(gdata.service.GDataService)
    Client for the Google Apps Property service.
 
 
Method resolution order:
PropertyService
gdata.service.GDataService
atom.service.AtomService
__builtin__.object

Methods defined here:
AddAllElementsFromAllPages(self, link_finder, func)
retrieve all pages and add all elements
__init__(self, email=None, password=None, domain=None, source=None, server='apps-apis.google.com', additional_headers=None)

Methods inherited from gdata.service.GDataService:
AuthSubTokenInfo(self)
Fetches the AuthSub token's metadata from the server.
 
Raises:
  NonAuthSubToken if the user's auth token is not an AuthSub token
ClientLogin(self, username, password, account_type=None, service=None, auth_service_url=None, source=None, captcha_token=None, captcha_response=None)
Convenience method for authenticating using ProgrammaticLogin. 
 
Sets values for email, password, and other optional members.
 
Args:
  username:
  password:
  account_type: string (optional)
  service: string (optional)
  auth_service_url: string (optional)
  captcha_token: string (optional)
  captcha_response: string (optional)
Delete(self, uri, extra_headers=None, url_params=None, escape_params=True, redirects_remaining=4)
Deletes the entry at the given URI.
 
Args:
  uri: string The URI of the entry to be deleted. Example: 
       '/base/feeds/items/ITEM-ID'
  extra_headers: dict (optional) HTTP headers which are to be included.
                 The client automatically sets the Content-Type and
                 Authorization headers.
  url_params: dict (optional) Additional URL parameters to be included
              in the URI. These are translated into query arguments
              in the form '&dict_key=value&...'.
              Example: {'max-results': '250'} becomes &max-results=250
  escape_params: boolean (optional) If false, the calling code has already
                 ensured that the query will form a valid URL (all
                 reserved characters have been escaped). If true, this
                 method will escape the query and any URL parameters
                 provided.
 
Returns:
  True if the entry was deleted.
FetchOAuthRequestToken(self, scopes=None, extra_parameters=None, request_url='https://www.google.com/accounts/OAuthGetRequestToken', oauth_callback=None)
Fetches and sets the OAuth request token and returns it.
 
Args:
  scopes: string or list of string base URL(s) of the service(s) to be
      accessed. If None, then this method tries to determine the
      scope(s) from the current service.
  extra_parameters: dict (optional) key-value pairs as any additional
      parameters to be included in the URL and signature while making a
      request for fetching an OAuth request token. All the OAuth parameters
      are added by default. But if provided through this argument, any
      default parameters will be overwritten. For e.g. a default parameter
      oauth_version 1.0 can be overwritten if
      extra_parameters = {'oauth_version': '2.0'}
  request_url: Request token URL. The default is
      'https://www.google.com/accounts/OAuthGetRequestToken'.
  oauth_callback: str (optional) If set, it is assume the client is using
      the OAuth v1.0a protocol where the callback url is sent in the
      request token step.  If the oauth_callback is also set in
      extra_params, this value will override that one.
 
Returns:
  The fetched request token as a gdata.auth.OAuthToken object.
 
Raises:
  FetchingOAuthRequestTokenFailed if the server responded to the request
  with an error.
GenerateAuthSubURL(self, next, scope, secure=False, session=True, domain='default')
Generate a URL at which the user will login and be redirected back.
 
Users enter their credentials on a Google login page and a token is sent
to the URL specified in next. See documentation for AuthSub login at:
http://code.google.com/apis/accounts/docs/AuthSub.html
 
Args:
  next: string The URL user will be sent to after logging in.
  scope: string or list of strings. The URLs of the services to be 
         accessed.
  secure: boolean (optional) Determines whether or not the issued token
          is a secure token.
  session: boolean (optional) Determines whether or not the issued token
           can be upgraded to a session token.
GenerateOAuthAuthorizationURL(self, request_token=None, callback_url=None, extra_params=None, include_scopes_in_callback=False, scopes_param_prefix='oauth_token_scope', request_url='https://www.google.com/accounts/OAuthAuthorizeToken')
Generates URL at which user will login to authorize the request token.
 
Args:
  request_token: gdata.auth.OAuthToken (optional) OAuth request token.
      If not specified, then the current token will be used if it is of
      type <gdata.auth.OAuthToken>, else it is found by looking in the
      token_store by looking for a token for the current scope.    
  callback_url: string (optional) The URL user will be sent to after
      logging in and granting access.
  extra_params: dict (optional) Additional parameters to be sent.
  include_scopes_in_callback: Boolean (default=False) if set to True, and
      if 'callback_url' is present, the 'callback_url' will be modified to
      include the scope(s) from the request token as a URL parameter. The
      key for the 'callback' URL's scope parameter will be
      OAUTH_SCOPE_URL_PARAM_NAME. The benefit of including the scope URL as
      a parameter to the 'callback' URL, is that the page which receives
      the OAuth token will be able to tell which URLs the token grants
      access to.
  scopes_param_prefix: string (default='oauth_token_scope') The URL
      parameter key which maps to the list of valid scopes for the token.
      This URL parameter will be included in the callback URL along with
      the scopes of the token as value if include_scopes_in_callback=True.
  request_url: Authorization URL. The default is
      'https://www.google.com/accounts/OAuthAuthorizeToken'.
Returns:
  A string URL at which the user is required to login.
 
Raises:
  NonOAuthToken if the user's request token is not an OAuth token or if a
  request token was not available.
Get(self, uri, extra_headers=None, redirects_remaining=4, encoding='UTF-8', converter=None)
Query the GData API with the given URI
 
The uri is the portion of the URI after the server value 
(ex: www.google.com).
 
To perform a query against Google Base, set the server to 
'base.google.com' and set the uri to '/base/feeds/...', where ... is 
your query. For example, to find snippets for all digital cameras uri 
should be set to: '/base/feeds/snippets?bq=digital+camera'
 
Args:
  uri: string The query in the form of a URI. Example:
       '/base/feeds/snippets?bq=digital+camera'.
  extra_headers: dictionary (optional) Extra HTTP headers to be included
                 in the GET request. These headers are in addition to 
                 those stored in the client's additional_headers property.
                 The client automatically sets the Content-Type and 
                 Authorization headers.
  redirects_remaining: int (optional) Tracks the number of additional
      redirects this method will allow. If the service object receives
      a redirect and remaining is 0, it will not follow the redirect. 
      This was added to avoid infinite redirect loops.
  encoding: string (optional) The character encoding for the server's
      response. Default is UTF-8
  converter: func (optional) A function which will transform
      the server's results before it is returned. Example: use 
      GDataFeedFromString to parse the server response as if it
      were a GDataFeed.
 
Returns:
  If there is no ResultsTransformer specified in the call, a GDataFeed 
  or GDataEntry depending on which is sent from the server. If the 
  response is niether a feed or entry and there is no ResultsTransformer,
  return a string. If there is a ResultsTransformer, the returned value 
  will be that of the ResultsTransformer function.
GetAuthSubToken(self)
Returns the AuthSub token as a string.
 
If the token is an gdta.auth.AuthSubToken, the Authorization Label
("AuthSub token") is removed.
 
This method examines the current_token to see if it is an AuthSubToken
or SecureAuthSubToken. If not, it searches the token_store for a token
which matches the current scope.
 
The current scope is determined by the service name string member.
 
Returns:
  If the current_token is set to an AuthSubToken/SecureAuthSubToken,
  return the token string. If there is no current_token, a token string
  for a token which matches the service object's default scope is returned.
  If there are no tokens valid for the scope, returns None.
GetClientLoginToken(self)
Returns the token string for the current token or a token matching the 
service scope.
 
If the current_token is a ClientLoginToken, the token string for 
the current token is returned. If the current_token is not set, this method
searches for a token in the token_store which is valid for the service 
object's current scope.
 
The current scope is determined by the service name string member.
The token string is the end of the Authorization header, it doesn not
include the ClientLogin label.
GetEntry(self, uri, extra_headers=None)
Query the GData API with the given URI and receive an Entry.
 
See also documentation for gdata.service.Get
 
Args:
  uri: string The query in the form of a URI. Example:
       '/base/feeds/snippets?bq=digital+camera'.
  extra_headers: dictionary (optional) Extra HTTP headers to be included
                 in the GET request. These headers are in addition to
                 those stored in the client's additional_headers property.
                 The client automatically sets the Content-Type and
                 Authorization headers.
 
Returns:
  A GDataEntry built from the XML in the server's response.
GetFeed(self, uri, extra_headers=None, converter=<function GDataFeedFromString at 0x7fb9757fcd70>)
Query the GData API with the given URI and receive a Feed.
 
See also documentation for gdata.service.Get
 
Args:
  uri: string The query in the form of a URI. Example:
       '/base/feeds/snippets?bq=digital+camera'.
  extra_headers: dictionary (optional) Extra HTTP headers to be included
                 in the GET request. These headers are in addition to
                 those stored in the client's additional_headers property.
                 The client automatically sets the Content-Type and
                 Authorization headers.
 
Returns:
  A GDataFeed built from the XML in the server's response.
GetGeneratorFromLinkFinder(self, link_finder, func, num_retries=3, delay=1, backoff=2)
returns a generator for pagination
GetMedia(self, uri, extra_headers=None)
Returns a MediaSource containing media and its metadata from the given
URI string.
GetNext(self, feed)
Requests the next 'page' of results in the feed.
 
This method uses the feed's next link to request an additional feed
and uses the class of the feed to convert the results of the GET request.
 
Args:
  feed: atom.Feed or a subclass. The feed should contain a next link and
      the type of the feed will be applied to the results from the 
      server. The new feed which is returned will be of the same class
      as this feed which was passed in.
 
Returns:
  A new feed representing the next set of results in the server's feed.
  The type of this feed will match that of the feed argument.
GetOAuthInputParameters(self)
GetWithRetries(self, uri, extra_headers=None, redirects_remaining=4, encoding='UTF-8', converter=None, num_retries=3, delay=1, backoff=2, logger=None)
This is a wrapper method for Get with retring capability.
 
To avoid various errors while retrieving bulk entities by retring
specified times.
 
Note this method relies on the time module and so may not be usable
by default in Python2.2.
 
Args:
  num_retries: integer The retry count.
  delay: integer The initial delay for retring.
  backoff: integer how much the delay should lengthen after each failure.
  logger: an object which has a debug(str) method to receive logging
          messages. Recommended that you pass in the logging module.
Raises:
  ValueError if any of the parameters has an invalid value.
  RanOutOfTries on failure after number of retries.
Post(self, data, uri, extra_headers=None, url_params=None, escape_params=True, redirects_remaining=4, media_source=None, converter=None)
Insert or update  data into a GData service at the given URI.
 
Args:
  data: string, ElementTree._Element, atom.Entry, or gdata.GDataEntry The
        XML to be sent to the uri.
  uri: string The location (feed) to which the data should be inserted.
       Example: '/base/feeds/items'.
  extra_headers: dict (optional) HTTP headers which are to be included.
                 The client automatically sets the Content-Type,
                 Authorization, and Content-Length headers.
  url_params: dict (optional) Additional URL parameters to be included
              in the URI. These are translated into query arguments
              in the form '&dict_key=value&...'.
              Example: {'max-results': '250'} becomes &max-results=250
  escape_params: boolean (optional) If false, the calling code has already
                 ensured that the query will form a valid URL (all
                 reserved characters have been escaped). If true, this
                 method will escape the query and any URL parameters
                 provided.
  media_source: MediaSource (optional) Container for the media to be sent
      along with the entry, if provided.
  converter: func (optional) A function which will be executed on the
      server's response. Often this is a function like
      GDataEntryFromString which will parse the body of the server's
      response and return a GDataEntry.
 
Returns:
  If the post succeeded, this method will return a GDataFeed, GDataEntry,
  or the results of running converter on the server's result body (if
  converter was specified).
PostOrPut(self, verb, data, uri, extra_headers=None, url_params=None, escape_params=True, redirects_remaining=4, media_source=None, converter=None)
Insert data into a GData service at the given URI.
 
Args:
  verb: string, either 'POST' or 'PUT'
  data: string, ElementTree._Element, atom.Entry, or gdata.GDataEntry The
        XML to be sent to the uri. 
  uri: string The location (feed) to which the data should be inserted. 
       Example: '/base/feeds/items'. 
  extra_headers: dict (optional) HTTP headers which are to be included. 
                 The client automatically sets the Content-Type,
                 Authorization, and Content-Length headers.
  url_params: dict (optional) Additional URL parameters to be included
              in the URI. These are translated into query arguments
              in the form '&dict_key=value&...'.
              Example: {'max-results': '250'} becomes &max-results=250
  escape_params: boolean (optional) If false, the calling code has already
                 ensured that the query will form a valid URL (all
                 reserved characters have been escaped). If true, this
                 method will escape the query and any URL parameters
                 provided.
  media_source: MediaSource (optional) Container for the media to be sent
      along with the entry, if provided.
  converter: func (optional) A function which will be executed on the 
      server's response. Often this is a function like 
      GDataEntryFromString which will parse the body of the server's 
      response and return a GDataEntry.
 
Returns:
  If the post succeeded, this method will return a GDataFeed, GDataEntry,
  or the results of running converter on the server's result body (if
  converter was specified).
ProgrammaticLogin(self, captcha_token=None, captcha_response=None)
Authenticates the user and sets the GData Auth token.
 
Login retreives a temporary auth token which must be used with all
requests to GData services. The auth token is stored in the GData client
object.
 
Login is also used to respond to a captcha challenge. If the user's login
attempt failed with a CaptchaRequired error, the user can respond by
calling Login with the captcha token and the answer to the challenge.
 
Args:
  captcha_token: string (optional) The identifier for the captcha challenge
                 which was presented to the user.
  captcha_response: string (optional) The user's answer to the captch 
                    challenge.
 
Raises:
  CaptchaRequired if the login service will require a captcha response
  BadAuthentication if the login service rejected the username or password
  Error if the login service responded with a 403 different from the above
Put(self, data, uri, extra_headers=None, url_params=None, escape_params=True, redirects_remaining=3, media_source=None, converter=None)
Updates an entry at the given URI.
 
Args:
  data: string, ElementTree._Element, or xml_wrapper.ElementWrapper The 
        XML containing the updated data.
  uri: string A URI indicating entry to which the update will be applied.
       Example: '/base/feeds/items/ITEM-ID'
  extra_headers: dict (optional) HTTP headers which are to be included.
                 The client automatically sets the Content-Type,
                 Authorization, and Content-Length headers.
  url_params: dict (optional) Additional URL parameters to be included
              in the URI. These are translated into query arguments
              in the form '&dict_key=value&...'.
              Example: {'max-results': '250'} becomes &max-results=250
  escape_params: boolean (optional) If false, the calling code has already
                 ensured that the query will form a valid URL (all
                 reserved characters have been escaped). If true, this
                 method will escape the query and any URL parameters
                 provided.
  converter: func (optional) A function which will be executed on the 
      server's response. Often this is a function like 
      GDataEntryFromString which will parse the body of the server's 
      response and return a GDataEntry.
 
Returns:
  If the put succeeded, this method will return a GDataFeed, GDataEntry,
  or the results of running converter on the server's result body (if
  converter was specified).
RevokeAuthSubToken(self)
Revokes an existing AuthSub token.
 
Raises:
  NonAuthSubToken if the user's auth token is not an AuthSub token
RevokeOAuthToken(self, request_url='https://www.google.com/accounts/AuthSubRevokeToken')
Revokes an existing OAuth token.
 
request_url: Token revoke URL. The default is
      'https://www.google.com/accounts/AuthSubRevokeToken'.
Raises:
  NonOAuthToken if the user's auth token is not an OAuth token.
  RevokingOAuthTokenFailed if request for revoking an OAuth token failed.
SetAuthSubToken(self, token, scopes=None, rsa_key=None)
Sets the token sent in requests to an AuthSub token.
 
Sets the current_token and attempts to add the token to the token_store.
 
Only use this method if you have received a token from the AuthSub
service. The auth token is set automatically when UpgradeToSessionToken()
is used. See documentation for Google AuthSub here:
http://code.google.com/apis/accounts/AuthForWebApps.html 
 
Args:
 token: gdata.auth.AuthSubToken or gdata.auth.SecureAuthSubToken or string
        The token returned by the AuthSub service. If the token is an
        AuthSubToken or SecureAuthSubToken, the scope information stored in
        the token is used. If the token is a string, the scopes parameter is
        used to determine the valid scopes.
 scopes: list of URLs for which the token is valid. This is only used
         if the token parameter is a string.
 rsa_key: string (optional) Private key required for RSA_SHA1 signature
          method.  This parameter is necessary if the token is a string
          representing a secure token.
SetClientLoginToken(self, token, scopes=None)
Sets the token sent in requests to a ClientLogin token.
 
This method sets the current_token to a new ClientLoginToken and it 
also attempts to add the ClientLoginToken to the token_store.
 
Only use this method if you have received a token from the ClientLogin
service. The auth_token is set automatically when ProgrammaticLogin()
is used. See documentation for Google ClientLogin here:
http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html
 
Args:
  token: string or instance of a ClientLoginToken.
SetOAuthInputParameters(self, signature_method, consumer_key, consumer_secret=None, rsa_key=None, two_legged_oauth=False, requestor_id=None)
Sets parameters required for using OAuth authentication mechanism.
 
NOTE: Though consumer_secret and rsa_key are optional, either of the two
is required depending on the value of the signature_method.
 
Args:
  signature_method: class which provides implementation for strategy class
      oauth.oauth.OAuthSignatureMethod. Signature method to be used for
      signing each request. Valid implementations are provided as the
      constants defined by gdata.auth.OAuthSignatureMethod. Currently
      they are gdata.auth.OAuthSignatureMethod.RSA_SHA1 and
      gdata.auth.OAuthSignatureMethod.HMAC_SHA1
  consumer_key: string Domain identifying third_party web application.
  consumer_secret: string (optional) Secret generated during registration.
      Required only for HMAC_SHA1 signature method.
  rsa_key: string (optional) Private key required for RSA_SHA1 signature
      method.
  two_legged_oauth: boolean (optional) Enables two-legged OAuth process.
  requestor_id: string (optional) User email adress to make requests on
      their behalf.  This parameter should only be set when two_legged_oauth
      is True.
SetOAuthToken(self, oauth_token)
Attempts to set the current token and add it to the token store.
 
The oauth_token can be any OAuth token i.e. unauthorized request token,
authorized request token or access token.
This method also attempts to add the token to the token store.
Use this method any time you want the current token to point to the
oauth_token passed. For e.g. call this method with the request token
you receive from FetchOAuthRequestToken.
 
Args:
  request_token: gdata.auth.OAuthToken OAuth request token.
UpgradeToOAuthAccessToken(self, authorized_request_token=None, request_url='https://www.google.com/accounts/OAuthGetAccessToken', oauth_version='1.0', oauth_verifier=None)
Upgrades the authorized request token to an access token and returns it
 
Args:
  authorized_request_token: gdata.auth.OAuthToken (optional) OAuth request
      token. If not specified, then the current token will be used if it is
      of type <gdata.auth.OAuthToken>, else it is found by looking in the
      token_store by looking for a token for the current scope.
  request_url: Access token URL. The default is
      'https://www.google.com/accounts/OAuthGetAccessToken'.
  oauth_version: str (default='1.0') oauth_version parameter. All other
      'oauth_' parameters are added by default. This parameter too, is
      added by default but here you can override it's value.
  oauth_verifier: str (optional) If present, it is assumed that the client
    will use the OAuth v1.0a protocol which includes passing the
    oauth_verifier (as returned by the SP) in the access token step.
 
Returns:
  Access token
      
Raises:
  NonOAuthToken if the user's authorized request token is not an OAuth
  token or if an authorized request token was not available.
  TokenUpgradeFailed if the server responded to the request with an 
  error.
UpgradeToSessionToken(self, token=None)
Upgrades a single use AuthSub token to a session token.
 
Args:
  token: A gdata.auth.AuthSubToken or gdata.auth.SecureAuthSubToken
         (optional) which is good for a single use but can be upgraded
         to a session token. If no token is passed in, the token
         is found by looking in the token_store by looking for a token
         for the current scope.
 
Raises:
  NonAuthSubToken if the user's auth token is not an AuthSub token
  TokenUpgradeFailed if the server responded to the request with an 
  error.
upgrade_to_session_token(self, token)
Upgrades a single use AuthSub token to a session token.
 
Args:
  token: A gdata.auth.AuthSubToken or gdata.auth.SecureAuthSubToken
         which is good for a single use but can be upgraded to a
         session token.
 
Returns:
  The upgraded token as a gdata.auth.AuthSubToken object.
 
Raises:
  TokenUpgradeFailed if the server responded to the request with an 
  error.

Data descriptors inherited from gdata.service.GDataService:
captcha_token
Get the captcha token for a login request.
captcha_url
Get the captcha URL for a login request.
source
The source is the name of the application making the request. 
It should be in the form company_id-app_name-app_version

Data and other attributes inherited from gdata.service.GDataService:
auth_token = None
handler = None
tokens = None

Methods inherited from atom.service.AtomService:
UseBasicAuth(self, username, password, for_proxy=False)
Sets an Authenticaiton: Basic HTTP header containing plaintext.
 
Deprecated, use use_basic_auth instead.
 
The username and password are base64 encoded and added to an HTTP header
which will be included in each request. Note that your username and 
password are sent in plaintext.
 
Args:
  username: str
  password: str
request(*args, **kwargs)
# The deprecated_function wraps the actual call to f.
use_basic_auth(self, username, password, scopes=None)

Data descriptors inherited from atom.service.AtomService:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
debug
If True, HTTP debug information is printed.
override_token

Data and other attributes inherited from atom.service.AtomService:
auto_set_current_token = True
auto_store_tokens = True
current_token = None
port = 80
ssl = False

 
Data
        API_VER = '2.0'
DEFAULT_QUOTA_LIMIT = '2048'
DOMAIN_ALIAS_LIMIT_EXCEEDED = 1201
DOMAIN_FEATURE_UNAVAILABLE = 1203
DOMAIN_SUSPENDED = 1202
DOMAIN_USER_LIMIT_EXCEEDED = 1200
ENTITY_DOES_NOT_EXIST = 1301
ENTITY_EXISTS = 1300
ENTITY_NAME_IS_RESERVED = 1302
ENTITY_NAME_NOT_VALID = 1303
HTTP_OK = 200
INVALID_EMAIL_ADDRESS = 1406
INVALID_FAMILY_NAME = 1401
INVALID_GIVEN_NAME = 1400
INVALID_HASH_DIGGEST_LENGTH = 1405
INVALID_HASH_FUNCTION_NAME = 1404
INVALID_PASSWORD = 1402
INVALID_QUERY_PARAMETER_VALUE = 1407
INVALID_USERNAME = 1403
TOO_MANY_RECIPIENTS_ON_EMAIL_LIST = 1500
UNKOWN_ERROR = 1000
USER_DELETED_RECENTLY = 1100
USER_SUSPENDED = 1101
__author__ = 'tmatsuo@sios.com (Takashi MATSUO)'

 
Author
        tmatsuo@sios.com (Takashi MATSUO)