contentstack-management 1.6.0__tar.gz → 1.7.1__tar.gz

{contentstack_management-1.6.0 → contentstack_management-1.7.1}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2012 - 2025 Contentstack. All rights reserved.
+Copyright (c) 2012 - 2026 Contentstack. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{contentstack_management-1.6.0 → contentstack_management-1.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: contentstack-management
-Version: 1.6.0
+Version: 1.7.1
 Summary: Contentstack API Client Library for Python
 Home-page: https://github.com/contentstack/contentstack-management-python
 Author: dev-ex
@@ -157,7 +157,7 @@ chmod +x .git/hooks/pre-commit .git/hooks/pre-push
 -   [Content Management API Docs](https://www.contentstack.com/docs/developers/apis/content-management-api)
 
 ### The MIT License (MIT)
-Copyright © 2012-2025  [Contentstack](https://www.contentstack.com/). All Rights Reserved
+Copyright © 2012-2026  [Contentstack](https://www.contentstack.com/). All Rights Reserved
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

{contentstack_management-1.6.0 → contentstack_management-1.7.1}/README.md

@@ -123,7 +123,7 @@ chmod +x .git/hooks/pre-commit .git/hooks/pre-push
 -   [Content Management API Docs](https://www.contentstack.com/docs/developers/apis/content-management-api)
 
 ### The MIT License (MIT)
-Copyright © 2012-2025  [Contentstack](https://www.contentstack.com/). All Rights Reserved
+Copyright © 2012-2026  [Contentstack](https://www.contentstack.com/). All Rights Reserved
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

{contentstack_management-1.6.0 → contentstack_management-1.7.1}/contentstack_management/__init__.py

@@ -34,6 +34,8 @@ from .publish_queue.publish_queue import PublishQueue
 from .extensions.extension import Extension
 from .variant_group.variant_group import VariantGroup
 from .variants.variants import Variants
+from .oauth.oauth_handler import OAuthHandler
+from .oauth.oauth_interceptor import OAuthInterceptor
 
 
 __all__ = (
@@ -71,14 +73,16 @@ __all__ = (
 "PublishQueue",
 "Extension",
 "VariantGroup",
-"Variants"
+"Variants",
+"OAuthHandler",
+"OAuthInterceptor"
 )
 
 __title__ = 'contentstack-management-python'
 __author__ = 'dev-ex'
 __status__ = 'debug'
 __region__ = 'na'
-__version__ = '1.6.0'
+__version__ = '1.7.1'
 __host__ = 'api.contentstack.io'
 __protocol__ = 'https://'
 __api_version__ = 'v3'

{contentstack_management-1.6.0 → contentstack_management-1.7.1}/contentstack_management/_api_client.py

@@ -2,7 +2,7 @@ import requests
 
 
 class _APIClient:
-    def __init__(self, endpoint, headers, timeout=30, max_retries: int = 5):
+    def __init__(self, endpoint, headers, timeout=30, max_retries: int = 5, oauth_interceptor=None):
         """
         The function is a constructor that initializes the endpoint, headers, timeout, and max_retries
         attributes of an object.
@@ -25,6 +25,8 @@ class _APIClient:
         self.headers = headers
         self.timeout = timeout
         self.max_retries = max_retries
+        self.oauth_interceptor = oauth_interceptor
+        self.oauth = {}  # OAuth token storage
         pass
 
     def _call_request(self, method, url, headers: dict = None, params=None, data=None, json_data=None, files=None):
@@ -52,9 +54,17 @@ class _APIClient:
         :return: the JSON response from the HTTP request.
         """
         
-        # headers.update(self.headers)
+        if self.oauth_interceptor and self.oauth_interceptor.is_oauth_configured():
+            return self.oauth_interceptor.execute_request(
+                method, url, headers=headers, params=params, data=data, 
+                json=json_data, files=files, timeout=self.timeout
+            )
+        
+        if headers is None:
+            headers = {}
+        headers.update(self.headers)  # Merge client headers (including authtoken) with request headers
         response = requests.request(
-            method, url, headers=headers, params=params, data=data, json=json_data, files=files)
+            method, url, headers=headers, params=params, data=data, json=json_data, files=files, timeout=self.timeout)
         # response.raise_for_status()
         return response
 

{contentstack_management-1.6.0 → contentstack_management-1.7.1}/contentstack_management/_constant.py

@@ -1,5 +1,6 @@
 import platform
-import sys 
+import sys
+from ._messages import REQUEST_HEADERS_INVALID
 
 
 def _default_user_agent():
@@ -55,4 +56,4 @@ def _request_headers():
 
 
 if __name__ == '__main__':
-    print(_request_headers().__str__())
+    print(REQUEST_HEADERS_INVALID)

contentstack_management-1.7.1/contentstack_management/_messages.py

@@ -0,0 +1,131 @@
+"""
+Centralized error and UI messages for Contentstack Management SDK.
+
+This module contains all user-facing messages used throughout the SDK
+to ensure consistency and easy maintenance.
+"""
+
+# General messages
+REQUEST_HEADERS_INVALID = "Request headers are invalid. Provide valid headers and try again."
+
+# Alias messages
+ALIAS_UID_REQUIRED = "Alias UID is required. Provide a valid Alias UID and try again."
+
+# Asset messages
+ASSET_UID_REQUIRED = "Asset UID is required. Provide a valid Asset UID and try again."
+ASSET_TYPE_REQUIRED = "Asset Type is required. Provide a valid Asset Type and try again."
+ASSET_VERSION_NUMBER_REQUIRED = "Version Number is required. Provide a valid Version Number and try again."
+
+# Audit log messages
+LOG_ITEM_UID_REQUIRED = "Log Item UID is required. Provide a valid Log Item UID and try again."
+
+# Branch messages
+BRANCH_UID_REQUIRED = "Branch UID is required. Provide a valid Branch UID and try again."
+
+# Bulk operation messages
+JOB_UID_REQUIRED = "Job UID is required. Provide a valid Job UID and try again."
+
+# Content type messages
+CONTENT_TYPE_UID_REQUIRED = "Content Type UID is required. Provide a valid Content Type UID and try again."
+
+# Delivery token messages
+DELIVERY_TOKEN_UID_REQUIRED = "Delivery Token UID is required. Provide a valid Delivery Token UID and try again."
+
+# Entry messages
+ENTRY_UID_REQUIRED = "Entry UID is required. Provide a valid Entry UID and try again."
+ENTRY_VERSION_NUMBER_REQUIRED = "Version Number is required. Provide a valid Version Number and try again."
+ENTRY_BODY_REQUIRED = "Body is required. Provide a valid Body value and try again."
+ENTRY_FILE_PATH_REQUIRED = "File Path is required. Provide a valid File Path and try again."
+
+# Entry variant messages
+ENTRY_VARIANT_CONTENT_TYPE_UID_REQUIRED = "Content Type UID is required. Provide a valid Content Type UID and try again."
+ENTRY_VARIANT_ENTRY_UID_REQUIRED = "Entry UID is required. Provide a valid Entry UID and try again."
+ENTRY_VARIANT_UID_REQUIRED = "Variant UID is required. Provide a valid Variant UID and try again."
+
+# Environment messages
+ENVIRONMENT_UID_REQUIRED = "Environment UID is required. Provide a valid Environment UID and try again."
+
+# Extension messages
+EXTENSION_UID_REQUIRED = "Extension UID is required. Provide a valid Extension UID and try again."
+
+# Global field messages
+GLOBAL_FIELD_UID_REQUIRED = "Global Field UID is required. Provide a valid Global Field UID and try again."
+
+# Label messages
+LABEL_UID_REQUIRED = "Label UID is required. Provide a valid Label UID and try again."
+
+# Locale messages
+LOCALE_CODE_REQUIRED = "Locale Code is required. Provide a valid Locale Code and try again."
+
+# Management token messages
+MANAGEMENT_TOKEN_UID_REQUIRED = "Management Token UID is required. Provide a valid Management Token UID and try again."
+
+# Metadata messages
+METADATA_UID_REQUIRED = "Metadata UID is required. Provide a valid Metadata UID and try again."
+
+# OAuth messages
+OAUTH_ACCESS_TOKEN_EXPIRED = "Access token expired. Refreshing the token."
+OAUTH_ACCESS_TOKEN_NOT_AVAILABLE = "Access token is not available. Authenticate to continue."
+OAUTH_TOKENS_NOT_AVAILABLE = "OAuth tokens are not available. Please authenticate first."
+OAUTH_REFRESH_TOKEN_NOT_AVAILABLE = "Refresh token is not available. Please authenticate to get a new token."
+OAUTH_NOT_CONFIGURED = "OAuth is not configured. Set up OAuth to continue."
+OAUTH_AUTHORIZATION_CODE_NOT_FOUND = "Authorization code was not found in the redirect URL. Provide a valid code and try again."
+OAUTH_TOKEN_EXCHANGE_FAILED = "Token exchange failed. Please try authenticating again."
+OAUTH_TOKEN_REFRESH_FAILED = "Token refresh failed due to {error}. Review the error and try again."
+OAUTH_BASE_URL_NOT_SET = "OAuth Base URL is not set. Provide a valid OAuth Base URL and try again."
+OAUTH_AUTHORIZING = "Authorizing using app ID {app_id} and client ID {client_id}."
+OAUTH_AUTHORIZATION_URL_GENERATED = "OAuth handler generated the final authorization URL at {final_url}."
+OAUTH_AUTHORIZATION_URL_GENERATION_FAILED = "Authorization URL generation failed due to {error}. Review the error and try again."
+OAUTH_AUTHORIZATION_CODE_EMPTY = "Authorization code is required. Provide a valid code and try again."
+OAUTH_TOKEN_EXCHANGE_ERROR = "Token exchange failed due to {error}. Review the error and try again."
+OAUTH_TOKEN_REFRESH_ERROR = "Token refresh failed due to {error}. Review the error and try again."
+OAUTH_TOKEN_REFRESH_FAILED_AFTER_401 = "Token refresh failed after a 401 response due to {error}. Review the error and try again."
+OAUTH_VISIT_URL_TO_AUTHORIZE = "Visit {auth_url} to authorize."
+
+# Organization messages
+ORGANIZATION_UID_REQUIRED = "Organization UID is required. Provide a valid Organization UID and try again."
+
+# Publish queue messages
+PUBLISH_QUEUE_UID_REQUIRED = "Publish Queue UID is required. Provide a valid Publish Queue UID and try again."
+
+# Release messages
+RELEASE_UID_REQUIRED = "Release UID is required. Provide a valid Release UID and try again."
+
+# Role messages
+ROLE_UID_REQUIRED = "Role UID is required. Provide a valid Release UID and try again."
+
+# Stack messages
+API_KEY_REQUIRED = "API Key is required. Provide a valid API Key and try again."
+USER_ID_REQUIRED = "User ID is required. Provide a valid User ID and try again."
+OWNERSHIP_TOKEN_REQUIRED = "Ownership Token is required. Provide a valid Ownership Token and try again."
+
+# Taxonomy messages
+TAXONOMY_UID_REQUIRED = "Taxonomy UID is required. Provide a valid Taxonomy UID and try again."
+
+# Terms messages
+TERMS_UID_REQUIRED = "Terms UID is required. Provide a valid Terms UID and try again."
+TERM_STRING_REQUIRED = "Term String is required. Provide a valid Term String and try again."
+
+# User session messages
+EMAIL_ID_REQUIRED = "Email ID is required. Provide a valid Email ID and try again."
+PASSWORD_REQUIRED = "Password is required. Provide a valid Password and try again."
+
+# Variant group messages
+VARIANT_GROUP_UID_REQUIRED = "Variant Group UID is required. Provide a valid Variant Group UID and try again."
+
+# Variant messages
+VARIANT_UIDS_NON_EMPTY_LIST_REQUIRED = "Variant UIDs must be a non-empty list. Provide at least one Variant UID and try again."
+VARIANT_UID_REQUIRED = "Variant UID is required. Provide a valid Variant UID and try again."
+
+# Webhook messages
+WEBHOOK_UID_REQUIRED = "Webhook UID is required. Provide a valid Webhook UID and try again."
+WEBHOOK_FILE_PATH_REQUIRED = "File Path is required. Provide a valid File Path and try again."
+WEBHOOK_EXECUTION_UID_REQUIRED = "Execution UID is required. Provide a valid Execution UID and try again."
+
+# Workflow messages
+WORKFLOW_UID_REQUIRED = "Workflow UID is required. Provide a valid Workflow UID and try again."
+WORKFLOW_CONTENT_TYPE_UID_REQUIRED = "Content Type UID is required. Provide a valid Content Type UID and try again."
+WORKFLOW_ENTRY_UID_REQUIRED = "Entry UID is required. Provide a valid Entry UID and try again."
+WORKFLOW_RULE_UID_REQUIRED = "Rule UID is required. Provide a valid Rule UID and try again."
+
+

{contentstack_management-1.6.0 → contentstack_management-1.7.1}/contentstack_management/aliases/aliases.py

@@ -3,6 +3,7 @@ frontend code to pull content from the target branch associated with an alias.""
 
 import json
 from ..common import Parameter
+from .._messages import ALIAS_UID_REQUIRED
 _path = 'stacks/branch_aliases'
 
 
@@ -47,7 +48,7 @@ class Alias(Parameter):
         --------------------------------
         """
         if self.alias_uid is None or '':
-            raise Exception('alias_uid is required')
+            raise Exception(ALIAS_UID_REQUIRED)
         url = f"{_path}/{self.alias_uid}"
         return self.client.get(url, headers=self.client.headers, params=self.params)
 

{contentstack_management-1.6.0 → contentstack_management-1.7.1}/contentstack_management/assets/assets.py

@@ -8,6 +8,7 @@ import json
 from ..common import Parameter
 import mimetypes
 import os
+from .._messages import ASSET_UID_REQUIRED, ASSET_TYPE_REQUIRED, ASSET_VERSION_NUMBER_REQUIRED
 
 class Assets(Parameter):
     """
@@ -62,7 +63,7 @@ class Assets(Parameter):
         """
 
         if self.asset_uid is None or '':
-            raise Exception('asset_uid is required')
+            raise Exception(ASSET_UID_REQUIRED)
         url = f"assets/{self.asset_uid}"
         return self.client.get(url, headers = self.client.headers, params = self.params)
 
@@ -284,7 +285,7 @@ class Assets(Parameter):
         """
 
         if self.asset_uid is None or '':
-            raise Exception('asset_uid is required')
+            raise Exception(ASSET_UID_REQUIRED)
         url = f"assets/{self.asset_uid}/versions"
         return self.client.get(url, headers = self.client.headers, params = self.params)
 
@@ -305,9 +306,9 @@ class Assets(Parameter):
         """
         
         if self.asset_uid is None or '':
-            raise Exception('asset_uid is required')
+            raise Exception(ASSET_UID_REQUIRED)
         if version_number is None:
-            raise Exception('Version Number is required')
+            raise Exception(ASSET_VERSION_NUMBER_REQUIRED)
         url = f"assets/{self.asset_uid}/versions/{version_number}/name"
         return self.client.delete(url, headers = self.client.headers, params = self.params)
 
@@ -326,7 +327,7 @@ class Assets(Parameter):
         """
         
         if self.asset_uid is None or '':
-            raise Exception('asset_uid is required')
+            raise Exception(ASSET_UID_REQUIRED)
         url = f"assets/{self.asset_uid}/references"
         return self.client.get(url, headers = self.client.headers, params = self.params)
 
@@ -346,7 +347,7 @@ class Assets(Parameter):
         """
         
         if asset_type is None or '':
-            raise Exception('asset_type is required')
+            raise Exception(ASSET_TYPE_REQUIRED)
         url = f"assets/{asset_type}"
         return self.client.get(url, headers = self.client.headers, params = self.params)
 
@@ -376,7 +377,7 @@ class Assets(Parameter):
         
         data = json.dumps(data)
         if self.asset_uid is None or '':
-            raise Exception('asset_uid is required')
+            raise Exception(ASSET_UID_REQUIRED)
         url = f"assets/{self.asset_uid}"
         return self.client.put(url, headers = self.client.headers, params = self.params, data = data)
 
@@ -404,7 +405,7 @@ class Assets(Parameter):
 
         data = json.dumps(data)
         if self.asset_uid is None or '':
-            raise Exception('asset_uid is required')
+            raise Exception(ASSET_UID_REQUIRED)
         url = f"assets/{self.asset_uid}"
         Parameter.add_header(self, "Content-Type", "multipart/form-data")
         return self.client.put(url, headers = self.client.headers, params = self.params, data = data)
@@ -439,7 +440,7 @@ class Assets(Parameter):
         
         data = json.dumps(data)
         if self.asset_uid is None or '':
-            raise Exception('asset_uid is required')
+            raise Exception(ASSET_UID_REQUIRED)
         url = f"assets/{self.asset_uid}/publish"
         return self.client.post(url, headers = self.client.headers, data = data)
     
@@ -474,7 +475,7 @@ class Assets(Parameter):
 
         data = json.dumps(data)
         if self.asset_uid is None or '':
-            raise Exception('asset_uid is required')
+            raise Exception(ASSET_UID_REQUIRED)
         url = f"assets/{self.asset_uid}/unpublish"
         return self.client.post(url, headers = self.client.headers, data = data)
     

{contentstack_management-1.6.0 → contentstack_management-1.7.1}/contentstack_management/auditlogs/auditlog.py

@@ -5,6 +5,7 @@ the CRUD operations that can be performed on the API """
 
 from ..common import Parameter
 from .._errors import ArgumentException
+from .._messages import LOG_ITEM_UID_REQUIRED
 
 class Auditlog(Parameter):
     """
@@ -58,6 +59,6 @@ class Auditlog(Parameter):
     
     def validate_uid(self):
         if self.log_item_uid is None or '':
-            raise ArgumentException('Log item Uid is required')
+            raise ArgumentException(LOG_ITEM_UID_REQUIRED)
         
     

{contentstack_management-1.6.0 → contentstack_management-1.7.1}/contentstack_management/branches/branches.py

@@ -6,6 +6,7 @@ organized, and structured manner without impacting each other."""
 import json
 
 from contentstack_management.common import Parameter
+from contentstack_management._messages import BRANCH_UID_REQUIRED
 
 _path = 'stacks/branches'
 
@@ -55,7 +56,7 @@ class Branch(Parameter):
         --------------------------------
         """
         if self.branch_uid is None or '':
-            raise Exception('branch_uid is required field')
+            raise Exception(BRANCH_UID_REQUIRED)
         url = f"{_path}/{self.branch_uid}"
         return self.client.get(url, headers=self.client.headers, params=self.params)
 
@@ -101,6 +102,6 @@ class Branch(Parameter):
         --------------------------------
         """
         if self.branch_uid is None or '':
-            raise Exception('branch_uid is required field')
+            raise Exception(BRANCH_UID_REQUIRED)
         url = f"{_path}/{self.branch_uid}"
         return self.client.delete(url, headers=self.client.headers, params=self.params)

{contentstack_management-1.6.0 → contentstack_management-1.7.1}/contentstack_management/bulk_operations/bulk_operation.py

@@ -7,6 +7,7 @@ import json
 from ..common import Parameter
 from urllib.parse import quote
 from .._errors import ArgumentException
+from .._messages import JOB_UID_REQUIRED
 
 class BulkOperation(Parameter):
     """
@@ -313,7 +314,7 @@ class BulkOperation(Parameter):
         -------------------------------
         """
         if job_uid is None:
-            raise ArgumentException("job_uid", "job_uid cannot be None")
+            raise ArgumentException(JOB_UID_REQUIRED)
         if headers is not None:
             self.client.headers.update(headers)
         url = f"{self.path}/jobs/{quote(job_uid)}"

{contentstack_management-1.6.0 → contentstack_management-1.7.1}/contentstack_management/content_types/content_type.py

@@ -6,6 +6,7 @@ import json
 
 from contentstack_management.common import Parameter
 from ..entries import entry
+from .._messages import CONTENT_TYPE_UID_REQUIRED
 
 _path = 'content_types'
 
@@ -163,7 +164,7 @@ class ContentType(Parameter):
         """
         data = json.dumps(data)
         if self.content_type_uid is None or '':
-            raise Exception('content_type_uid is required')
+            raise Exception(CONTENT_TYPE_UID_REQUIRED)
         url = f"{_path}/{self.content_type_uid}"
         return self.client.put(url, headers=self.client.headers, params=self.params, data=data)
 
@@ -347,5 +348,5 @@ class ContentType(Parameter):
 
     def entry(self, entry_uid: str =None):
         if self.content_type_uid is None:
-            raise Exception('Content type uid is required')
+            raise Exception(CONTENT_TYPE_UID_REQUIRED)
         return entry.Entry(self.client, self.content_type_uid, entry_uid)

contentstack_management-1.7.1/contentstack_management/contentstack.py

@@ -0,0 +1,182 @@
+from enum import Enum
+import os
+import pyotp
+from ._api_client import _APIClient
+from contentstack_management.organizations import organization
+from contentstack_management.stack import stack
+from contentstack_management.user_session import user_session
+from contentstack_management.users import user
+from contentstack_management.oauth.oauth_handler import OAuthHandler
+
+version = '0.0.1'
+
+
+class Region(Enum):
+    US = "us"
+    EU = "eu"
+    AU = "au"
+    AZURE_EU = "azure-eu"
+    AZURE_NA = "azure-na"
+    GCP_NA = "gcp-na"
+    GCP_EU = "gcp-eu"
+
+
+def user_agents(headers=None):
+    if headers is None:
+        headers = {}
+    local_headers = {'X-User-Agent': f'contentstack-management-python/v{version}',
+                     "Content-Type": "application/json"}
+    headers.update(local_headers)
+    return headers
+
+
+class Client:
+
+    # TODO: DefaultCSCredential(), needs to be implemented
+    def __init__(self, host: str = 'api.contentstack.io', scheme: str = 'https://',
+                 authtoken: str = None , management_token=None, headers: dict = None,
+                 region: Region = Region.US.value, version='v3', timeout=2, max_retries: int = 18, early_access: list = None,
+                 oauth_config: dict = None, **kwargs):
+        self.endpoint = 'https://api.contentstack.io/v3/'
+        
+        if region is not None and region is not Region.US.value:
+            if host is not None and host != 'api.contentstack.io':
+                self.endpoint = f'{scheme}{region}-api.{host}/{version}/'
+            else:
+                host = 'api.contentstack.com'
+                self.endpoint = f'{scheme}{region}-{host}/{version}/'
+        elif host is not None and host != 'api.contentstack.io':
+            self.endpoint = f'{scheme}{host}/{version}/'
+        if headers is None:
+            headers = {}
+        if early_access is not None:
+            early_access_str = ', '.join(early_access)
+            headers['x-header-ea'] = early_access_str
+
+        if authtoken is not None:
+            headers['authtoken'] = authtoken
+        
+        if management_token is not None:
+            headers['authorization'] = management_token
+        headers = user_agents(headers)
+        self.client = _APIClient(endpoint=self.endpoint, headers=headers, timeout=timeout, max_retries=max_retries)
+        
+        # Initialize OAuth if configuration is provided
+        self.oauth_handler = None
+        if oauth_config:
+            self.oauth_handler = OAuthHandler(
+                app_id=oauth_config.get('app_id'),
+                client_id=oauth_config.get('client_id'),
+                redirect_uri=oauth_config.get('redirect_uri'),
+                response_type=oauth_config.get('response_type', 'code'),
+                client_secret=oauth_config.get('client_secret'),
+                scope=oauth_config.get('scope'),
+                api_client=self.client
+            )
+
+        """
+        :param host: Optional hostname for the API endpoint.
+        :param authtoken: Optional authentication token for API requests
+        :param headers: Optional headers to be included with API requests
+        :param authorization: Optional headers to be included in the api request
+        :param region: optional region to be included in API requests, 
+        We have region support options for na, eu, azure-eu, azure-na
+        :param scheme: optional scheme to be included in API requests
+        :param version: optional version to be included in API request path url,
+        :param timeout: Optional timeout value for API requests
+        :param max_requests:Optional maximum number of requests to be made
+        :param retry_on_error: Optional boolean value indicating whether to retry API requests on error.
+        :return: A client object for performing API operations.
+        -------------------------------
+        [Example:]
+
+        >>> import contentstack_management
+        >>> contentstack_client = contentstack_management.Client()
+        -------------------------------
+        """
+
+    def login(self, email: str, password: str, tfa_token: str = None, mfa_secret: str = None):
+        """
+        Login to Contentstack with optional TOTP support.
+        
+        :param email: User's email address
+        :param password: User's password
+        :param tfa_token: Optional two-factor authentication token
+        :param mfa_secret: Optional MFA secret for automatic TOTP generation. 
+                          If not provided, will check MFA_SECRET environment variable
+        :return: Response object from the login request
+        """
+        final_tfa_token = tfa_token
+        
+        if not mfa_secret:
+            mfa_secret = os.getenv('MFA_SECRET')
+        
+        if mfa_secret and not tfa_token:
+            final_tfa_token = self._generate_totp(mfa_secret)
+        
+        return user_session.UserSession(self.client).login(email, password, final_tfa_token)
+
+    def _generate_totp(self, secret: str) -> str:
+        """
+        Generate a Time-Based One-Time Password (TOTP) from the provided secret.
+        
+        :param secret: The MFA secret key for TOTP generation
+        :return: The current TOTP code as a string
+        """
+        totp = pyotp.TOTP(secret)
+        return totp.now()
+
+    def logout(self):
+        return user_session.UserSession(client=self.client).logout()
+
+    @property
+    def authtoken(self):
+        return self.client.headers['authtoken']
+
+    def user(self):
+        return user.User(self.client)
+
+    def organizations(self, organization_uid: str = None):
+        return organization.Organization(self.client, organization_uid)
+
+    def stack(self, api_key: str = None):
+        return stack.Stack(self.client, api_key)
+    
+    def oauth(self, app_id: str, client_id: str, redirect_uri: str, 
+              response_type: str = "code", client_secret: str = None, 
+              scope: list = None):
+        """
+        Create an OAuth handler for OAuth 2.0 authentication.
+        
+        Args:
+            app_id: Your registered App ID
+            client_id: Your OAuth Client ID
+            redirect_uri: The URL where the user is redirected after login and consent
+            response_type: OAuth response type (default: "code")
+            client_secret: Client secret for standard OAuth flows (optional for PKCE)
+            scope: Permissions requested (optional)
+            
+        Returns:
+            OAuthHandler instance
+            
+        Example:
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client()
+            >>> oauth_handler = client.oauth(
+            ...     app_id='your-app-id',
+            ...     client_id='your-client-id',
+            ...     redirect_uri='http://localhost:3000/callback'
+            ... )
+            >>> auth_url = oauth_handler.authorize()
+            >>> from contentstack_management._messages import OAUTH_VISIT_URL_TO_AUTHORIZE
+            >>> print(OAUTH_VISIT_URL_TO_AUTHORIZE.format(auth_url=auth_url))
+        """
+        return OAuthHandler(
+            app_id=app_id,
+            client_id=client_id,
+            redirect_uri=redirect_uri,
+            response_type=response_type,
+            client_secret=client_secret,
+            scope=scope,
+            api_client=self.client
+        )

{contentstack_management-1.6.0 → contentstack_management-1.7.1}/contentstack_management/delivery_token/delivery_token.py

@@ -6,6 +6,7 @@ the CRUD operations that can be performed on the API """
 import json
 from ..common import Parameter
 from .._errors import ArgumentException
+from .._messages import DELIVERY_TOKEN_UID_REQUIRED
 
 class DeliveryToken(Parameter):
     """
@@ -191,4 +192,4 @@ class DeliveryToken(Parameter):
         
     def validate_uid(self):
          if self.delivery_token_uid is None or '':
-            raise ArgumentException("Delivery Token Uid is required")
+            raise ArgumentException(DELIVERY_TOKEN_UID_REQUIRED)