contentstack-management 1.3.3__tar.gz → 1.4.0__tar.gz

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: contentstack-management
-Version: 1.3.3
+Version: 1.4.0
 Summary: Contentstack API Client Library for Python
 Home-page: https://github.com/contentstack/contentstack-management-python
-Author: ishaileshmishra
+Author: dev-ex
 Author-email: mobile@contentstack.com
 License: MIT
 Classifier: License :: OSI Approved :: MIT License

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/__init__.py

@@ -69,10 +69,10 @@ __all__ = (
 )
 
 __title__ = 'contentstack-management-python'
-__author__ = 'ishaileshmishra'
+__author__ = 'dev-ex'
 __status__ = 'debug'
 __region__ = 'na'
-__version__ = '1.3.3'
+__version__ = '1.4.0'
 __host__ = 'api.contentstack.io'
 __protocol__ = 'https://'
 __api_version__ = 'v3'

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/auditlogs/auditlog.py

@@ -3,9 +3,7 @@ which is the endpoint for the RESTFUL API that we'll be interacting with.
 The create(), read(), update(), and delete() methods each correspond to 
 the CRUD operations that can be performed on the API """
 
-import json
 from ..common import Parameter
-from urllib.parse import quote
 from .._errors import ArgumentException
 
 class Auditlog(Parameter):

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/bulk_operations/bulk_operation.py

@@ -227,4 +227,96 @@ class BulkOperation(Parameter):
         data = json.dumps(data)
         return self.client.post(url, headers = self.client.headers, data = data, params=self.params)
     
+    def add_items(self, data: dict, headers: dict = None):
+        """
+        The Add items to bulk operation request allows you to add multiple entries and assets to a bulk operation.
+        
+        :return: The `add_items` method is returning the result of the `post` request made by the
+        `client.post` method.
+        -------------------------------
+            [Example:]
+                >>> data = {
+                >>>        "release": "release_uid"
+                >>>        "action": "publish",
+                >>>        "locale": ["en-us", "hi-in"]
+                >>>        "reference": true
+                >>>        "items": [
+                >>>            {
+                >>>            "uid": "blt63177c0f00f20b61",
+                >>>            "content_type_uid": "my_blog"
+                >>>            }
+                >>>        ]
+                >>>  }
+                >>> import contentstack_management
+                >>> client = contentstack_management.Client(authtoken='your_authtoken')
+                >>> result = client.stack('api_key').bulk_operation().add_items(data).json()
+
+        -------------------------------
+        """
+        if headers is not None:
+            self.client.headers.update(headers)
+        url = f"{self.path}/release/items"
+        data = json.dumps(data)
+        return self.client.post(url, headers = self.client.headers, data = data, params=self.params)
+    
+    def update_items(self, data: dict, headers: dict = None):
+        """
+        The update items to bulk operation request allows you to update multiple entries and assets to a bulk operation.
+        
+        :return: The `update_items` method is returning the result of the `put` request made by the
+        `client.post` method.
+        -------------------------------
+            [Example:]
+                >>> data = {
+                >>>        "release": "release_uid",
+                >>>        "items": [
+                >>>            {
+                >>>                "uid": "entry_uid",
+                >>>                "locale": "en-us"
+                >>>            },
+                >>>            {
+                >>>                "uid": "entry_uid",
+                >>>                "locale": "en-us",
+                >>>                "variant_id": "entry_variant_id"
+                >>>            }
+                >>>        ]
+                >>>        or
+                >>>        [ '$all' ]
+                >>>    }
+                >>> import contentstack_management
+                >>> client = contentstack_management.Client(authtoken='your_authtoken')
+                >>> result = client.stack('api_key').bulk_operation().update_items(data).json()
+
+        -------------------------------
+        """
+        if headers is not None:
+            self.client.headers.update(headers)
+        url = f"{self.path}/release/update_items"
+        data = json.dumps(data)
+        return self.client.put(url, headers = self.client.headers, data = data, params=self.params)
+    
+    def job_status(self, job_uid: str, headers: dict = None):
+        """
+        The Job status request allows you to get the status of a bulk operation job.
+        
+        :param job_uid: The `job_uid` parameter is a string that represents the unique identifier of the job
+        whose status you want to retrieve
+        :type job_uid: str
+        :return: The `job_status` method is returning the result of the `get` request made by the
+        `client.get` method.
+        -------------------------------
+            [Example:]
+                >>> import contentstack_management
+                >>> client = contentstack_management.Client(authtoken='your_authtoken')
+                >>> result = client.stack('api_key').bulk_operation().job_status('job_uid').json()
+
+        -------------------------------
+        """
+        if job_uid is None:
+            raise ArgumentException("job_uid", "job_uid cannot be None")
+        if headers is not None:
+            self.client.headers.update(headers)
+        url = f"{self.path}/jobs/{quote(job_uid)}"
+        return self.client.get(url, headers = self.client.headers, params=self.params)
+    
     

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/content_types/content_type.py

@@ -340,7 +340,7 @@ class ContentType(Parameter):
             >>> response = content_type.imports()
         --------------------------------
         """
