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

Normally this package is installed together with support for other services using the waylay-sdk umbrella package:

  • pip install waylay-sdk will install waylay-sdk-rules together with the SDK api packages for other services.
  • pip install waylay-sdk[types-rules] will additionally install the types package waylay-sdk-rules-types.
  • pip install waylay-sdk[types] will install the types packages for this and all other services.

Alternatively, you can install support for this rules service only, installing or extending an existing waylay-sdk-core:

  • pip install waylay-sdk-rules to only install api support for rules.
  • pip install waylay-sdk-rules[types] to additionally install type support for rules.

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.20240802

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.20240802
File Size Uploaded Provenance Actions
waylay_sdk_rules_types-6.5.0.20240802.tar.gz 27.0 kB Without provenance Details for waylay_sdk_rules_types-6.5.0.20240802.tar.gz

Built distribution (wheel)

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

Total release size: 118.8 kB

Release files / waylay_sdk_rules_types-6.5.0.20240802.tar.gz

Download URL waylay_sdk_rules_types-6.5.0.20240802.tar.gz
Size 27.0 kB
Tags Source
SHA-256 checksum
How to use checksums
729328b549623383142d0a1b67d69fe9638877a1ed64221ad5fb0ae5605c068c
BLAKE2b-256 checksum
How to use checksums
d3bf69d735e7ce79fc114f7aa50bef66035f2a83c5e766cead296df97146b625
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.0 CPython/3.12.4

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

Download URL waylay_sdk_rules_types-6.5.0.20240802-py3-none-any.whl
Size 91.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4f7686beb9e016fd69864ac2c1f1d192fc0f07c531888b3bcc65f4868d31fe5e
BLAKE2b-256 checksum
How to use checksums
945a7240a175ceaa3cf0cf2ea4d2ffabfcf939e86a9b19a0b50983aa645792dd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.0 CPython/3.12.4

Security for waylay-sdk-rules-types 6.5.0.20240802

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