Skip to content

Latest commit

 

History

History
321 lines (237 loc) · 10.4 KB

EmailsApi.md

File metadata and controls

321 lines (237 loc) · 10.4 KB

metal.EmailsApi

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

Method HTTP request Description
create_email POST /emails Create an email
delete_email DELETE /emails/{id} Delete the email
find_email_by_id GET /emails/{id} Retrieve an email
update_email PUT /emails/{id} Update the email

create_email

Email create_email(create_email_input)

Create an email

Add a new email address to the current user.

Example

  • Api Key Authentication (x_auth_token):
from __future__ import print_function
import time
import metal
from metal.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.equinix.com/metal/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = metal.Configuration(
    host = "https://api.equinix.com/metal/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: x_auth_token
configuration.api_key['x_auth_token'] = 'YOUR_API_KEY'

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

# Enter a context with an instance of the API client
with metal.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = metal.EmailsApi(api_client)
    create_email_input = metal.CreateEmailInput() # CreateEmailInput | Email to create

    try:
        # Create an email
        api_response = api_instance.create_email(create_email_input)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling EmailsApi->create_email: %s\n" % e)

Parameters

Name Type Description Notes
create_email_input CreateEmailInput Email to create

Return type

Email

Authorization

x_auth_token

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 created -
401 unauthorized -
422 unprocessable entity -

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

delete_email

delete_email(id)

Delete the email

Deletes the email.

Example

  • Api Key Authentication (x_auth_token):
from __future__ import print_function
import time
import metal
from metal.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.equinix.com/metal/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = metal.Configuration(
    host = "https://api.equinix.com/metal/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: x_auth_token
configuration.api_key['x_auth_token'] = 'YOUR_API_KEY'

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

# Enter a context with an instance of the API client
with metal.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = metal.EmailsApi(api_client)
    id = 'id_example' # str | Email UUID

    try:
        # Delete the email
        api_instance.delete_email(id)
    except ApiException as e:
        print("Exception when calling EmailsApi->delete_email: %s\n" % e)

Parameters

Name Type Description Notes
id str Email UUID

Return type

void (empty response body)

Authorization

x_auth_token

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 no content -
401 unauthorized -
403 forbidden -
404 not found -

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

find_email_by_id

Email find_email_by_id(id, include=include, exclude=exclude)

Retrieve an email

Provides one of the user’s emails.

Example

  • Api Key Authentication (x_auth_token):
from __future__ import print_function
import time
import metal
from metal.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.equinix.com/metal/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = metal.Configuration(
    host = "https://api.equinix.com/metal/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: x_auth_token
configuration.api_key['x_auth_token'] = 'YOUR_API_KEY'

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

# Enter a context with an instance of the API client
with metal.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = metal.EmailsApi(api_client)
    id = 'id_example' # str | Email UUID
include = ['include_example'] # list[str] | Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects. (optional)
exclude = ['exclude_example'] # list[str] | Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects. (optional)

    try:
        # Retrieve an email
        api_response = api_instance.find_email_by_id(id, include=include, exclude=exclude)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling EmailsApi->find_email_by_id: %s\n" % e)

Parameters

Name Type Description Notes
id str Email UUID
include list[str] Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects. [optional]
exclude list[str] Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects. [optional]

Return type

Email

Authorization

x_auth_token

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 ok -
401 unauthorized -
403 forbidden -
404 not found -

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

update_email

Email update_email(id, update_email_input)

Update the email

Updates the email.

Example

  • Api Key Authentication (x_auth_token):
from __future__ import print_function
import time
import metal
from metal.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.equinix.com/metal/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = metal.Configuration(
    host = "https://api.equinix.com/metal/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: x_auth_token
configuration.api_key['x_auth_token'] = 'YOUR_API_KEY'

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

# Enter a context with an instance of the API client
with metal.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = metal.EmailsApi(api_client)
    id = 'id_example' # str | Email UUID
update_email_input = metal.UpdateEmailInput() # UpdateEmailInput | email to update

    try:
        # Update the email
        api_response = api_instance.update_email(id, update_email_input)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling EmailsApi->update_email: %s\n" % e)

Parameters

Name Type Description Notes
id str Email UUID
update_email_input UpdateEmailInput email to update

Return type

Email

Authorization

x_auth_token

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 ok -
401 unauthorized -
403 forbidden -
404 not found -
422 unprocessable entity -

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