Class: Files::IpAddress
- Inherits:
-
Object
- Object
- Files::IpAddress
- Defined in:
- lib/files.com/models/ip_address.rb
Instance Attribute Summary collapse
-
#attributes ⇒ Object
readonly
Returns the value of attribute attributes.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
Class Method Summary collapse
- .all(params = {}, options = {}) ⇒ Object
-
.list(params = {}, options = {}) ⇒ Object
Parameters: page - int64 - Current page number.
Instance Method Summary collapse
-
#associated_with ⇒ Object
string - The object that this public IP address list is associated with.
-
#group_id ⇒ Object
int64 - Group ID.
-
#id ⇒ Object
string - Unique label for list; used by Zapier and other integrations.
-
#initialize(attributes = {}, options = {}) ⇒ IpAddress
constructor
A new instance of IpAddress.
-
#ip_addresses ⇒ Object
array - A list of IP addresses.
Constructor Details
#initialize(attributes = {}, options = {}) ⇒ IpAddress
Returns a new instance of IpAddress.
7 8 9 10 |
# File 'lib/files.com/models/ip_address.rb', line 7 def initialize(attributes = {}, = {}) @attributes = attributes || {} @options = || {} end |
Instance Attribute Details
#attributes ⇒ Object (readonly)
Returns the value of attribute attributes.
5 6 7 |
# File 'lib/files.com/models/ip_address.rb', line 5 def attributes @attributes end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
5 6 7 |
# File 'lib/files.com/models/ip_address.rb', line 5 def @options end |
Class Method Details
.all(params = {}, options = {}) ⇒ Object
44 45 46 |
# File 'lib/files.com/models/ip_address.rb', line 44 def self.all(params = {}, = {}) list(params, ) end |
.list(params = {}, options = {}) ⇒ Object
Parameters:
page - int64 - Current page number.
per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
36 37 38 39 40 41 42 |
# File 'lib/files.com/models/ip_address.rb', line 36 def self.list(params = {}, = {}) raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String) response, = Api.send_request("/ip_addresses", :get, params, ) end |
Instance Method Details
#associated_with ⇒ Object
string - The object that this public IP address list is associated with.
18 19 20 |
# File 'lib/files.com/models/ip_address.rb', line 18 def associated_with @attributes[:associated_with] end |
#group_id ⇒ Object
int64 - Group ID
23 24 25 |
# File 'lib/files.com/models/ip_address.rb', line 23 def group_id @attributes[:group_id] end |
#id ⇒ Object
string - Unique label for list; used by Zapier and other integrations.
13 14 15 |
# File 'lib/files.com/models/ip_address.rb', line 13 def id @attributes[:id] end |
#ip_addresses ⇒ Object
array - A list of IP addresses.
28 29 30 |
# File 'lib/files.com/models/ip_address.rb', line 28 def ip_addresses @attributes[:ip_addresses] end |