salespyforce 1.2.2rc1__tar.gz → 1.3.0__tar.gz

{salespyforce-1.2.2rc1/src/salespyforce.egg-info → salespyforce-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: salespyforce
-Version: 1.2.2rc1
+Version: 1.3.0
 Summary: A Python toolset for performing Salesforce API calls
 Home-page: https://github.com/jeffshurtliff/salespyforce
 Author: Jeff Shurtliff
@@ -45,7 +45,7 @@ A Python toolset for performing Salesforce API calls
         <td>Latest Beta/RC Release</td>
         <td>
             <a href='https://pypi.org/project/salespyforce/#history'>
-                <img alt="PyPI" src="https://img.shields.io/badge/pypi-1.0.0b1-blue">
+                <img alt="PyPI" src="https://img.shields.io/badge/pypi-1.3.0rc3-blue">
             </a>
         </td>
     </tr>

{salespyforce-1.2.2rc1 → salespyforce-1.3.0}/README.md

@@ -14,7 +14,7 @@ A Python toolset for performing Salesforce API calls
         <td>Latest Beta/RC Release</td>
         <td>
             <a href='https://pypi.org/project/salespyforce/#history'>
-                <img alt="PyPI" src="https://img.shields.io/badge/pypi-1.0.0b1-blue">
+                <img alt="PyPI" src="https://img.shields.io/badge/pypi-1.3.0rc3-blue">
             </a>
         </td>
     </tr>

{salespyforce-1.2.2rc1 → salespyforce-1.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "salespyforce"
-version = "1.2.2rc1"
+version = "1.3.0rc3"
 description = "A Python toolset for performing Salesforce API calls"
 authors = ["Jeff Shurtliff <jeff.shurtliff@rsa.com>"]
 license = "MIT"

{salespyforce-1.2.2rc1 → salespyforce-1.3.0}/src/salespyforce/core.py

@@ -6,9 +6,11 @@
 :Example:           ``sfdc = Salesforce()``
 :Created By:        Jeff Shurtliff
 :Last Modified:     Jeff Shurtliff
-:Modified Date:     01 Sep 2023
+:Modified Date:     22 Nov 2023
 """
 
+import re
+
 import requests
 
 from . import api, errors
@@ -319,7 +321,7 @@ class Salesforce(object):
         """
         return self.get(f'/services/data/{self.version}')
 
-    def soql_query(self, query, replace_quotes=True):
+    def soql_query(self, query, replace_quotes=True, next_records_url=False):
         """This method performs a SOQL query and returns the results in JSON format.
         (`Reference 1 <https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_query.htm>`_,
         `Reference 2 <https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/knowledge_development_soql_sosl_intro.htm>`_)
@@ -328,12 +330,18 @@ class Salesforce(object):
         :type query: str
         :param replace_quotes: Determines if double-quotes should be replaced with single-quotes (``True`` by default)
         :type replace_quotes: bool
+        :param next_records_url: Indicates that the ``query`` parameter is a ``nextRecordsUrl`` value.
+        :type next_records_url: bool
         :returns: The result of the SOQL query
         """
-        if replace_quotes:
-            query = query.replace('"', "'")
-        query = core_utils.url_encode(query)
-        return self.get(f'/services/data/{self.version}/query/?q={query}')
+        if next_records_url:
+            query = re.sub(r'^.*/', '', query) if '/' in query else query
+        else:
+            if replace_quotes:
+                query = query.replace('"', "'")
+            query = core_utils.url_encode(query)
+            query = f'?q={query}'
+        return self.get(f'/services/data/{self.version}/query/{query}')
 
     def search_string(self, string_to_search):
         """This method performs a SOSL query to search for a given string.
@@ -773,6 +781,19 @@ class Salesforce(object):
                                                          category_group_name=category_group_name,
                                                          category_name=category_name)
 
+        def archive_article(self, article_id):
+            """This function archives a published knowledge article.
+            (`Reference <https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/knowledge_REST_archive_master_version.htm>`_)
+
+            .. versionadded:: 1.3.0
+
+            :param article_id: The ID of the article to archive
+            :type article_id: str
+            :returns: The API response from the POST request
+            :raises: :py:exc:`RuntimeError`
+            """
+            return knowledge_module.archive_article(self.sfdc_object, article_id=article_id)
+
 
 def define_connection_info():
     """This function prompts the user for the connection information.

{salespyforce-1.2.2rc1 → salespyforce-1.3.0}/src/salespyforce/knowledge.py

@@ -4,7 +4,7 @@
 :Synopsis:          Defines the Knowledge-related functions associated with the Salesforce API
 :Created By:        Jeff Shurtliff
 :Last Modified:     Jeff Shurtliff
-:Modified Date:     01 Sep 2023
+:Modified Date:     14 Nov 2023
 """
 
 from . import errors
@@ -507,3 +507,25 @@ def assign_data_category(sfdc_object, article_id, category_group_name, category_
     endpoint = f'/services/data/{sfdc_object.version}/sobjects/Knowledge__DataCategorySelection'
     return sfdc_object.post(endpoint, payload)
 
+
+def archive_article(sfdc_object, article_id):
+    """This function archives a published knowledge article.
+    (`Reference <https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/knowledge_REST_archive_master_version.htm>`_)
+
+    .. versionadded:: 1.3.0
+
+    :param sfdc_object: The instantiated SalesPyForce object
+    :type sfdc_object: class[salespyforce.Salesforce]
+    :param article_id: The ID of the article to archive
+    :type article_id: str
+    :returns: The API response from the POST request
+    :raises: :py:exc:`RuntimeError`
+    """
+    # Define the payload for the API call
+    payload = {
+        "publishStatus": "Archived"
+    }
+
+    # Perform the API call
+    endpoint = f'/services/data/{sfdc_object.version}/knowledgeManagement/articleVersions/masterVersions/{article_id}'
+    return sfdc_object.patch(endpoint, payload)

{salespyforce-1.2.2rc1 → salespyforce-1.3.0}/src/salespyforce/utils/version.py

@@ -4,7 +4,7 @@
 :Synopsis:          This simple script contains the package version
 :Created By:        Jeff Shurtliff
 :Last Modified:     Jeff Shurtliff
-:Modified Date:     05 Sep 2023
+:Modified Date:     11 Nov 2025
 """
 
 from . import log_utils
@@ -13,7 +13,7 @@ from . import log_utils
 logger = log_utils.initialize_logging(__name__)
 
 # Define special and global variables
-__version__ = "1.2.2rc1"
+__version__ = "1.3.0"
 
 
 def get_full_version():

{salespyforce-1.2.2rc1 → salespyforce-1.3.0/src/salespyforce.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: salespyforce
-Version: 1.2.2rc1
+Version: 1.3.0
 Summary: A Python toolset for performing Salesforce API calls
 Home-page: https://github.com/jeffshurtliff/salespyforce
 Author: Jeff Shurtliff
@@ -45,7 +45,7 @@ A Python toolset for performing Salesforce API calls
         <td>Latest Beta/RC Release</td>
         <td>
             <a href='https://pypi.org/project/salespyforce/#history'>
-                <img alt="PyPI" src="https://img.shields.io/badge/pypi-1.0.0b1-blue">
+                <img alt="PyPI" src="https://img.shields.io/badge/pypi-1.3.0rc3-blue">
             </a>
         </td>
     </tr>