cloudinary 1.45.0__tar.gz → 1.46.1__tar.gz

cloudinary-1.46.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Cloudinary Ltd.
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{cloudinary-1.45.0 → cloudinary-1.46.1}/MANIFEST.in

@@ -1,4 +1,6 @@
 include *.txt
+include LICENSE
+recursive-include cloudinary/docs *.md
 recursive-include cloudinary/templates *.html
 recursive-include cloudinary/static *.html *.js
 prune django_tests

cloudinary-1.46.1/PKG-INFO

@@ -0,0 +1,221 @@
+Metadata-Version: 2.1
+Name: cloudinary
+Version: 1.46.1
+Summary: Upload, transform, optimize, and manage images and videos with Cloudinary from Python or Django.
+Author-email: Cloudinary <info@cloudinary.com>
+License: MIT License
+        
+        Copyright (c) Cloudinary Ltd.
+        
+        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:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://cloudinary.com
+Project-URL: Source, https://github.com/cloudinary/pycloudinary
+Project-URL: Changelog, https://raw.githubusercontent.com/cloudinary/pycloudinary/master/CHANGELOG.md
+Keywords: cloudinary,image,video,upload,crop,resize,filter,transformation,manipulation,cdn
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 1.11
+Classifier: Framework :: Django :: 2.2
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Framework :: Django :: 6.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Sound/Audio :: Conversion
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Multimedia :: Video :: Conversion
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: six
+Requires-Dist: urllib3>=1.26.5
+Requires-Dist: certifi
+Provides-Extra: dev
+Requires-Dist: tox; extra == "dev"
+Requires-Dist: pytest==4.6; python_version < "3.7" and extra == "dev"
+Requires-Dist: pytest; python_version >= "3.7" and extra == "dev"
+
+# Cloudinary Python SDK
+
+Upload, transform, optimize, and manage images and videos with Cloudinary from Python or Django — the `cloudinary` package on PyPI.
+
+[![Tests](https://github.com/cloudinary/pycloudinary/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/cloudinary/pycloudinary/actions/workflows/test.yml)
+[![PyPI](https://img.shields.io/pypi/v/cloudinary.svg)](https://pypi.org/project/cloudinary/)
+[![Downloads](https://img.shields.io/pypi/dm/cloudinary.svg)](https://pypi.org/project/cloudinary/)
+[![License](https://img.shields.io/pypi/l/cloudinary.svg)](LICENSE)
+
+## Install
+
+```bash
+pip install cloudinary
+```
+
+## Quick start
+
+Set your API environment variable (Console > Settings > API Keys):
+
+```bash
+export CLOUDINARY_URL=cloudinary://<api_key>:<api_secret>@<cloud_name>
+```
+
+Upload an image and get an optimized delivery URL:
+
+```python
+import cloudinary
+import cloudinary.uploader  # cloudinary.uploader must be imported explicitly
+
+# Configuration is read from CLOUDINARY_URL automatically.
+
+
+def main():
+    # Upload a remote image (a local file path works the same way)
+    result = cloudinary.uploader.upload(
+        "https://res.cloudinary.com/demo/image/upload/sample.jpg",
+        public_id="quickstart-sample",
+    )
+    print("Uploaded: {0}".format(result["public_id"]))
+
+    # Build a 400x400 auto-cropped URL with automatic format and quality
+    url = cloudinary.CloudinaryImage(result["public_id"]).build_url(
+        width=400,
+        height=400,
+        crop="fill",
+        gravity="auto",
+        fetch_format="auto",
+        quality="auto",
+        secure=True,
+    )
+    print("Optimized URL: {0}".format(url))
+
+
+if __name__ == "__main__":
+    try:
+        main()
+    except Exception as error:
+        print("Quick start failed: {0}".format(error))
+        print("Check that CLOUDINARY_URL is set (Console > Settings > API Keys).")
+        raise SystemExit(1)
+```
+
+Save as `quickstart.py` and run `python quickstart.py`. [Create a free account](https://cloudinary.com/users/register_free) if you don't have one — or call `cloudinary.provisioning.create_cloud()` to [provision one without signing up](cloudinary/docs/get-credentials.md).
+
+## Common tasks
+
+- [Get Cloudinary credentials](cloudinary/docs/get-credentials.md)
+- [Upload an image](cloudinary/docs/upload-image.md)
+- [Upload a large video](cloudinary/docs/upload-large-video.md)
+- [Sign a browser upload](cloudinary/docs/sign-browser-upload.md)
+- [Transform and deliver an image](cloudinary/docs/transform-and-deliver-image.md)
+- [Transform and deliver a video](cloudinary/docs/transform-and-deliver-video.md)
+- [Search and manage assets](cloudinary/docs/search-and-manage-assets.md)
+- [Moderate an upload](cloudinary/docs/moderate-upload.md)
+- [Use structured metadata](cloudinary/docs/use-structured-metadata.md)
+- [Use with Django](cloudinary/docs/use-with-django.md)
+- [Troubleshoot errors](cloudinary/docs/troubleshoot-errors.md)
+
+Runnable versions live in [`examples/`](examples/) — each is a complete file you can run directly.
+
+## When to use this SDK
+
+Use this package in **Python server-side code**, including Django: uploads, signed
+operations, asset administration, search, moderation, and delivery URL generation.
+
+For other jobs, better-fitting tools exist:
+
+- Browser or frontend framework rendering: the [frontend SDKs](https://cloudinary.com/documentation/frontend_sdks) ([md](https://cloudinary.com/documentation/frontend_sdks.md)).
+- Complete in-browser upload UI: [Upload Widget](https://cloudinary.com/documentation/upload_widget) ([md](https://cloudinary.com/documentation/upload_widget.md)).
+- Text-to-image generation and image-to-video: [platform APIs](https://cloudinary.com/documentation/image_generation_addon) ([md](https://cloudinary.com/documentation/image_generation_addon.md)), not wrapped by this package.
+- Multi-step media workflow automation: [MediaFlows](https://cloudinary.com/documentation/mediaflows_user_guide) ([md](https://cloudinary.com/documentation/mediaflows_user_guide.md)).
+- Interactive agent-driven asset operations: [Cloudinary MCP servers and Skills](https://cloudinary.com/documentation/cloudinary_llm_mcp) ([md](https://cloudinary.com/documentation/cloudinary_llm_mcp.md)).
+
+The full capability map — plus the Skills, MCP servers, and CLI worth setting up first —
+is in [cloudinary/docs/platform-capabilities.md](cloudinary/docs/platform-capabilities.md).
+
+## Status and compatibility
+
+Stable, actively maintained. See [CHANGELOG.md](CHANGELOG.md).
+
+| SDK version | Python | Django |
+|-------------|--------|--------|
+| 1.x | 3.10 – 3.14 | 4.2, 5.0, 5.1, 5.2, 6.0 |
+
+The table lists what CI tests on every commit. Older Python and Django releases are
+supported on a best-effort basis.
+
+## Documentation
+
+- [Bundled task docs](cloudinary/docs/README.md) — ship inside the package, version-matched.
+- [Python and Django SDK guide](https://cloudinary.com/documentation/django_integration) — the full documentation ([md](https://cloudinary.com/documentation/django_integration.md)).
+- [Python quick start](https://cloudinary.com/documentation/python_quickstart) — a short end-to-end walkthrough ([md](https://cloudinary.com/documentation/python_quickstart.md)).
+- [Transformation and REST API references](https://cloudinary.com/documentation/cloudinary_references) — syntax and examples for all SDKs ([md](https://cloudinary.com/documentation/cloudinary_references.md)).
+
+Documentation links in this README point at the browsable HTML page, with an `(md)`
+companion link that returns the same page as raw Markdown. Inside `cloudinary/docs/` and
+`examples/` the links are Markdown-only, since those files are written to be read by
+coding agents. Either form works for any page: add `.md` for Markdown, drop it for HTML.
+
+## For AI coding agents
+
+- Contributing to this repo: read [AGENTS.md](AGENTS.md).
+- Using the installed package: the Markdown docs in the installed package's
+  `cloudinary/docs/` directory match your installed version and are the source of truth.
+  Locate them with
+  `python -c "import cloudinary, pathlib; print(pathlib.Path(cloudinary.__file__).parent / 'docs')"`,
+  and start with [platform-capabilities](cloudinary/docs/platform-capabilities.md) before
+  assuming a feature exists.
+
+## Support
+
+- SDK bugs and feature requests: [GitHub issues](https://github.com/cloudinary/pycloudinary/issues)
+- Account and platform questions: [Cloudinary support](https://support.cloudinary.com)
+- Sample projects: [`samples/`](samples/) and the
+  [Django Photo Album](https://github.com/cloudinary/cloudinary-django-sample)
+- Contributing: [CONTRIBUTING.md](CONTRIBUTING.md)
+
+More resources: [Cloudinary Academy](https://training.cloudinary.com/) for courses,
+[code explorers and feature demos](https://cloudinary.com/documentation/code_explorers_demos_index),
+and the [Cloudinary roadmap](https://cloudinary.com/roadmap).
+
+## Security
+
+See [SECURITY.md](SECURITY.md) for private vulnerability reporting. Keep your
+`api_secret` in server-side code; for client uploads, use the server-signed pattern in
+[Sign a browser upload](cloudinary/docs/sign-browser-upload.md).
+
+## License
+
+Released under the MIT license — see [LICENSE](LICENSE). Copyright (c) Cloudinary Ltd.

cloudinary-1.46.1/README.md

@@ -0,0 +1,150 @@
+# Cloudinary Python SDK
+
+Upload, transform, optimize, and manage images and videos with Cloudinary from Python or Django — the `cloudinary` package on PyPI.
+
+[![Tests](https://github.com/cloudinary/pycloudinary/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/cloudinary/pycloudinary/actions/workflows/test.yml)
+[![PyPI](https://img.shields.io/pypi/v/cloudinary.svg)](https://pypi.org/project/cloudinary/)
+[![Downloads](https://img.shields.io/pypi/dm/cloudinary.svg)](https://pypi.org/project/cloudinary/)
+[![License](https://img.shields.io/pypi/l/cloudinary.svg)](LICENSE)
+
+## Install
+
+```bash
+pip install cloudinary
+```
+
+## Quick start
+
+Set your API environment variable (Console > Settings > API Keys):
+
+```bash
+export CLOUDINARY_URL=cloudinary://<api_key>:<api_secret>@<cloud_name>
+```
+
+Upload an image and get an optimized delivery URL:
+
+```python
+import cloudinary
+import cloudinary.uploader  # cloudinary.uploader must be imported explicitly
+
+# Configuration is read from CLOUDINARY_URL automatically.
+
+
+def main():
+    # Upload a remote image (a local file path works the same way)
+    result = cloudinary.uploader.upload(
+        "https://res.cloudinary.com/demo/image/upload/sample.jpg",
+        public_id="quickstart-sample",
+    )
+    print("Uploaded: {0}".format(result["public_id"]))
+
+    # Build a 400x400 auto-cropped URL with automatic format and quality
+    url = cloudinary.CloudinaryImage(result["public_id"]).build_url(
+        width=400,
+        height=400,
+        crop="fill",
+        gravity="auto",
+        fetch_format="auto",
+        quality="auto",
+        secure=True,
+    )
+    print("Optimized URL: {0}".format(url))
+
+
+if __name__ == "__main__":
+    try:
+        main()
+    except Exception as error:
+        print("Quick start failed: {0}".format(error))
+        print("Check that CLOUDINARY_URL is set (Console > Settings > API Keys).")
+        raise SystemExit(1)
+```
+
+Save as `quickstart.py` and run `python quickstart.py`. [Create a free account](https://cloudinary.com/users/register_free) if you don't have one — or call `cloudinary.provisioning.create_cloud()` to [provision one without signing up](cloudinary/docs/get-credentials.md).
+
+## Common tasks
+
+- [Get Cloudinary credentials](cloudinary/docs/get-credentials.md)
+- [Upload an image](cloudinary/docs/upload-image.md)
+- [Upload a large video](cloudinary/docs/upload-large-video.md)
+- [Sign a browser upload](cloudinary/docs/sign-browser-upload.md)
+- [Transform and deliver an image](cloudinary/docs/transform-and-deliver-image.md)
+- [Transform and deliver a video](cloudinary/docs/transform-and-deliver-video.md)
+- [Search and manage assets](cloudinary/docs/search-and-manage-assets.md)
+- [Moderate an upload](cloudinary/docs/moderate-upload.md)
+- [Use structured metadata](cloudinary/docs/use-structured-metadata.md)
+- [Use with Django](cloudinary/docs/use-with-django.md)
+- [Troubleshoot errors](cloudinary/docs/troubleshoot-errors.md)
+
+Runnable versions live in [`examples/`](examples/) — each is a complete file you can run directly.
+
+## When to use this SDK
+
+Use this package in **Python server-side code**, including Django: uploads, signed
+operations, asset administration, search, moderation, and delivery URL generation.
+
+For other jobs, better-fitting tools exist:
+
+- Browser or frontend framework rendering: the [frontend SDKs](https://cloudinary.com/documentation/frontend_sdks) ([md](https://cloudinary.com/documentation/frontend_sdks.md)).
+- Complete in-browser upload UI: [Upload Widget](https://cloudinary.com/documentation/upload_widget) ([md](https://cloudinary.com/documentation/upload_widget.md)).
+- Text-to-image generation and image-to-video: [platform APIs](https://cloudinary.com/documentation/image_generation_addon) ([md](https://cloudinary.com/documentation/image_generation_addon.md)), not wrapped by this package.
+- Multi-step media workflow automation: [MediaFlows](https://cloudinary.com/documentation/mediaflows_user_guide) ([md](https://cloudinary.com/documentation/mediaflows_user_guide.md)).
+- Interactive agent-driven asset operations: [Cloudinary MCP servers and Skills](https://cloudinary.com/documentation/cloudinary_llm_mcp) ([md](https://cloudinary.com/documentation/cloudinary_llm_mcp.md)).
+
+The full capability map — plus the Skills, MCP servers, and CLI worth setting up first —
+is in [cloudinary/docs/platform-capabilities.md](cloudinary/docs/platform-capabilities.md).
+
+## Status and compatibility
+
+Stable, actively maintained. See [CHANGELOG.md](CHANGELOG.md).
+
+| SDK version | Python | Django |
+|-------------|--------|--------|
+| 1.x | 3.10 – 3.14 | 4.2, 5.0, 5.1, 5.2, 6.0 |
+
+The table lists what CI tests on every commit. Older Python and Django releases are
+supported on a best-effort basis.
+
+## Documentation
+
+- [Bundled task docs](cloudinary/docs/README.md) — ship inside the package, version-matched.
+- [Python and Django SDK guide](https://cloudinary.com/documentation/django_integration) — the full documentation ([md](https://cloudinary.com/documentation/django_integration.md)).
+- [Python quick start](https://cloudinary.com/documentation/python_quickstart) — a short end-to-end walkthrough ([md](https://cloudinary.com/documentation/python_quickstart.md)).
+- [Transformation and REST API references](https://cloudinary.com/documentation/cloudinary_references) — syntax and examples for all SDKs ([md](https://cloudinary.com/documentation/cloudinary_references.md)).
+
+Documentation links in this README point at the browsable HTML page, with an `(md)`
+companion link that returns the same page as raw Markdown. Inside `cloudinary/docs/` and
+`examples/` the links are Markdown-only, since those files are written to be read by
+coding agents. Either form works for any page: add `.md` for Markdown, drop it for HTML.
+
+## For AI coding agents
+
+- Contributing to this repo: read [AGENTS.md](AGENTS.md).
+- Using the installed package: the Markdown docs in the installed package's
+  `cloudinary/docs/` directory match your installed version and are the source of truth.
+  Locate them with
+  `python -c "import cloudinary, pathlib; print(pathlib.Path(cloudinary.__file__).parent / 'docs')"`,
+  and start with [platform-capabilities](cloudinary/docs/platform-capabilities.md) before
+  assuming a feature exists.
+
+## Support
+
+- SDK bugs and feature requests: [GitHub issues](https://github.com/cloudinary/pycloudinary/issues)
+- Account and platform questions: [Cloudinary support](https://support.cloudinary.com)
+- Sample projects: [`samples/`](samples/) and the
+  [Django Photo Album](https://github.com/cloudinary/cloudinary-django-sample)
+- Contributing: [CONTRIBUTING.md](CONTRIBUTING.md)
+
+More resources: [Cloudinary Academy](https://training.cloudinary.com/) for courses,
+[code explorers and feature demos](https://cloudinary.com/documentation/code_explorers_demos_index),
+and the [Cloudinary roadmap](https://cloudinary.com/roadmap).
+
+## Security
+
+See [SECURITY.md](SECURITY.md) for private vulnerability reporting. Keep your
+`api_secret` in server-side code; for client uploads, use the server-signed pattern in
+[Sign a browser upload](cloudinary/docs/sign-browser-upload.md).
+
+## License
+
+Released under the MIT license — see [LICENSE](LICENSE). Copyright (c) Cloudinary Ltd.

{cloudinary-1.45.0 → cloudinary-1.46.1}/cloudinary/__init__.py

@@ -38,7 +38,7 @@ CL_BLANK = "data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAA
 URI_SCHEME = "cloudinary"
 API_VERSION = "v1_1"
 
-VERSION = "1.45.0"
+VERSION = "1.46.1"
 
 _USER_PLATFORM_DETAILS = "; ".join((platform(), "Python {}".format(python_version())))
 

{cloudinary-1.45.0 → cloudinary-1.46.1}/cloudinary/api.py

@@ -1323,6 +1323,189 @@ def update_streaming_profile(name, **options):
     return call_json_api('PUT', uri, params, **options)
 
 
+def triggers(**options):
+    """
+    Lists all notification triggers.
+
+    :param options: Additional options.
+    :keyword str event_type: Restricts the list to triggers of a single event type.
+    :return: A dictionary with a "triggers" key and a "total" count.
+    :rtype: Response
+    """
+    params = {"event_type": options.pop("event_type", None)}
+    return call_json_api("get", ["triggers"], params, **options)
+
+
+def create_trigger(uri, event_type, uri_type=None, **options):
+    """
+    Creates a notification trigger.
+
+    :param uri: The destination of the notification. An https:// webhook URL, or a
+                poll:// destination when uri_type is "poll" - either "poll://<channel>"
+                for a named channel or "poll://*" for an anonymous one addressed by batch_id.
+    :type uri: str
+    :param event_type: The event that fires the trigger. One of:
+                       "all", "access_control_changed", "bulk_refresh_auto_fetch",
+                       "create_folder", "delete", "delete_by_token", "delete_folder",
+                       "eager", "error", "explode", "generate_archive", "info",
+                       "invalidate_custom_cdn", "moderation", "moderation_summary",
+                       "move", "move_or_rename_asset_folder", "multi", "publish",
+                       "rename", "report", "resource_context_changed",
+                       "resource_display_name_changed", "resource_metadata_changed",
+                       "resource_tags_changed", "restore_asset_version", "sprite",
+                       "upload".
+                       The server owns this list and may extend it; values are passed
+                       through unvalidated.
+    :type event_type: str
+    :param uri_type: How the notification is delivered:
+                     - "webhook" (the default): delivers the notification as an HTTP POST
+                       to the destination URL.
+                     - "flow": dispatches the notification to a Cloudinary flow.
+                     - "poll": buffers the notification for retrieval with `notifications`
+                       instead of an outbound HTTP request.
+    :type uri_type: str, optional
+    :param options: Additional options.
+    :return: The created trigger.
+    :rtype: Response
+    """
+    params = {"uri": uri, "event_type": event_type, "uri_type": uri_type}
+    return call_json_api("post", ["triggers"], params, **options)
+
+
+def update_trigger(trigger_id, new_uri, **options):
+    """
+    Updates the destination URI of an existing trigger.
+
+    :param trigger_id: The ID of the trigger to update.
+    :type trigger_id: str
+    :param new_uri: The new destination URI.
+    :type new_uri: str
+    :param options: Additional options.
+    :return: A dictionary with a "message" key.
+    :rtype: Response
+    """
+    return call_json_api("put", ["triggers", trigger_id], {"new_uri": new_uri}, **options)
+
+
+def delete_trigger(trigger_id, **options):
+    """
+    Deletes a notification trigger.
+
+    :param trigger_id: The ID of the trigger to delete.
+    :type trigger_id: str
+    :param options: Additional options.
+    :return: A dictionary with a "message" key.
+    :rtype: Response
+    """
+    return call_json_api("delete", ["triggers", trigger_id], {}, **options)
+
+
+def test_trigger(trigger_id, sample_data=None, **options):
+    """
+    Evaluates a trigger's filter against sample data, without delivering a notification.
+
+    :param trigger_id: The ID of the trigger to test.
+    :type trigger_id: str
+    :param sample_data: The sample notification payload to evaluate the filter against.
+    :type sample_data: dict, optional
+    :param options: Additional options.
+    :return: A dictionary with "trigger_id", "filter_present" and "filter_result" keys.
+    :rtype: Response
+    """
+    params = {"sample_data": sample_data}
+    return call_json_api("post", ["triggers", trigger_id, "test"], params, **options)
+
+
+def notifications(channel=None, batch_id=None, max_messages=None, wait_seconds=None,
+                  visibility_timeout=None, **options):
+    """
+    Gets notifications buffered for a poll destination.
+
+    Long-polls exactly one addressing dimension - a named channel or a batch_id. Holds the
+    connection up to wait_seconds, returning as soon as messages are claimed. A claimed
+    message stays invisible for visibility_timeout seconds and is then redelivered, unless
+    it is acknowledged with `ack_notifications` first.
+
+    Each message carries the parsed notification as "payload" and the byte-exact signed
+    bytes, base64url encoded, as "signed_payload". Verify signatures against
+    signed_payload, never against a re-serialization of payload::
+
+        raw = cloudinary.utils.base64url_decode(message["signed_payload"])
+        cloudinary.utils.verify_notification_signature(
+            raw, message["timestamp"], message["signature"])
+
+    :param channel: The named channel to drain ("poll://<channel>" destinations).
+                    Mutually exclusive with batch_id.
+    :type channel: str, optional
+    :param batch_id: The batch to drain ("poll://*" anonymous destinations).
+                     Mutually exclusive with channel.
+    :type batch_id: str, optional
+    :param max_messages: The maximum number of messages to return. 1-100, default 10.
+    :type max_messages: int, optional
+    :param wait_seconds: The maximum seconds to hold the long-poll open when empty.
+                         0-60, default 20.
+    :type wait_seconds: int, optional
+    :param visibility_timeout: The seconds a claimed message stays invisible before
+                               redelivery. 1-600, default 30.
+    :type visibility_timeout: int, optional
+    :param options: Additional options.
+    :keyword int timeout: The HTTP timeout, also configurable via `cloudinary.config(timeout=...)`.
+                          When set, it must exceed wait_seconds, or the long poll is cut off
+                          client-side before the server answers.
+    :return: Zero or more claimed messages, as {"messages": [...]}. The "messages" key is
+             absent when nothing is buffered - read it with .get("messages", []).
+    :rtype: Response
+    :raises ValueError: If neither or both of channel and batch_id are given.
+    """
+    if bool(channel) == bool(batch_id):
+        raise ValueError("Supply exactly one of 'channel' or 'batch_id'")
+
+    params = {
+        "channel": channel,
+        "batch_id": batch_id,
+        "max_messages": max_messages,
+        "wait_seconds": wait_seconds,
+        "visibility_timeout": visibility_timeout,
+    }
+
+    return __call_notifications_api("get", ["messages"], params, **options)
+
+
+def ack_notifications(receipt_handles, **options):
+    """
+    Acknowledges claimed notifications, deleting them from the buffer.
+
+    Unacknowledged notifications are redelivered once their visibility timeout expires.
+
+    :param receipt_handles: The receipt handles of the notifications to acknowledge, as
+                            returned by `notifications`. A single handle may be passed as a
+                            string. Maximum 100 per call.
+    :type receipt_handles: list[str] or str
+    :param options: Additional options.
+    :return: The result of the call.
+    :rtype: Response
+    """
+    if isinstance(receipt_handles, string_types):
+        receipt_handles = [receipt_handles]
+
+    return __call_notifications_api("post", ["messages", "ack"],
+                                    {"receipt_handles": receipt_handles}, **options)
+
+
+def __call_notifications_api(method, uri, params, **options):
+    """
+    Private function that assists with performing an API call to the notifications module.
+
+    :param method: The HTTP method. Valid methods: get, post, put, delete
+    :param uri: REST endpoint of the API (without 'notifications' or the cloud name)
+    :param params: Query/body parameters passed to the method
+    :param options: Additional options
+    :rtype: Response
+    :internal
+    """
+    return _call_v2_api(method, uri, params, module="notifications", **options)
+
+
 def only(source, *keys):
     """
     Returns a dictionary containing only the specified keys from the source.
@@ -1384,7 +1567,7 @@ def __delete_resource_params(options, **params):
     :internal
     """
     p = dict(transformations=utils.build_eager(options.get('transformations')),
-             **only(options, "keep_original", "next_cursor", "invalidate"))
+             **only(options, "keep_original", "next_cursor", "invalidate", "batch_id"))
     p.update(params)
     return p
 

{cloudinary-1.45.0 → cloudinary-1.46.1}/cloudinary/api_client/call_account_api.py

@@ -1,7 +1,7 @@
 import cloudinary
 from cloudinary.api_client.execute_request import execute_request
 from cloudinary.provisioning.account_config import account_config
-from cloudinary.utils import get_http_connector, normalize_params
+from cloudinary.utils import get_http_connector, json_body, normalize_params
 
 PROVISIONING_SUB_PATH = "provisioning"
 ACCOUNT_SUB_PATH = "accounts"
@@ -46,9 +46,15 @@ def _execute_account_request(method, uri, auth, params=None, headers=None, **opt
     api_version = options.pop("api_version", cloudinary.API_VERSION)
     provisioning_api_url = "/".join([prefix, api_version, PROVISIONING_SUB_PATH] + uri)
 
+    params = normalize_params(params)
+
+    if method.upper() != "GET":
+        options["body"], headers = json_body(params, headers)
+        params = None
+
     return execute_request(http_connector=_http,
                            method=method,
-                           params=normalize_params(params),
+                           params=params,
                            headers=headers,
                            auth=auth,
                            api_url=provisioning_api_url,