Class: NgrokAPI::Services::IPPoliciesClient
- Inherits:
-
Object
- Object
- NgrokAPI::Services::IPPoliciesClient
- Defined in:
- lib/ngrokapi/services/ip_policies_client.rb
Overview
IP Policies are reusable groups of CIDR ranges with an allow
or deny
action. They can be attached to endpoints via the Endpoint Configuration IP Policy module. They can also be used with IP Restrictions to control source IP ranges that can start tunnel sessions and connect to the API and dashboard.
Constant Summary collapse
- PATH =
The API path for the requests
'/ip_policies'
- LIST_PROPERTY =
The List Property from the resulting API for list calls
'ip_policies'
Instance Attribute Summary collapse
-
#client ⇒ Object
readonly
Returns the value of attribute client.
Instance Method Summary collapse
-
#create(description: "", metadata: "", action: nil) ⇒ NgrokAPI::Models::IPPolicy
Create a new IP policy.
-
#create!(description: "", metadata: "", action: nil) ⇒ NgrokAPI::Models::IPPolicy
Create a new IP policy.
-
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete an IP policy.
-
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete an IP policy.
-
#get(id: "") ⇒ NgrokAPI::Models::IPPolicy
Get detailed information about an IP policy by ID.
-
#get!(id: "") ⇒ NgrokAPI::Models::IPPolicy
Get detailed information about an IP policy by ID.
-
#initialize(client:) ⇒ IPPoliciesClient
constructor
A new instance of IPPoliciesClient.
-
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all IP policies on this account.
-
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all IP policies on this account Throws an exception if API error.
-
#update(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::IPPolicy
Update attributes of an IP policy by ID.
-
#update!(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::IPPolicy
Update attributes of an IP policy by ID Throws an exception if API error.
Constructor Details
#initialize(client:) ⇒ IPPoliciesClient
Returns a new instance of IPPoliciesClient.
22 23 24 |
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 22 def initialize(client:) @client = client end |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
20 21 22 |
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 20 def client @client end |
Instance Method Details
#create(description: "", metadata: "", action: nil) ⇒ NgrokAPI::Models::IPPolicy
Create a new IP policy. It will not apply to any traffic until you associate to a traffic source via an endpoint configuration or IP restriction.
35 36 37 38 39 40 41 42 43 44 |
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 35 def create(description: "", metadata: "", action: nil) path = '/ip_policies' replacements = { } data = {} data[:description] = description if description data[:metadata] = if result = @client.post(path % replacements, data: data) NgrokAPI::Models::IPPolicy.new(client: self, attrs: result) end |
#create!(description: "", metadata: "", action: nil) ⇒ NgrokAPI::Models::IPPolicy
Create a new IP policy. It will not apply to any traffic until you associate to a traffic source via an endpoint configuration or IP restriction. Throws an exception if API error.
56 57 58 59 60 61 62 63 64 65 |
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 56 def create!(description: "", metadata: "", action: nil) path = '/ip_policies' replacements = { } data = {} data[:description] = description if description data[:metadata] = if result = @client.post(path % replacements, data: data, danger: true) NgrokAPI::Models::IPPolicy.new(client: self, attrs: result) end |
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules.
76 77 78 79 80 81 82 |
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 76 def delete(id: "") path = '/ip_policies/%{id}' replacements = { id: id, } @client.delete(path % replacements) end |
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules. Throws an exception if API error.
94 95 96 97 98 99 100 |
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 94 def delete!(id: "") path = '/ip_policies/%{id}' replacements = { id: id, } @client.delete(path % replacements, danger: true) end |
#get(id: "") ⇒ NgrokAPI::Models::IPPolicy
Get detailed information about an IP policy by ID.
109 110 111 112 113 114 115 116 117 |
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 109 def get(id: "") path = '/ip_policies/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data) NgrokAPI::Models::IPPolicy.new(client: self, attrs: result) end |
#get!(id: "") ⇒ NgrokAPI::Models::IPPolicy
Get detailed information about an IP policy by ID. Throws an exception if API error.
127 128 129 130 131 132 133 134 135 |
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 127 def get!(id: "") path = '/ip_policies/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data, danger: true) NgrokAPI::Models::IPPolicy.new(client: self, attrs: result) end |
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all IP policies on this account
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 146 def list( before_id: nil, limit: nil, url: nil ) result = @client.list( before_id: before_id, limit: limit, url: url, path: PATH ) NgrokAPI::Models::Listable.new( client: self, attrs: result, list_property: LIST_PROPERTY, klass: NgrokAPI::Models::IPPolicy ) end |
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all IP policies on this account Throws an exception if API error.
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 176 def list!( before_id: nil, limit: nil, url: nil ) result = @client.list( before_id: before_id, limit: limit, danger: true, url: url, path: PATH ) NgrokAPI::Models::Listable.new( client: self, attrs: result, list_property: LIST_PROPERTY, klass: NgrokAPI::Models::IPPolicy, danger: true ) end |
#update(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::IPPolicy
Update attributes of an IP policy by ID
207 208 209 210 211 212 213 214 215 216 217 |
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 207 def update(id: "", description: nil, metadata: nil) path = '/ip_policies/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if result = @client.patch(path % replacements, data: data) NgrokAPI::Models::IPPolicy.new(client: self, attrs: result) end |
#update!(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::IPPolicy
Update attributes of an IP policy by ID Throws an exception if API error.
229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/ngrokapi/services/ip_policies_client.rb', line 229 def update!(id: "", description: nil, metadata: nil) path = '/ip_policies/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if result = @client.patch(path % replacements, data: data, danger: true) NgrokAPI::Models::IPPolicy.new(client: self, attrs: result) end |