gfwapiclient.http.endpoints.post

Global Fishing Watch (GFW) API Python Client - POST HTTP EndPoint.

Module Contents

Classes

PostEndPoint

Post API resource endpoint.

Data

__all__

API

gfwapiclient.http.endpoints.post.__all__ = ['PostEndPoint']

class gfwapiclient.http.endpoints.post.PostEndPoint(*, path: str, request_params: Optional[gfwapiclient.http.models.request._RequestParamsT], request_body: Optional[gfwapiclient.http.models.request._RequestBodyT], result_item_class: Type[gfwapiclient.http.models.response._ResultItemT], result_class: Type[gfwapiclient.http.models.response._ResultT], http_client: gfwapiclient.http.client.HTTPClient)

Bases: gfwapiclient.http.endpoints.base.BaseEndPoint[gfwapiclient.http.models.request._RequestParamsT, gfwapiclient.http.models.request._RequestBodyT, gfwapiclient.http.models.response._ResultItemT, gfwapiclient.http.models.response._ResultT]

Post API resource endpoint.

This class extends BaseEndPoint to provide functionality for making POST requests to API endpoints. It encapsulates the logic for handling POST requests, including request preparation and response processing.

Initialization

Initialize a new PostEndPoint.

Args:

path (str):

The relative path of the API endpoint.

request_params (Optional[_RequestParamsT]):

Query parameters for the POST request.

request_body (Optional[_RequestBodyT]):

The request body for the POST request.

result_item_class (Type[_ResultItemT]):

Pydantic model for the expected response item.

result_class (Type[_ResultT]):

Pydantic model for the expected response result.

http_client (HTTPClient):

The HTTP client to send requests.