twilio.rest.api.v2010.account.sip.credential_list package

Submodules

twilio.rest.api.v2010.account.sip.credential_list.credential module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialContext(version, account_sid, credential_list_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

delete()[source]

Deletes the CredentialInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the CredentialInstance

Returns:The fetched CredentialInstance
Return type:twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialInstance
update(password=<object object>)[source]

Update the CredentialInstance

Parameters:password (unicode) – The password will not be returned in the response
Returns:The updated CredentialInstance
Return type:twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialInstance
class twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialInstance(version, payload, account_sid, credential_list_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The unique id of the Account that is responsible for this resource.
Return type:unicode
credential_list_sid
Returns:The unique id that identifies the credential list that includes this credential
Return type:unicode
date_created
Returns:The date that this resource was created, given as GMT in RFC 2822 format.
Return type:datetime
date_updated
Returns:The date that this resource was last updated, given as GMT in RFC 2822 format.
Return type:datetime
delete()[source]

Deletes the CredentialInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the CredentialInstance

Returns:The fetched CredentialInstance
Return type:twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialInstance
sid
Returns:A 34 character string that uniquely identifies this resource.
Return type:unicode
update(password=<object object>)[source]

Update the CredentialInstance

Parameters:password (unicode) – The password will not be returned in the response
Returns:The updated CredentialInstance
Return type:twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialInstance
uri
Returns:The URI for this resource, relative to https://api.twilio.com
Return type:unicode
username
Returns:The username for this credential.
Return type:unicode
class twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialList(version, account_sid, credential_list_sid)[source]

Bases: twilio.base.list_resource.ListResource

create(username, password)[source]

Create the CredentialInstance

Parameters:
  • username (unicode) – The username for this credential.
  • password (unicode) – The password will not be returned in the response.
Returns:

The created CredentialInstance

Return type:

twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialInstance

get(sid)[source]

Constructs a CredentialContext

Parameters:sid – The unique id that identifies the resource to fetch.
Returns:twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialContext
Return type:twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialContext
get_page(target_url)[source]

Retrieve a specific page of CredentialInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of CredentialInstance
Return type:twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialPage
list(limit=None, page_size=None)[source]

Lists CredentialInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialInstance]

page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of CredentialInstance records from the API. Request is executed immediately

Parameters:
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of CredentialInstance

Return type:

twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialPage

stream(limit=None, page_size=None)[source]

Streams CredentialInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialInstance]

class twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of CredentialInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialInstance
Return type:twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialInstance

Module contents

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.api.v2010.account.sip.credential_list.CredentialListContext(version, account_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

credentials

Access the credentials

Returns:twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialList
Return type:twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialList
delete()[source]

Deletes the CredentialListInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the CredentialListInstance

Returns:The fetched CredentialListInstance
Return type:twilio.rest.api.v2010.account.sip.credential_list.CredentialListInstance
update(friendly_name)[source]

Update the CredentialListInstance

Parameters:friendly_name (unicode) – Human readable descriptive text
Returns:The updated CredentialListInstance
Return type:twilio.rest.api.v2010.account.sip.credential_list.CredentialListInstance
class twilio.rest.api.v2010.account.sip.credential_list.CredentialListInstance(version, payload, account_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The unique sid that identifies this account
Return type:unicode
credentials

Access the credentials

Returns:twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialList
Return type:twilio.rest.api.v2010.account.sip.credential_list.credential.CredentialList
date_created
Returns:The date this resource was created
Return type:datetime
date_updated
Returns:The date this resource was last updated
Return type:datetime
delete()[source]

Deletes the CredentialListInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the CredentialListInstance

Returns:The fetched CredentialListInstance
Return type:twilio.rest.api.v2010.account.sip.credential_list.CredentialListInstance
friendly_name
Returns:Human readable descriptive text
Return type:unicode
sid
Returns:A string that uniquely identifies this credential
Return type:unicode
subresource_uris
Returns:The list of credentials associated with this credential list.
Return type:unicode
update(friendly_name)[source]

Update the CredentialListInstance

Parameters:friendly_name (unicode) – Human readable descriptive text
Returns:The updated CredentialListInstance
Return type:twilio.rest.api.v2010.account.sip.credential_list.CredentialListInstance
uri
Returns:The URI for this resource
Return type:unicode
class twilio.rest.api.v2010.account.sip.credential_list.CredentialListList(version, account_sid)[source]

Bases: twilio.base.list_resource.ListResource

create(friendly_name)[source]

Create the CredentialListInstance

Parameters:friendly_name (unicode) – Human readable descriptive text
Returns:The created CredentialListInstance
Return type:twilio.rest.api.v2010.account.sip.credential_list.CredentialListInstance
get(sid)[source]

Constructs a CredentialListContext

Parameters:sid – Fetch by unique credential list Sid
Returns:twilio.rest.api.v2010.account.sip.credential_list.CredentialListContext
Return type:twilio.rest.api.v2010.account.sip.credential_list.CredentialListContext
get_page(target_url)[source]

Retrieve a specific page of CredentialListInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of CredentialListInstance
Return type:twilio.rest.api.v2010.account.sip.credential_list.CredentialListPage
list(limit=None, page_size=None)[source]

Lists CredentialListInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.api.v2010.account.sip.credential_list.CredentialListInstance]

page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of CredentialListInstance records from the API. Request is executed immediately

Parameters:
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of CredentialListInstance

Return type:

twilio.rest.api.v2010.account.sip.credential_list.CredentialListPage

stream(limit=None, page_size=None)[source]

Streams CredentialListInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.api.v2010.account.sip.credential_list.CredentialListInstance]

class twilio.rest.api.v2010.account.sip.credential_list.CredentialListPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of CredentialListInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.sip.credential_list.CredentialListInstance
Return type:twilio.rest.api.v2010.account.sip.credential_list.CredentialListInstance