Class: Files::IpAddress

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/ip_address.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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 = {}, options = {})
  @attributes = attributes || {}
  @options = 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
  @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 = {}, options = {})
  list(params, options)
end

.get_reserved(params = {}, options = {}) ⇒ Object

Parameters:

cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).

Raises:



51
52
53
54
55
56
57
58
 
# File 'lib/files.com/models/ip_address.rb', line 51

def self.get_reserved(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)

  List.new(PublicIpAddress, params) do
    Api.send_request("/ip_addresses/reserved", :get, params, options)
  end
end

.list(params = {}, options = {}) ⇒ Object

Parameters:

cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).

Raises:



35
36
37
38
39
40
41
42
 
# File 'lib/files.com/models/ip_address.rb', line 35

def self.list(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)

  List.new(IpAddress, params) do
    Api.send_request("/ip_addresses", :get, params, options)
  end
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