-        url = f"content_types/import"
+        url = "content_types/import"
         self.client.headers['Content-Type'] = "multipart/form-data"
         files = {'content_type': open(f"{file_path}", 'rb')}
         return self.client.post(url, headers=self.client.headers, params=self.params, files=files)

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/contentstack.py

@@ -1,4 +1,3 @@
-import contentstack_management
 from enum import Enum
 from ._api_client import _APIClient
 from contentstack_management.organizations import organization

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/delivery_token/delivery_token.py

@@ -5,7 +5,6 @@ the CRUD operations that can be performed on the API """
 
 import json
 from ..common import Parameter
-from urllib.parse import quote
 from .._errors import ArgumentException
 
 class DeliveryToken(Parameter):

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/environments/environment.py

@@ -5,7 +5,6 @@ the CRUD operations that can be performed on the API """
 
 import json
 from ..common import Parameter
-from urllib.parse import quote
 from .._errors import ArgumentException
 
 class Environment(Parameter):

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/extensions/extension.py

@@ -5,7 +5,6 @@ the CRUD operations that can be performed on the API """
 
 import json
 from ..common import Parameter
-from urllib.parse import quote
 from .._errors import ArgumentException
 from requests_toolbelt.multipart.encoder import MultipartEncoder
 

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/global_fields/global_fields.py

@@ -18,10 +18,13 @@ class GlobalFields(Parameter):
     methods each correspond to the CRUD 
     operations that can be performed on the API """
 
-    def __init__(self, client, global_field_uid=None):
+    def __init__(self, client, global_field_uid=None, options=None):
         self.client = client
         self.global_field_uid = global_field_uid
+        self.options = options
         super().__init__(self.client)
+        if self.options and 'api_version' in self.options:
+            Parameter.add_header(self, 'api_version', str(self.options['api_version']))
 
     def find(self):
         """
@@ -34,7 +37,12 @@ class GlobalFields(Parameter):
             >>> result = client.stack("api_key").global_fields('global_field_uid').find().json()
         -------------------------------
         """
-        return self.client.get(_path, headers=self.client.headers, params = self.params)
+        response = self.client.get(_path, headers=self.client.headers, params = self.params)
+        # Remove the api_version header after request
+        if self.options and 'api_version' in self.options:
+            self.client.headers.pop('api_version', None)
+        
+        return response
 
     def fetch(self):
         """
@@ -50,7 +58,12 @@ class GlobalFields(Parameter):
         -------------------------------
         """
         url = f"{_path}/{self.global_field_uid}"
