Skip to content

Latest commit

 

History

History
392 lines (272 loc) · 13.6 KB

BitesApi.md

File metadata and controls

392 lines (272 loc) · 13.6 KB
Raw

mosquito_alert.BitesApi

All URIs are relative to https://api.mosquitoalert.com/v1

Method HTTP request Description
bites_create POST /bites/
bites_destroy DELETE /bites/{uuid}/
bites_list GET /bites/
bites_retrieve GET /bites/{uuid}/

bites_create

Bite bites_create(bite_request)

Example

  • Api Key Authentication (cookieAuth):
  • Api Key Authentication (tokenAuth):
  • Bearer (JWT) Authentication (jwtAuth):
import mosquito_alert
from mosquito_alert.models.bite import Bite
from mosquito_alert.models.bite_request import BiteRequest
from mosquito_alert.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mosquitoalert.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = mosquito_alert.Configuration(
    host = "https://api.mosquitoalert.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwtAuth
configuration = mosquito_alert.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with mosquito_alert.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mosquito_alert.BitesApi(api_client)
    bite_request = mosquito_alert.BiteRequest() # BiteRequest | 

    try:
        api_response = api_instance.bites_create(bite_request)
        print("The response of BitesApi->bites_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BitesApi->bites_create: %s\n" % e)

Parameters

Name Type Description Notes
bite_request BiteRequest

Return type

Bite

Authorization

cookieAuth, tokenAuth, jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bites_destroy

bites_destroy(uuid)

Example

  • Api Key Authentication (cookieAuth):
  • Api Key Authentication (tokenAuth):
  • Bearer (JWT) Authentication (jwtAuth):
import mosquito_alert
from mosquito_alert.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mosquitoalert.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = mosquito_alert.Configuration(
    host = "https://api.mosquitoalert.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwtAuth
configuration = mosquito_alert.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with mosquito_alert.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mosquito_alert.BitesApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        api_instance.bites_destroy(uuid)
    except Exception as e:
        print("Exception when calling BitesApi->bites_destroy: %s\n" % e)

Parameters

Name Type Description Notes
uuid str

Return type

void (empty response body)

Authorization

cookieAuth, tokenAuth, jwtAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 No response body -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bites_list

PaginatedBiteList bites_list(created_at_after=created_at_after, created_at_before=created_at_before, location_country_id=location_country_id, location_nuts_2=location_nuts_2, location_nuts_3=location_nuts_3, order_by=order_by, page=page, page_size=page_size, received_at_after=received_at_after, received_at_before=received_at_before, short_id=short_id, updated_at_after=updated_at_after, updated_at_before=updated_at_before, user_uuid=user_uuid)

Example

  • Api Key Authentication (cookieAuth):
  • Api Key Authentication (tokenAuth):
  • Bearer (JWT) Authentication (jwtAuth):
import mosquito_alert
from mosquito_alert.models.paginated_bite_list import PaginatedBiteList
from mosquito_alert.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mosquitoalert.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = mosquito_alert.Configuration(
    host = "https://api.mosquitoalert.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwtAuth
configuration = mosquito_alert.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with mosquito_alert.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mosquito_alert.BitesApi(api_client)
    created_at_after = '2013-10-20T19:20:30+01:00' # datetime | Created at (optional)
    created_at_before = '2013-10-20T19:20:30+01:00' # datetime | Created at (optional)
    location_country_id = 56 # int |  (optional)
    location_nuts_2 = 'location_nuts_2_example' # str |  (optional)
    location_nuts_3 = 'location_nuts_3_example' # str |  (optional)
    order_by = ['order_by_example'] # List[str] | Ordenamiento   (optional)
    page = 56 # int | A page number within the paginated result set. (optional)
    page_size = 56 # int | Number of results to return per page. (optional)
    received_at_after = '2013-10-20T19:20:30+01:00' # datetime | Received at (optional)
    received_at_before = '2013-10-20T19:20:30+01:00' # datetime | Received at (optional)
    short_id = 'short_id_example' # str | Short ID (optional)
    updated_at_after = '2013-10-20T19:20:30+01:00' # datetime | Update at (optional)
    updated_at_before = '2013-10-20T19:20:30+01:00' # datetime | Update at (optional)
    user_uuid = 'user_uuid_example' # str |  (optional)

    try:
        api_response = api_instance.bites_list(created_at_after=created_at_after, created_at_before=created_at_before, location_country_id=location_country_id, location_nuts_2=location_nuts_2, location_nuts_3=location_nuts_3, order_by=order_by, page=page, page_size=page_size, received_at_after=received_at_after, received_at_before=received_at_before, short_id=short_id, updated_at_after=updated_at_after, updated_at_before=updated_at_before, user_uuid=user_uuid)
        print("The response of BitesApi->bites_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BitesApi->bites_list: %s\n" % e)

Parameters

Name Type Description Notes
created_at_after datetime Created at [optional]
created_at_before datetime Created at [optional]
location_country_id int [optional]
location_nuts_2 str [optional]
location_nuts_3 str [optional]
order_by List[str] Ordenamiento [optional]
page int A page number within the paginated result set. [optional]
page_size int Number of results to return per page. [optional]
received_at_after datetime Received at [optional]
received_at_before datetime Received at [optional]
short_id str Short ID [optional]
updated_at_after datetime Update at [optional]
updated_at_before datetime Update at [optional]
user_uuid str [optional]

Return type

PaginatedBiteList

Authorization

cookieAuth, tokenAuth, jwtAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bites_retrieve

Bite bites_retrieve(uuid)

Example

  • Api Key Authentication (cookieAuth):
  • Api Key Authentication (tokenAuth):
  • Bearer (JWT) Authentication (jwtAuth):
import mosquito_alert
from mosquito_alert.models.bite import Bite
from mosquito_alert.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mosquitoalert.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = mosquito_alert.Configuration(
    host = "https://api.mosquitoalert.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwtAuth
configuration = mosquito_alert.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with mosquito_alert.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mosquito_alert.BitesApi(api_client)
    uuid = 'uuid_example' # str | 

    try:
        api_response = api_instance.bites_retrieve(uuid)
        print("The response of BitesApi->bites_retrieve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BitesApi->bites_retrieve: %s\n" % e)

Parameters

Name Type Description Notes
uuid str

Return type

Bite

Authorization

cookieAuth, tokenAuth, jwtAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]