Class: NgrokAPI::Services::IPPolicyRulesClient
- Inherits:
-
Object
- Object
- NgrokAPI::Services::IPPolicyRulesClient
- Defined in:
- lib/ngrokapi/services/ip_policy_rules_client.rb
Overview
IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.
Constant Summary collapse
- PATH =
The API path for the requests
'/ip_policy_rules'
- LIST_PROPERTY =
The List Property from the resulting API for list calls
'ip_policy_rules'
Instance Attribute Summary collapse
-
#client ⇒ Object
readonly
Returns the value of attribute client.
Instance Method Summary collapse
-
#create(description: "", metadata: "", cidr:, ip_policy_id:, action:) ⇒ NgrokAPI::Models::IPPolicyRule
Create a new IP policy rule attached to an IP Policy.
-
#create!(description: "", metadata: "", cidr:, ip_policy_id:, action:) ⇒ NgrokAPI::Models::IPPolicyRule
Create a new IP policy rule attached to an IP Policy.
-
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete an IP policy rule.
-
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete an IP policy rule.
-
#get(id: "") ⇒ NgrokAPI::Models::IPPolicyRule
Get detailed information about an IP policy rule by ID.
-
#get!(id: "") ⇒ NgrokAPI::Models::IPPolicyRule
Get detailed information about an IP policy rule by ID.
-
#initialize(client:) ⇒ IPPolicyRulesClient
constructor
A new instance of IPPolicyRulesClient.
-
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all IP policy rules on this account.
-
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all IP policy rules on this account Throws an exception if API error.
-
#update(id: "", description: nil, metadata: nil, cidr: nil) ⇒ NgrokAPI::Models::IPPolicyRule
Update attributes of an IP policy rule by ID.
-
#update!(id: "", description: nil, metadata: nil, cidr: nil) ⇒ NgrokAPI::Models::IPPolicyRule
Update attributes of an IP policy rule by ID Throws an exception if API error.
Constructor Details
#initialize(client:) ⇒ IPPolicyRulesClient
Returns a new instance of IPPolicyRulesClient.
20 21 22 |
# File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 20 def initialize(client:) @client = client end |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
18 19 20 |
# File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 18 def client @client end |
Instance Method Details
#create(description: "", metadata: "", cidr:, ip_policy_id:, action:) ⇒ NgrokAPI::Models::IPPolicyRule
Create a new IP policy rule attached to an IP Policy.
35 36 37 38 39 40 41 42 43 44 45 46 47 |
# File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 35 def create(description: "", metadata: "", cidr:, ip_policy_id:, action:) path = '/ip_policy_rules' replacements = { } data = {} data[:description] = description if description data[:metadata] = if data[:cidr] = cidr if cidr data[:ip_policy_id] = ip_policy_id if ip_policy_id data[:action] = action if action result = @client.post(path % replacements, data: data) NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result) end |
#create!(description: "", metadata: "", cidr:, ip_policy_id:, action:) ⇒ NgrokAPI::Models::IPPolicyRule
Create a new IP policy rule attached to an IP Policy. Throws an exception if API error.
61 62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 61 def create!(description: "", metadata: "", cidr:, ip_policy_id:, action:) path = '/ip_policy_rules' replacements = { } data = {} data[:description] = description if description data[:metadata] = if data[:cidr] = cidr if cidr data[:ip_policy_id] = ip_policy_id if ip_policy_id data[:action] = action if action result = @client.post(path % replacements, data: data, danger: true) NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result) end |
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete an IP policy rule.
82 83 84 85 86 87 88 |
# File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 82 def delete(id: "") path = '/ip_policy_rules/%{id}' replacements = { id: id, } @client.delete(path % replacements) end |
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete an IP policy rule. Throws an exception if API error.
98 99 100 101 102 103 104 |
# File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 98 def delete!(id: "") path = '/ip_policy_rules/%{id}' replacements = { id: id, } @client.delete(path % replacements, danger: true) end |
#get(id: "") ⇒ NgrokAPI::Models::IPPolicyRule
Get detailed information about an IP policy rule by ID.
113 114 115 116 117 118 119 120 121 |
# File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 113 def get(id: "") path = '/ip_policy_rules/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data) NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result) end |
#get!(id: "") ⇒ NgrokAPI::Models::IPPolicyRule
Get detailed information about an IP policy rule by ID. Throws an exception if API error.
131 132 133 134 135 136 137 138 139 |
# File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 131 def get!(id: "") path = '/ip_policy_rules/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data, danger: true) NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result) end |
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all IP policy rules on this account
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 150 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::IPPolicyRule ) end |
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all IP policy rules on this account Throws an exception if API error.
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 180 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::IPPolicyRule, danger: true ) end |
#update(id: "", description: nil, metadata: nil, cidr: nil) ⇒ NgrokAPI::Models::IPPolicyRule
Update attributes of an IP policy rule by ID
212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 212 def update(id: "", description: nil, metadata: nil, cidr: nil) path = '/ip_policy_rules/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if data[:cidr] = cidr if cidr result = @client.patch(path % replacements, data: data) NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result) end |
#update!(id: "", description: nil, metadata: nil, cidr: nil) ⇒ NgrokAPI::Models::IPPolicyRule
Update attributes of an IP policy rule by ID Throws an exception if API error.
236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/ngrokapi/services/ip_policy_rules_client.rb', line 236 def update!(id: "", description: nil, metadata: nil, cidr: nil) path = '/ip_policy_rules/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if data[:cidr] = cidr if cidr result = @client.patch(path % replacements, data: data, danger: true) NgrokAPI::Models::IPPolicyRule.new(client: self, attrs: result) end |