ds_stoa.order
=============

.. py:module:: ds_stoa.order

.. autoapi-nested-parse::

   This module provides functionality for interacting with the Stoa API
   to place orders. It encapsulates the process of sending order requests
   through the `order` function, which communicates with the Stoa API
   to order products or services.

   The `order` function is designed to be used by other parts of the
   application that require interaction with the Stoa API for placing
   orders. It simplifies the API interaction by abstracting the details
   of the HTTP request and response handling.

   **Example Usage**::

       from ds_stoa.order import order

       # Authentication token and parameters for the order
       token = "your_auth_token"
       params = {
           "product_group_name": "your_product_group_name",
           "product_name": "your_product_name",
           "workspace": "your_workspace",
           "owner_id": "your_owner_id",
           "version": "1.0",
           "offset": "0",
           "limit": "20",
           "ascending": "False",
       }

       # Send an order request
       order_ids = order(token=token, params=params)
       print(order_ids)



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/ds_stoa/order/_order/index


Functions
---------

.. autoapisummary::

   ds_stoa.order.order


Package Contents
----------------

.. py:function:: order(token: str, params: Dict) -> List[str]

   Send order request to Stoa API.

   :param token: Authentication token required for the API request.
   :param params: Parameters for the order request, such as product ID and quantity.
   :return: A dictionary containing the response from the Stoa API.

   **Example**::

           >>> order(token=token, params=params)
           ["12345.snappy.parquet", "67890.snappy.parquet"]