RegionsApi.md

ESP::RegionsApi

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

Method	HTTP request	Description
list	PUT /api/v2/regions.json_api	Get a list of Regions
show	GET /api/v2/regions/{id}.json_api	Show a single Region

list

PaginatedCollection list(opts)

Get a list of Regions

Example

# load the gem
require 'esp_sdk'

api_instance = ESP::RegionsApi.new

opts = { 
  filter: {'key' => "filter_example"}, # Hash<String, String> | Filter Params for Searching.  Equality Searchable Attributes: [id, code, name] Matching Searchable Attributes: [code, name] Limited Searchable Attribute: [provider_eq]  Searchable Association: [suppressions] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information.
  page: "{:number=>1,+:size=>20}" # String | 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.
}

begin
  #Get a list of Regions
  result = api_instance.list(opts)
  p result
rescue ESP::ApiError => e
  puts "Exception when calling RegionsApi->list: #{e}"
end

Parameters

Name	Type	Description	Notes
filter	Hash<String, String>	Filter Params for Searching. Equality Searchable Attributes: [id, code, name] Matching Searchable Attributes: [code, name] Limited Searchable Attribute: [provider_eq] Searchable Association: [suppressions] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information.	[optional]
page	String	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-ruby#set-your-hmac-security-keys

HTTP request headers

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

show

Region show(id)

Show a single Region

Example

# load the gem
require 'esp_sdk'

api_instance = ESP::RegionsApi.new

id = 56 # Integer | Region ID


begin
  #Show a single Region
  result = api_instance.show(id)
  p result
rescue ESP::ApiError => e
  puts "Exception when calling RegionsApi->show: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	Region ID

Return type

Region

Authorization

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

HTTP request headers

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