intercom package

Subpackages

• intercom.api_operations package
  • Submodules
  • intercom.api_operations.all module
  • intercom.api_operations.count module
  • intercom.api_operations.delete module
  • intercom.api_operations.find module
  • intercom.api_operations.find_all module
  • intercom.api_operations.load module
  • intercom.api_operations.save module
  • Module contents
• intercom.extended_api_operations package
  • Submodules
  • intercom.extended_api_operations.reply module
  • intercom.extended_api_operations.users module
  • Module contents
• intercom.generic_handlers package
  • Submodules
  • intercom.generic_handlers.base_handler module
  • intercom.generic_handlers.count module
  • intercom.generic_handlers.tag module
  • intercom.generic_handlers.tag_find_all module
  • Module contents
• intercom.lib package
  • Submodules
  • intercom.lib.flat_store module
  • intercom.lib.setter_property module
  • intercom.lib.typed_json_deserializer module
  • Module contents
• intercom.traits package
  • Submodules
  • intercom.traits.api_resource module
  • intercom.traits.incrementable_attributes module
  • Module contents

Submodules

intercom.admin module

class intercom.admin.Admin(_self, *args, **params)

Bases: intercom.traits.api_resource.Resource

intercom.collection_proxy module

class intercom.collection_proxy.CollectionProxy(client, collection_cls, collection, finder_url, finder_params={})

Bases: six.Iterator

extract_next_link(response)

get_first_page()

get_next_page()

get_page(url, params={})

paging_info_present(response)

intercom.company module

class intercom.company.Company(_self, *args, **params)

Bases: intercom.traits.api_resource.Resource

flat_store_attributes

identity_vars = ['id', 'company_id']

update_verb = 'post'

intercom.conversation module

Collection module for Conversations.

class intercom.conversation.Conversation(_self, *args, **params)

Bases: intercom.traits.api_resource.Resource

Collection class for Converations.

intercom.count module

Count Resource.

class intercom.count.Count(_self, *args, **params)

Bases: intercom.traits.api_resource.Resource

Collection class for Counts.

intercom.errors module

exception intercom.errors.ArgumentError

Bases: exceptions.ValueError, intercom.errors.IntercomError

exception intercom.errors.AuthenticationError(message=None, context=None)

Bases: intercom.errors.IntercomError

exception intercom.errors.BadGatewayError(message=None, context=None)

Bases: intercom.errors.IntercomError

exception intercom.errors.BadRequestError(message=None, context=None)

Bases: intercom.errors.IntercomError

exception intercom.errors.HttpError(message=None, context=None)

Bases: intercom.errors.IntercomError

exception intercom.errors.IntercomError(message=None, context=None)

Bases: exceptions.Exception

exception intercom.errors.MultipleMatchingUsersError(message=None, context=None)

Bases: intercom.errors.IntercomError

exception intercom.errors.RateLimitExceeded(message=None, context=None)

Bases: intercom.errors.IntercomError

exception intercom.errors.ResourceNotFound(message=None, context=None)

Bases: intercom.errors.IntercomError

exception intercom.errors.ResourceNotRestorable(message=None, context=None)

Bases: intercom.errors.IntercomError

exception intercom.errors.ServerError(message=None, context=None)

Bases: intercom.errors.IntercomError

exception intercom.errors.ServiceUnavailableError(message=None, context=None)

Bases: intercom.errors.IntercomError

exception intercom.errors.TokenNotFoundError(message=None, context=None)

Bases: intercom.errors.IntercomError

exception intercom.errors.TokenUnauthorizedError(message=None, context=None)

Bases: intercom.errors.IntercomError

exception intercom.errors.UnexpectedError(message=None, context=None)

Bases: intercom.errors.IntercomError

intercom.event module

class intercom.event.Event(_self, *args, **params)

Bases: intercom.traits.api_resource.Resource

intercom.message module

class intercom.message.Message(_self, *args, **params)

Bases: intercom.traits.api_resource.Resource

intercom.note module

class intercom.note.Note(_self, *args, **params)

Bases: intercom.traits.api_resource.Resource

intercom.notification module

class intercom.notification.Notification(_self, *args, **params)

Bases: intercom.traits.api_resource.Resource

load

model

model_type

intercom.request module

class intercom.request.Request(http_method, path, http_session=None)

Bases: object

execute(base_url, auth, params)

message_for_unexpected_error_with_type(error_details, http_code)

message_for_unexpected_error_without_type(error_details, http_code)

parse_body(resp)

raise_application_errors_on_failure(error_list_details, http_code)

raise_errors_on_failure(resp)

send_request_to_path(base_url, auth, params=None)

Construct an API request, send it to the API, and parse the response.

set_rate_limit_details(resp)

timeout = 90

class intercom.request.ResourceEncoder(skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, encoding='utf-8', default=None)

Bases: json.encoder.JSONEncoder

default(o)

intercom.request.configure_timeout()

Configure the request timeout.

intercom.segment module

class intercom.segment.Segment(_self, *args, **params)

Bases: intercom.traits.api_resource.Resource

intercom.subscription module

class intercom.subscription.Subscription(_self, *args, **params)

Bases: intercom.traits.api_resource.Resource

intercom.tag module

class intercom.tag.Tag(_self, *args, **params)

Bases: intercom.traits.api_resource.Resource

intercom.user module

class intercom.user.User(_self, *args, **params)

Bases: intercom.traits.api_resource.Resource, intercom.traits.incrementable_attributes.IncrementableAttributes

flat_store_attributes

identity_vars = ['id', 'email', 'user_id']

update_verb = 'post'

intercom.utils module

intercom.utils.constantize_singular_resource_name(resource_name)

intercom.utils.define_lightweight_class(resource_name, class_name)

Return a lightweight class for deserialized payload objects.

intercom.utils.entity_key_from_type(type)

intercom.utils.pluralize(str)

intercom.utils.resource_class_to_collection_name(cls)

intercom.utils.resource_class_to_name(cls)

Module contents