-        return self.client.get(url, headers=self.client.headers, params = self.params)
+        response =  self.client.get(url, headers=self.client.headers, params = self.params)
+        # Remove the api_version header after request
+        if self.options and 'api_version' in self.options:
+            self.client.headers.pop('api_version', None)
+        
+        return response
 
     def create(self, data):
         """
@@ -74,7 +87,12 @@ class GlobalFields(Parameter):
         -------------------------------
         """
         data = json.dumps(data)
-        return self.client.post(_path, headers=self.client.headers, data=data, params = self.params)
+        response = self.client.post(_path, headers=self.client.headers, data=data, params = self.params)
+        # Remove the api_version header after request
+        if self.options and 'api_version' in self.options:
+            self.client.headers.pop('api_version', None)
+        
+        return response
 
     def update(self, data):
         """
@@ -99,7 +117,12 @@ class GlobalFields(Parameter):
         """
         url = f"{_path}/{self.global_field_uid}"
         data = json.dumps(data)
-        return self.client.put(url, headers=self.client.headers, params=self.params, data=data)
+        response = self.client.put(url, headers=self.client.headers, params=self.params, data=data)
+        # Remove the api_version header after request
+        if self.options and 'api_version' in self.options:
+            self.client.headers.pop('api_version', None)
+        
+        return response
 
     def delete(self):
         """
@@ -114,7 +137,12 @@ class GlobalFields(Parameter):
         -------------------------------
         """
         url = f"{_path}/{self.global_field_uid}"
-        return self.client.delete(url, headers=self.client.headers, params=self.params)
+        response = self.client.delete(url, headers=self.client.headers, params=self.params)
+        # Remove the api_version header after request
+        if self.options and 'api_version' in self.options:
+            self.client.headers.pop('api_version', None)
+        
+        return response
 
     def imports(self, file_path):
         """
@@ -131,7 +159,12 @@ class GlobalFields(Parameter):
         """
         self.client.headers['Content-Type'] = "multipart/form-data"
         files = {'global_field': open(f"{file_path}", 'rb')}
-        return self.client.post('global_fields/import', headers=self.client.headers, params=self.params, files=files)
+        response = self.client.post('global_fields/import', headers=self.client.headers, params=self.params, files=files)
+        # Remove the api_version header after request
+        if self.options and 'api_version' in self.options:
+            self.client.headers.pop('api_version', None)
+        
+        return response
 
     def export(self):
         """
@@ -148,4 +181,9 @@ class GlobalFields(Parameter):
         if self.global_field_uid is None or '':
             raise Exception('global_field_uid is required')
         url = f"{_path}/{self.global_field_uid}/export"
-        return self.client.get(url, headers=self.client.headers, params=self.params)
+        response = self.client.get(url, headers=self.client.headers, params=self.params)
+        # Remove the api_version header after request
+        if self.options and 'api_version' in self.options:
+            self.client.headers.pop('api_version', None)
+        
+        return response

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/labels/label.py

@@ -5,7 +5,6 @@ the CRUD operations that can be performed on the API """
 
 import json
 from ..common import Parameter
-from urllib.parse import quote
 from .._errors import ArgumentException
 
 class Label(Parameter):

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/locale/locale.py

@@ -5,7 +5,6 @@ the CRUD operations that can be performed on the API """
 
 import json
 from ..common import Parameter
-from urllib.parse import quote
 from .._errors import ArgumentException
 
 class Locale(Parameter):

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/management_token/management_token.py

@@ -5,7 +5,6 @@ the CRUD operations that can be performed on the API """
 
 import json
 from ..common import Parameter
-from urllib.parse import quote
 from .._errors import ArgumentException
 
 class ManagementToken(Parameter):

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/metadata/metadata.py

@@ -5,7 +5,6 @@ the CRUD operations that can be performed on the API """
 
 import json
 from ..common import Parameter
-from urllib.parse import quote
 from .._errors import ArgumentException
 
 class Metadata(Parameter):

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/publish_queue/publish_queue.py

@@ -3,9 +3,7 @@ which is the endpoint for the RESTFUL API that we'll be interacting with.
 The create(), read(), update(), and delete() methods each correspond to 
 the CRUD operations that can be performed on the API """
 
