wordlift_client.PlatformLimitsApi

All URIs are relative to https://api.wordlift.io

Method	HTTP request	Description
create_platform_limit	POST /platform-limit/limits	Create Platform Limit
delete_platform_limit	DELETE /platform-limit/limits/{id}	Delete Platform Limit
get_platform_limit	GET /platform-limit/limits/{id}	Get Platform Limit
list_platform_limits	GET /platform-limit/limits	List Platform Limits
update_platform_limit	PUT /platform-limit/limits/{id}	Update Platform Limit

create_platform_limit

PlatformLimit create_platform_limit(platform_limit_request)

Create Platform Limit

Create a platform limit.

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.platform_limit import PlatformLimit
from wordlift_client.models.platform_limit_request import PlatformLimitRequest
from wordlift_client.rest import ApiException
from pprint import pprint

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

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.PlatformLimitsApi(api_client)
    platform_limit_request = wordlift_client.PlatformLimitRequest() # PlatformLimitRequest | 

    try:
        # Create Platform Limit
        api_response = await api_instance.create_platform_limit(platform_limit_request)
        print("The response of PlatformLimitsApi->create_platform_limit:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlatformLimitsApi->create_platform_limit: %s\n" % e)

Parameters

Name	Type	Description	Notes
platform_limit_request	PlatformLimitRequest

Return type

PlatformLimit

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Found	-
401	Authentication Failure	-
404	Not Found	-

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

delete_platform_limit

delete_platform_limit(id)

Delete Platform Limit

Delete a platform limit.

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.rest import ApiException
from pprint import pprint

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

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.PlatformLimitsApi(api_client)
    id = 56 # int | Platform Limit id

    try:
        # Delete Platform Limit
        await api_instance.delete_platform_limit(id)
    except Exception as e:
        print("Exception when calling PlatformLimitsApi->delete_platform_limit: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Platform Limit id

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Found	-
401	Authentication Failure	-
404	Not Found	-

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

get_platform_limit

PlatformLimit get_platform_limit(id)

Get Platform Limit

Get a platform limit.

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.platform_limit import PlatformLimit
from wordlift_client.rest import ApiException
from pprint import pprint

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

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.PlatformLimitsApi(api_client)
    id = 56 # int | Platform Limit id

    try:
        # Get Platform Limit
        api_response = await api_instance.get_platform_limit(id)
        print("The response of PlatformLimitsApi->get_platform_limit:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlatformLimitsApi->get_platform_limit: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Platform Limit id

Return type

PlatformLimit

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Found	-
401	Authentication Failure	-
404	Not Found	-

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

list_platform_limits

PagePlatformLimit list_platform_limits(based_on_in=based_on_in, based_on_value_in=based_on_value_in, applies_to_in=applies_to_in, scope_in=scope_in)

List Platform Limits

List the platform limits.

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.page_platform_limit import PagePlatformLimit
from wordlift_client.rest import ApiException
from pprint import pprint

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

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.PlatformLimitsApi(api_client)
    based_on_in = ['based_on_in_example'] # List[str] | The type of based on, e.g. `sku`. (optional)
    based_on_value_in = ['based_on_value_in_example'] # List[str] | The based on values. (optional)
    applies_to_in = ['applies_to_in_example'] # List[str] | The applies to (e.g. API name). (optional)
    scope_in = ['scope_in_example'] # List[str] | The scope. (optional)

    try:
        # List Platform Limits
        api_response = await api_instance.list_platform_limits(based_on_in=based_on_in, based_on_value_in=based_on_value_in, applies_to_in=applies_to_in, scope_in=scope_in)
        print("The response of PlatformLimitsApi->list_platform_limits:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlatformLimitsApi->list_platform_limits: %s\n" % e)

Parameters

Name	Type	Description	Notes
based_on_in	List[str]	The type of based on, e.g. `sku`.	[optional]
based_on_value_in	List[str]	The based on values.	[optional]
applies_to_in	List[str]	The applies to (e.g. API name).	[optional]
scope_in	List[str]	The scope.	[optional]

Return type

PagePlatformLimit

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Found	-
401	Authentication Failure	-
404	Not Found	-

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

update_platform_limit

PlatformLimit update_platform_limit(id, platform_limit_request)

Update Platform Limit

Update a platform limit.

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.platform_limit import PlatformLimit
from wordlift_client.models.platform_limit_request import PlatformLimitRequest
from wordlift_client.rest import ApiException
from pprint import pprint

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

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.PlatformLimitsApi(api_client)
    id = 56 # int | Platform Limit id
    platform_limit_request = wordlift_client.PlatformLimitRequest() # PlatformLimitRequest | 

    try:
        # Update Platform Limit
        api_response = await api_instance.update_platform_limit(id, platform_limit_request)
        print("The response of PlatformLimitsApi->update_platform_limit:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlatformLimitsApi->update_platform_limit: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Platform Limit id
platform_limit_request	PlatformLimitRequest

Return type

PlatformLimit

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Found	-
401	Authentication Failure	-
404	Not Found	-

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

Files

PlatformLimitsApi.md

Latest commit

History

PlatformLimitsApi.md

File metadata and controls

wordlift_client.PlatformLimitsApi

create_platform_limit

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_platform_limit

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_platform_limit

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_platform_limits

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_platform_limit

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details