SalesPyForce Documentation

Welcome to the official documentation for the SalesPyForce package.

Table of Contents

• Change Log
  • v1.4.0
  • v1.3.0
  • v1.2.2
  • v1.2.1
  • v1.2.0
  • v1.1.2
  • v1.1.1
  • v1.1.0

• SalesPyForce Core Object
  • Init Module (salespyforce)
    • Salesforce
      • Salesforce.Chatter
        • Salesforce.Chatter.__init__()
        • Salesforce.Chatter.get_group_feed()
        • Salesforce.Chatter.get_my_news_feed()
        • Salesforce.Chatter.get_user_news_feed()
        • Salesforce.Chatter.post_comment()
        • Salesforce.Chatter.post_feed_item()
      • Salesforce.Knowledge
        • Salesforce.Knowledge.__init__()
        • Salesforce.Knowledge.archive_article()
        • 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.delete_article_draft()
        • 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.can_access_record()
      • Salesforce.can_delete_record()
      • Salesforce.can_edit_record()
      • Salesforce.can_read_record()
      • Salesforce.check_user_record_access()
      • Salesforce.connect()
      • Salesforce.create_sobject_record()
      • Salesforce.delete()
      • Salesforce.describe_object()
      • Salesforce.download_image()
      • Salesforce.get()
      • Salesforce.get_18_char_id()
      • Salesforce.get_all_sobjects()
      • Salesforce.get_api_versions()
      • Salesforce.get_latest_api_version()
      • Salesforce.get_org_limits()
      • Salesforce.get_rest_resources()
      • Salesforce.get_sobject()
      • Salesforce.patch()
      • Salesforce.post()
      • Salesforce.put()
      • Salesforce.retrieve_current_user_info()
      • Salesforce.search_string()
      • Salesforce.soql_query()
      • Salesforce.update_sobject_record()
  • Core Module (salespyforce.core)
    • Salesforce
      • Salesforce.Chatter
        • Salesforce.Chatter.__init__()
        • Salesforce.Chatter.get_group_feed()
        • Salesforce.Chatter.get_my_news_feed()
        • Salesforce.Chatter.get_user_news_feed()
        • Salesforce.Chatter.post_comment()
        • Salesforce.Chatter.post_feed_item()
      • Salesforce.Knowledge
        • Salesforce.Knowledge.__init__()
        • Salesforce.Knowledge.archive_article()
        • 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.delete_article_draft()
        • 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.can_access_record()
      • Salesforce.can_delete_record()
      • Salesforce.can_edit_record()
      • Salesforce.can_read_record()
      • Salesforce.check_user_record_access()
      • Salesforce.connect()
      • Salesforce.create_sobject_record()
      • Salesforce.delete()
      • Salesforce.describe_object()
      • Salesforce.download_image()
      • Salesforce.get()
      • Salesforce.get_18_char_id()
      • Salesforce.get_all_sobjects()
      • Salesforce.get_api_versions()
      • Salesforce.get_latest_api_version()
      • Salesforce.get_org_limits()
      • Salesforce.get_rest_resources()
      • Salesforce.get_sobject()
      • Salesforce.patch()
      • Salesforce.post()
      • Salesforce.put()
      • Salesforce.retrieve_current_user_info()
      • Salesforce.search_string()
      • Salesforce.soql_query()
      • Salesforce.update_sobject_record()
    • compile_connection_info()
    • define_connection_info()
    • Core Functionality Subclasses (salespyforce.core.Salesforce)
      • Chatter Subclass (salespyforce.core.Salesforce.Chatter)
      • Knowledge Subclass (salespyforce.core.Salesforce.Knowledge)
• Primary Modules
  • Init Module (salespyforce)
  • Core Module (salespyforce.core)
  • API Module (salespyforce.api)
    • api_call_with_payload()
    • delete()
    • get()
  • Chatter Module (salespyforce.chatter)
    • get_group_feed()
    • get_my_news_feed()
    • get_user_news_feed()
    • post_comment()
    • post_feed_item()
  • Knowledge Module (salespyforce.knowledge)
    • archive_article()
    • assign_data_category()
    • check_for_existing_article()
    • create_article()
    • create_draft_from_master_version()
    • create_draft_from_online_article()
    • delete_article_draft()
    • 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)
        • display_warning()
        • eprint()
        • get_exception_type()
  • Tools & Utilities
    • Core Utilities Module (salespyforce.utils.core_utils)
      • display_warning()
      • download_image()
      • get_18_char_id()
      • get_file_type()
      • get_image_ref_id()
      • get_random_string()
      • is_valid_salesforce_url()
      • matches_regex_pattern()
      • url_decode()
      • url_encode()
    • Helper Module (salespyforce.utils.helper)
      • HelperParsing
      • get_helper_settings()
      • import_helper_file()
    • Logging Utilities Module (salespyforce.utils.log_utils)
      • LessThanFilter
        • LessThanFilter.filter()
      • initialize_logging()
    • Version Module (salespyforce.utils.version)
      • get_full_version()
      • get_major_minor_version()
  • Unit Testing
    • Tests Module (salespyforce.utils.tests)
      • Resources Module (salespyforce.utils.tests.resources)
      • Test Instantiate Object Module (salespyforce.utils.tests.test_instantiate_object)
        • test_get_api_versions()
        • test_get_org_limits()
        • test_get_rest_resources()
        • test_instantiate_core_object()
      • Test sObjects Module (salespyforce.utils.tests.test_sobjects)
      • Test SOQL Module (salespyforce.utils.tests.test_soql)
        • test_soql_query()
      • Test SOSL Module (salespyforce.utils.tests.test_sosl)

Module Index and Search

• Index

• Module Index

• Search Page