PlansApi.md

esp_sdk.PlansApi

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

Method	HTTP request	Description
list	GET /api/v2/plans.json_api	Get a list of Plans
show	GET /api/v2/plans/{id}.json_api	Show a single Plan

list

PaginatedCollection list(page=page)

Get a list of Plans

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.PlansApi()
page = '{:number=>1,+:size=>20}' # str | Page Number and Page Size.  Number is the page number of the collection to return, size is the number of items to return per page. (optional) (default to {:number=>1,+:size=>20})

try: 
    # Get a list of Plans
    api_response = api_instance.list(page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlansApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
page	str	Page Number and Page Size. Number is the page number of the collection to return, size is the number of items to return per page.	[optional] [default to {:number=>1,+:size=>20}]

Return type

PaginatedCollection

Authorization

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

• Content-Type: application/vnd.api+json
• Accept: application/vnd.api+json

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

show

Plan show(id)

Show a single Plan

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.PlansApi()
id = 56 # int | Plan ID

try: 
    # Show a single Plan
    api_response = api_instance.show(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlansApi->show: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Plan ID

Return type

Plan

Authorization

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

• Content-Type: application/vnd.api+json
• Accept: application/vnd.api+json

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