Skip to main content

Waylay Rules Service

The REST api to manage rule tasks and rule templates in the Waylay platform.

This Python package is automatically generated based on the Waylay Rules OpenAPI specification (API version: 6.5.0) For more information, please visit the openapi specification.

It is considered an extension of the waylay-sdk-rules package, and it consists of the typed model classes for all path params, query params, body params and responses for each of the api methods in waylay-sdk-rules.

Requirements.

This package requires Python 3.9+.

Installation

Typically this package is installed when installing the waylay-sdk-core package to enable the service's functionality. When the service api methods are required, waylay-sdk-rules is included in:

  • pip install waylay-sdk-core[rules] to install waylay-sdk-core along with only this service, or
  • pip install waylay-sdk-core[services] to install waylay-sdk-core along with all services. When the typed models are required, both waylay-sdk-rules and waylay-sdk-rules-types are included in:
  • pip install waylay-sdk-core[rules,rules-types] to install waylay-sdk-core along with only this service including the typed models, or
  • pip install waylay-sdk-core[services,services-types] to install waylay-sdk-core along with all services along with the typed models.

Usage

from pprint import pprint

# Import the waylay-client from the waylay-sdk-core package
from waylay.sdk.client import WaylayClient
from waylay.sdk.api.api_exceptions import ApiError

# Intialize a waylay client instance
waylay_client = WaylayClient.from_profile()

# Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-rules-types` is installed
from waylay.services.rules.models.version_response import VersionResponse
try:
    # Get Service Information
    # calls `GET /rules/v1`
    api_response = await waylay_client.rules.about.get(
    )
    print("The response of rules.about.get:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling rules.about.get: %s\n" % e)

For more information, please visit the Waylay API documentation.

Metadata

Release files for waylay-sdk-rules-types 6.5.0.20240423

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for waylay-sdk-rules-types 6.5.0.20240423
File Size Uploaded Provenance Actions
waylay_sdk_rules_types-6.5.0.20240423.tar.gz 26.9 kB Without provenance Details for waylay_sdk_rules_types-6.5.0.20240423.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for waylay-sdk-rules-types 6.5.0.20240423
File Interpreter ABI Platform Actions
waylay_sdk_rules_types-6.5.0.20240423-py3-none-any.whl Python 3 none any Details for waylay_sdk_rules_types-6.5.0.20240423-py3-none-any.whl

Total release size: 118.7 kB

Release files / waylay_sdk_rules_types-6.5.0.20240423.tar.gz

Download URL waylay_sdk_rules_types-6.5.0.20240423.tar.gz
Size 26.9 kB
Tags Source
SHA-256 checksum
How to use checksums
44b671e7176ba3b6f91eb0973696574fbb0bcc7043f71cd177b19575344946b1
BLAKE2b-256 checksum
How to use checksums
478f96a2d2f18f2675df6d682aced7a2487a1affbd956a923e6c206ed1a36d6f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.0.0 CPython/3.12.3

Release files / waylay_sdk_rules_types-6.5.0.20240423-py3-none-any.whl

Download URL waylay_sdk_rules_types-6.5.0.20240423-py3-none-any.whl
Size 91.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1754f260bbdda5cf524c70f1d20aa85c188de7c8c31c5c5d6d696be43bd1106d
BLAKE2b-256 checksum
How to use checksums
cfc2ffbbbeb3739ff5cdbe53f84749df6408ccdb446ac966e9303a28dbc7aae4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.0.0 CPython/3.12.3

Security for waylay-sdk-rules-types 6.5.0.20240423

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page