-import json
 from ..common import Parameter
-from urllib.parse import quote
 from .._errors import ArgumentException
 
 class PublishQueue(Parameter):

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/release_items/release_item.py

@@ -5,7 +5,6 @@ the CRUD operations that can be performed on the API """
 
 import json
 from ..common import Parameter
-from urllib.parse import quote
 from .._errors import ArgumentException
 
 class ReleaseItems(Parameter):
@@ -16,11 +15,13 @@ class ReleaseItems(Parameter):
     methods each correspond to the CRUD 
     operations that can be performed on the API """
 
-    def __init__(self, client, release_uid: str):
+    def __init__(self, client, release_uid: str, headers: dict = None):
         self.client = client
         self.release_uid = release_uid
         super().__init__(self.client)
         self.path = f"releases/{self.release_uid}"
+        if headers:
+            self.add_header_dict(headers)
 
     def find(self):
         """
@@ -204,6 +205,46 @@ class ReleaseItems(Parameter):
         data = json.dumps(data)
         return self.client.delete(url, headers = self.client.headers, data=data, params = self.params)
     
+    def move(self, data: dict):
+        """
+        The "Move items to a different Release" request allows you to move one or more items (entries and/or assets) from one Release to another Release.
+        
+        :param data: The `data` parameter is a dictionary that contains the data to be sent in the
+        request body. It will be converted to a JSON string using the `json.dumps()` function before
+        being sent in the request
+        :type data: dict
+        :return: the result of the `post` method call on the `self.client` object.
+
+        -------------------------------
+        [Example:]
+            >>> data ={
+            >>>        "release_uid": "targe_release_uid",
+            >>>        "item": [
+            >>>            {
+            >>>                "uid": "entry_uid",
+            >>>                "locale": "en-us"
+            >>>            },
+            >>>            {
+            >>>                "uid": "entry_uid",
+            >>>                "locale": "en-us",
+            >>>                "variant_id": "entry_variant_id"
+            >>>            }
+            >>>        ]
+            >>>    }
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
+            >>> result = result = client.stack('api_key').releases('release_uid').item().move(data)
+
+        -------------------------------
+        """
+        
+        self.validate_release_uid()
+        url = f"{self.path}/items/move"
+        data = json.dumps(data)
+        return self.client.post(url, headers = self.client.headers, data=data, params = self.params)
+    
+    
+    
     def validate_release_uid(self):
         if self.release_uid is None or '':
             raise ArgumentException('Releases Uid is required')

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/releases/release.py

@@ -5,7 +5,6 @@ the CRUD operations that can be performed on the API """
 
 import json
 from ..common import Parameter
-from urllib.parse import quote
 from .._errors import ArgumentException
 from ..release_items.release_item import ReleaseItems
 
@@ -14,11 +13,14 @@ class Releases(Parameter):
     You can define a “Release” as a set of entries and assets that needs to be deployed (published or unpublished) all at once to a particular environment.
     """
 
-    def __init__(self, client, release_uid: str):
+    def __init__(self, client, release_uid: str, headers: dict = None):
         self.client = client
         self.release_uid = release_uid
         super().__init__(self.client)
         self.path = "releases"
+        if headers:
+            self.add_header_dict(headers)
+        
 
     def find(self):
         """
@@ -192,8 +194,8 @@ class Releases(Parameter):
          if self.release_uid is None or '':
             raise ArgumentException("Releases Uid is required")
          
-    def item(self):
+    def item(self, headers: dict = None):
             self.validate_uid()
-            return ReleaseItems(self.client, self.release_uid)
+            return ReleaseItems(self.client, self.release_uid, headers)
     
          

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/roles/roles.py

