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.12.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.12.0.20241025

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.12.0.20241025
File Size Uploaded Provenance Actions
waylay_sdk_rules_types-6.12.0.20241025.tar.gz 28.4 kB With provenance Details for waylay_sdk_rules_types-6.12.0.20241025.tar.gz

Built distribution (wheel)

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

Total release size: 126.1 kB

Release files / waylay_sdk_rules_types-6.12.0.20241025.tar.gz

Download URL waylay_sdk_rules_types-6.12.0.20241025.tar.gz
Size 28.4 kB
Tags Source
SHA-256 checksum
How to use checksums
f91b46fae1a4f911e452566c1627803e6ef6b7b17d6e00119e24b3620b1c1dce
BLAKE2b-256 checksum
How to use checksums
0659ec6b588d01e11d46cbfbf5a3aba31399d55d0a2de516b13ce89a0f05ac1b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.0.1 CPython/3.12.8

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 16, 2024.

Transparency log

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

Download URL waylay_sdk_rules_types-6.12.0.20241025-py3-none-any.whl
Size 97.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a616d90fd1f1affcfea3751d2d3b41ab7032bbd197b8a0bcdc76668a4be0fc73
BLAKE2b-256 checksum
How to use checksums
08fd995bf96afa77892c84df6fe52a63ddbe934d7a5ce384a0fa8669baecab81
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.0.1 CPython/3.12.8

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 16, 2024.

Transparency log

Security for waylay-sdk-rules-types 6.12.0.20241025

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for waylay_sdk_rules_types-6.12.0.20241025.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 16, 2024.

Transparency log

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