ds_provider_simployer_py_lib.endpoint_info¶

Endpoint information for Simployer data products. This module centralizes endpoint URLs and supported HTTP methods.

Attributes¶

ENDPOINTS

Classes¶

EndpointInfo

Module Contents¶

class ds_provider_simployer_py_lib.endpoint_info.EndpointInfo(name: str, url: str, methods: list[str], description: str | None = None)[source]¶

name¶

url¶

methods¶

description = None¶

static get_endpoint_for_product(data_product: ds_provider_simployer_py_lib.enums.SimployerDataProducts) → str | None[source]¶

Returns the endpoint URL for a given SimployerDataProducts value. If the data product is not found, returns None.

Parameters:: data_product – The SimployerDataProducts enum value for which to retrieve the endpoint URL.
Returns:: The endpoint URL as a string if found, otherwise None.

static supports_method(data_product: ds_provider_simployer_py_lib.enums.SimployerDataProducts, method: str) → bool[source]¶: Returns True if the given HTTP method is supported for the specified SimployerDataProducts value, False otherwise. If the data product is not found, returns False. :param data_product: The SimployerDataProducts enum value for which to check method support. :param method: The HTTP method to check (e.g., “GET”, “POST”, “PUT”, “DELETE”). :return: True if the method is supported for the data product, False otherwise.

ds_provider_simployer_py_lib.endpoint_info.ENDPOINTS¶