@@ -5,7 +5,6 @@ the CRUD operations that can be performed on the API """
 
 import json
 from ..common import Parameter
-from urllib.parse import quote
 from .._errors import ArgumentException
 
 class Roles(Parameter):

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/stack/stack.py

@@ -1,5 +1,4 @@
 import json
-from .._errors import ArgumentException
 from ..aliases.aliases import Alias
 from ..assets.assets import Assets
 from ..branches.branches import Branch
@@ -294,10 +293,8 @@ class Stack(Parameter):
         data = json.dumps(data)
         return self.client.post('stacks/unshare', headers=self.client.headers, params=self.params, data=data)
 
-    def global_fields(self, global_field_uid=None):
-        if 'api_key' not in self.client.headers:
-            raise Exception('api_key is required')
-        return GlobalFields(self.client, global_field_uid)
+    def global_fields(self, global_field_uid=None, options=None):
+        return GlobalFields(self.client, global_field_uid, options)
 
     def branch(self, branch_uid=None):
         return Branch(self.client, branch_uid)
@@ -341,8 +338,8 @@ class Stack(Parameter):
     def bulk_operation(self):
             return BulkOperation(self.client)
     
-    def releases(self, release_uid: str = None):
-            return Releases(self.client, release_uid)
+    def releases(self, release_uid: str = None, headers: dict = None):
+            return Releases(self.client, release_uid, headers)
 
     def delivery_token(self, delivery_token: str = None):
             return DeliveryToken(self.client, delivery_token)

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/taxonomies/taxonomy.py

@@ -5,7 +5,6 @@ the CRUD operations that can be performed on the API """
 
 import json
 from ..common import Parameter
-from urllib.parse import quote
 from .._errors import ArgumentException
 from ..terms.terms import Terms
 

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/terms/terms.py

@@ -5,7 +5,6 @@ the CRUD operations that can be performed on the API """
 
 import json
 from ..common import Parameter
-from urllib.parse import quote
 from .._errors import ArgumentException
 
 class Terms(Parameter):

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/webhooks/webhook.py

@@ -5,7 +5,6 @@ the CRUD operations that can be performed on the API """
 
 import json
 from ..common import Parameter
-from urllib.parse import quote
 
 class Webhook(Parameter):
     """
@@ -20,7 +19,7 @@ class Webhook(Parameter):
         self.webhook_uid = webhook_uid
         super().__init__(self.client)
 
-        self.path = f"webhooks"
+        self.path = "webhooks"
 
     def find(self):
         """

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management/workflows/workflows.py

@@ -5,7 +5,6 @@ the CRUD operations that can be performed on the API """
 
 import json
 from ..common import Parameter
-from urllib.parse import quote
 
 class Workflows(Parameter):
     """
@@ -20,7 +19,7 @@ class Workflows(Parameter):
         self.workflow_uid = workflow_uid
         super().__init__(self.client)
 
-        self.path = f"workflows"
+        self.path = "workflows"
 
     def find(self):
         """
@@ -593,7 +592,7 @@ class Workflows(Parameter):
 
         -------------------------------
         """
-        url = f"user/assignments"
+        url = "user/assignments"
         return self.client.get(url, headers = self.client.headers, params = self.params)
     
 

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/contentstack_management.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: contentstack-management
-Version: 1.3.3
+Version: 1.4.0
 Summary: Contentstack API Client Library for Python
 Home-page: https://github.com/contentstack/contentstack-management-python
-Author: ishaileshmishra
+Author: dev-ex
 Author-email: mobile@contentstack.com
 License: MIT
 Classifier: License :: OSI Approved :: MIT License

{contentstack_management-1.3.3 → contentstack_management-1.4.0}/setup.py

@@ -1,6 +1,5 @@
 import os
 import re
-import sys
 from setuptools import setup, find_packages
 
 with open("README.md", "r") as f: