Skip to content

Latest commit

 

History

History
337 lines (237 loc) · 10.4 KB

BouncesApi.md

File metadata and controls

337 lines (237 loc) · 10.4 KB
Raw

openapi_client.BouncesApi

All URIs are relative to http://localhost:9000/api

Method HTTP request Description
delete_bounce_by_id DELETE /bounces/{id}
delete_bounces DELETE /bounces
get_bounce_by_id GET /bounces/{id}
get_bounces GET /bounces

delete_bounce_by_id

GetHealthCheck200Response delete_bounce_by_id(id)

handles bounce deletion, either a single one (ID in the URI), or a list.

Example

  • Basic Authentication (basicAuth):
import time
import os
import listmonk
from listmonk.models.get_health_check200_response import GetHealthCheck200Response
from listmonk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:9000/api
# See configuration.py for a list of all supported configuration parameters.
configuration = listmonk.Configuration(
    host="http://localhost:9000/api"
)

# 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 HTTP basic authorization: basicAuth
configuration = listmonk.Configuration(
    username=os.environ["USERNAME"],
    password=os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with listmonk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = listmonk.BouncesApi(api_client)
    id = 56  # int | The id value of the bounce you want to delete.
    
    try:
        api_response = api_instance.delete_bounce_by_id(id)
        print("The response of BouncesApi->delete_bounce_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BouncesApi->delete_bounce_by_id: %s\n" % e)

Parameters

Name Type Description Notes
id int The id value of the bounce you want to delete.

Return type

GetHealthCheck200Response

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

delete_bounces

GetHealthCheck200Response delete_bounces(all=all, id=id)

handles retrieval of bounce records.

Example

  • Basic Authentication (basicAuth):
import time
import os
import listmonk
from listmonk.models.get_health_check200_response import GetHealthCheck200Response
from listmonk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:9000/api
# See configuration.py for a list of all supported configuration parameters.
configuration = listmonk.Configuration(
    host="http://localhost:9000/api"
)

# 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 HTTP basic authorization: basicAuth
configuration = listmonk.Configuration(
    username=os.environ["USERNAME"],
    password=os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with listmonk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = listmonk.BouncesApi(api_client)
    all = True  # bool | flag for multiple bounce record deletion (optional)
    id = 'id_example'  # str | list of bounce ids to delete (optional)
    
    try:
        api_response = api_instance.delete_bounces(all=all, id=id)
        print("The response of BouncesApi->delete_bounces:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BouncesApi->delete_bounces: %s\n" % e)

Parameters

Name Type Description Notes
all bool flag for multiple bounce record deletion [optional]
id str list of bounce ids to delete [optional]

Return type

GetHealthCheck200Response

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

get_bounce_by_id

GetBounceById200Response get_bounce_by_id(id)

handles retrieval of bounce record by id

Example

  • Basic Authentication (basicAuth):
import time
import os
import listmonk
from listmonk.models.get_bounce_by_id200_response import GetBounceById200Response
from listmonk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:9000/api
# See configuration.py for a list of all supported configuration parameters.
configuration = listmonk.Configuration(
    host="http://localhost:9000/api"
)

# 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 HTTP basic authorization: basicAuth
configuration = listmonk.Configuration(
    username=os.environ["USERNAME"],
    password=os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with listmonk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = listmonk.BouncesApi(api_client)
    id = 56  # int | The id value of the bounce you want to retreive.
    
    try:
        api_response = api_instance.get_bounce_by_id(id)
        print("The response of BouncesApi->get_bounce_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BouncesApi->get_bounce_by_id: %s\n" % e)

Parameters

Name Type Description Notes
id int The id value of the bounce you want to retreive.

Return type

GetBounceById200Response

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 bounce object -

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

get_bounces

GetBounces200Response get_bounces(campaign_id=campaign_id, page=page, per_page=per_page, source=source, order_by=order_by, order=order)

handles retrieval of bounce records.

Example

  • Basic Authentication (basicAuth):
import time
import os
import listmonk
from listmonk.models.get_bounces200_response import GetBounces200Response
from listmonk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:9000/api
# See configuration.py for a list of all supported configuration parameters.
configuration = listmonk.Configuration(
    host="http://localhost:9000/api"
)

# 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 HTTP basic authorization: basicAuth
configuration = listmonk.Configuration(
    username=os.environ["USERNAME"],
    password=os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with listmonk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = listmonk.BouncesApi(api_client)
    campaign_id = 56  # int | bounce record retrieval of particular campaign (optional)
    page = 56  # int | total number of pages (optional)
    per_page = 56  # int | number of items per page (optional)
    source = 'source_example'  # str |  (optional)
    order_by = 'order_by_example'  # str |  (optional)
    order = 'order_example'  # str |  (optional)
    
    try:
        api_response = api_instance.get_bounces(campaign_id=campaign_id, page=page, per_page=per_page, source=source,
                                                order_by=order_by, order=order)
        print("The response of BouncesApi->get_bounces:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BouncesApi->get_bounces: %s\n" % e)

Parameters

Name Type Description Notes
campaign_id int bounce record retrieval of particular campaign [optional]
page int total number of pages [optional]
per_page int number of items per page [optional]
source str [optional]
order_by str [optional]
order str [optional]

Return type

GetBounces200Response

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 list of bounce records -

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