SalesPyForce Documentation¶
Welcome to the official documentation for the SalesPyForce package.
Table of Contents¶
- SalesPyForce Core Object
- Init Module (salespyforce)
Salesforce
Salesforce.Chatter
Salesforce.Knowledge
Salesforce.Knowledge.__init__()
Salesforce.Knowledge.assign_data_category()
Salesforce.Knowledge.check_for_existing_article()
Salesforce.Knowledge.create_article()
Salesforce.Knowledge.create_draft_from_master_version()
Salesforce.Knowledge.create_draft_from_online_article()
Salesforce.Knowledge.get_article_details()
Salesforce.Knowledge.get_article_id_from_number()
Salesforce.Knowledge.get_article_metadata()
Salesforce.Knowledge.get_article_url()
Salesforce.Knowledge.get_article_version()
Salesforce.Knowledge.get_articles_list()
Salesforce.Knowledge.get_validation_status()
Salesforce.Knowledge.publish_article()
Salesforce.Knowledge.publish_multiple_articles()
Salesforce.Knowledge.update_article()
Salesforce.__init__()
Salesforce.api_call_with_payload()
Salesforce.connect()
Salesforce.create_sobject_record()
Salesforce.describe_object()
Salesforce.download_image()
Salesforce.get()
Salesforce.get_all_sobjects()
Salesforce.get_api_versions()
Salesforce.get_org_limits()
Salesforce.get_rest_resources()
Salesforce.get_sobject()
Salesforce.patch()
Salesforce.post()
Salesforce.put()
Salesforce.search_string()
Salesforce.soql_query()
Salesforce.update_sobject_record()
- Core Module (salespyforce.core)
Salesforce
Salesforce.Chatter
Salesforce.Knowledge
Salesforce.Knowledge.__init__()
Salesforce.Knowledge.assign_data_category()
Salesforce.Knowledge.check_for_existing_article()
Salesforce.Knowledge.create_article()
Salesforce.Knowledge.create_draft_from_master_version()
Salesforce.Knowledge.create_draft_from_online_article()
Salesforce.Knowledge.get_article_details()
Salesforce.Knowledge.get_article_id_from_number()
Salesforce.Knowledge.get_article_metadata()
Salesforce.Knowledge.get_article_url()
Salesforce.Knowledge.get_article_version()
Salesforce.Knowledge.get_articles_list()
Salesforce.Knowledge.get_validation_status()
Salesforce.Knowledge.publish_article()
Salesforce.Knowledge.publish_multiple_articles()
Salesforce.Knowledge.update_article()
Salesforce.__init__()
Salesforce.api_call_with_payload()
Salesforce.connect()
Salesforce.create_sobject_record()
Salesforce.describe_object()
Salesforce.download_image()
Salesforce.get()
Salesforce.get_all_sobjects()
Salesforce.get_api_versions()
Salesforce.get_org_limits()
Salesforce.get_rest_resources()
Salesforce.get_sobject()
Salesforce.patch()
Salesforce.post()
Salesforce.put()
Salesforce.search_string()
Salesforce.soql_query()
Salesforce.update_sobject_record()
compile_connection_info()
define_connection_info()
- Core Functionality Subclasses (salespyforce.core.Salesforce)
- Init Module (salespyforce)
- Primary Modules
- Init Module (salespyforce)
- Core Module (salespyforce.core)
- API Module (salespyforce.api)
- Chatter Module (salespyforce.chatter)
- Knowledge Module (salespyforce.knowledge)
assign_data_category()
check_for_existing_article()
create_article()
create_draft_from_master_version()
create_draft_from_online_article()
get_article_details()
get_article_id_from_number()
get_article_metadata()
get_article_url()
get_article_version()
get_articles_list()
get_validation_status()
publish_article()
publish_multiple_articles()
update_article()
- Supporting Modules
- Classes & Exceptions
- Errors Module (salespyforce.errors)
- Exceptions Module (salespyforce.errors.exceptions)
APIConnectionError
APIRequestError
CurrentlyUnsupportedError
DELETERequestError
DataMismatchError
FeatureNotConfiguredError
GETRequestError
HelperFunctionNotFoundError
InvalidEndpointError
InvalidFieldError
InvalidHelperArgumentsError
InvalidHelperFileTypeError
InvalidLookupTypeError
InvalidParameterError
InvalidPayloadValueError
InvalidRequestTypeError
InvalidURLError
LookupMismatchError
MissingRequiredDataError
NotFoundResponseError
POSTRequestError
PUTRequestError
PayloadMismatchError
SalesPyForceError
UnknownFileTypeError
- Handlers Module (salespyforce.errors.handlers)
- Exceptions Module (salespyforce.errors.exceptions)
- Errors Module (salespyforce.errors)
- Tools & Utilities
- Unit Testing
- Tests Module (salespyforce.utils.tests)
- Resources Module (salespyforce.utils.tests.resources)
- Test Instantiate Object Module (salespyforce.utils.tests.test_instantiate_object)
- Test sObjects Module (salespyforce.utils.tests.test_sobjects)
- Test SOQL Module (salespyforce.utils.tests.test_soql)
- Test SOSL Module (salespyforce.utils.tests.test_sosl)
- Tests Module (salespyforce.utils.tests)
- Classes & Exceptions