intercom package¶
Subpackages¶
Submodules¶
intercom.collection_proxy module¶
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)¶
-
exception
intercom.errors.
BadGatewayError
(message=None, context=None)¶
-
exception
intercom.errors.
BadRequestError
(message=None, context=None)¶
-
exception
intercom.errors.
HttpError
(message=None, context=None)¶
-
exception
intercom.errors.
IntercomError
(message=None, context=None)¶ Bases:
exceptions.Exception
-
exception
intercom.errors.
MultipleMatchingUsersError
(message=None, context=None)¶
-
exception
intercom.errors.
RateLimitExceeded
(message=None, context=None)¶
-
exception
intercom.errors.
ResourceNotFound
(message=None, context=None)¶
-
exception
intercom.errors.
ResourceNotRestorable
(message=None, context=None)¶
-
exception
intercom.errors.
ServerError
(message=None, context=None)¶
-
exception
intercom.errors.
TokenNotFoundError
(message=None, context=None)¶
-
exception
intercom.errors.
UnexpectedError
(message=None, context=None)¶
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.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)¶