Utils

Welcome to the utils module! This module is designed to provide essential utilities that simplify and enhance your workflow with Odin's Spear. Whether you're managing configurations, handling JSON data, or working with predefined constants, the utils module offers a set of tools to make your development experience more efficient.

---

What’s Inside the Utils Module?

The utils module is structured to support various common operations required when interacting with BroadWorks APIs. Here's what you’ll find:

1. Constants

The constants.py file contains predefined lists of:

• Supported filters and filter types for searches.

• Group services and user services in BroadWorks.

These constants help ensure consistency and reduce the need for hardcoding values.

2. Checkers

The checkers.py file provides validation functions for:

• Ensuring that only supported filters and filter types are used.

• Raising appropriate exceptions when an unsupported filter or type is encountered.

These functions prevent errors when working with API requests.

3. Formatters

The formatters.py file provides utility functions for:

• Formatting filter values with appropriate wildcards based on filter types.

• Formatting phone numbers by prepending country codes.

• Ensuring that serviceInstanceProfile keys exist in data structures.

These functions ensure data is structured correctly before being sent to APIs.

4. Parsers

The parsers.py file provides utility functions for:

• Converting JSON strings to Python dictionaries.

• Converting Python dictionaries to JSON strings.

These functions make it easier to handle and manipulate data in JSON format, a key requirement for interacting with APIs.

5. Configurations (Coming Soon)

Predefined JSON templates for common BroadWorks entities. These configurations will help you structure API requests with ease. Stay tuned for details on how to use them effectively!

---

Why Use the Utils Module?

The utils module is here to:

• Save you time by offering ready-to-use constants and templates.

• Provide reliable tools for working with JSON data.

• Standardise your workflows with BroadWorks APIs.

---

Getting Started

To use the utils module, you simply need to import the required components into your project. Examples and detailed documentation for each utility are provided in their respective sections.

Example:

Here’s how you might import and use a utility:

from odins_spear.utils.parsers import json_to_dictionary
from odins_spear.utils.constants import supported_filters
from odins_spear.utils.checkers import check_type_filter
from odins_spear.utils.formatters import format_filter_value

# Convert a JSON string to a dictionary
json_data = '{"key": "value"}'
data = json_to_dictionary(json_data)

# Print supported filters
print(supported_filters)

# Validate a filter type
check_type_filter("firstName", "contains")

# Format a filter value
formatted_value = format_filter_value("contains", "example")
print(formatted_value)  # Output: *example*