Class: Files::InboxRegistration

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ InboxRegistration

Returns a new instance of InboxRegistration.



7
8
9
10
 
# File 'lib/files.com/models/inbox_registration.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/inbox_registration.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/files.com/models/inbox_registration.rb', line 5

def options
  @options
end

Class Method Details

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



90
91
92
 
# File 'lib/files.com/models/inbox_registration.rb', line 90

def self.all(params = {}, options = {})
  list(params, options)
end

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

Parameters:

cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
action - string
page - int64
folder_behavior_id - int64 - ID of the associated Inbox.

Raises:



78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/files.com/models/inbox_registration.rb', line 78

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

  List.new(InboxRegistration, params) do
    Api.send_request("/inbox_registrations", :get, params, options)
  end
end

Instance Method Details

#clickwrap_body ⇒ Object

string - Clickwrap text that was shown to the registrant



38
39
40
 
# File 'lib/files.com/models/inbox_registration.rb', line 38

def clickwrap_body
  @attributes[:clickwrap_body]
end

#code ⇒ Object

string - Registration cookie code



13
14
15
 
# File 'lib/files.com/models/inbox_registration.rb', line 13

def code
  @attributes[:code]
end

#company ⇒ Object

string - Registrant company name



23
24
25
 
# File 'lib/files.com/models/inbox_registration.rb', line 23

def company
  @attributes[:company]
end

#created_at ⇒ Object

date-time - Registration creation date/time



68
69
70
 
# File 'lib/files.com/models/inbox_registration.rb', line 68

def created_at
  @attributes[:created_at]
end

#email ⇒ Object

string - Registrant email address



28
29
30
 
# File 'lib/files.com/models/inbox_registration.rb', line 28

def email
  @attributes[:email]
end

#form_field_data ⇒ Object

object - Data for form field set with form field ids as keys and user data as values



48
49
50
 
# File 'lib/files.com/models/inbox_registration.rb', line 48

def form_field_data
  @attributes[:form_field_data]
end

#form_field_set_id ⇒ Object

int64 - Id of associated form field set



43
44
45
 
# File 'lib/files.com/models/inbox_registration.rb', line 43

def form_field_set_id
  @attributes[:form_field_set_id]
end

#inbox_id ⇒ Object

int64 - Id of associated inbox



53
54
55
 
# File 'lib/files.com/models/inbox_registration.rb', line 53

def inbox_id
  @attributes[:inbox_id]
end

#inbox_recipient_id ⇒ Object

int64 - Id of associated inbox recipient



58
59
60
 
# File 'lib/files.com/models/inbox_registration.rb', line 58

def inbox_recipient_id
  @attributes[:inbox_recipient_id]
end

#inbox_title ⇒ Object

string - Title of associated inbox



63
64
65
 
# File 'lib/files.com/models/inbox_registration.rb', line 63

def inbox_title
  @attributes[:inbox_title]
end

#ip ⇒ Object

string - Registrant IP Address



33
34
35
 
# File 'lib/files.com/models/inbox_registration.rb', line 33

def ip
  @attributes[:ip]
end

#name ⇒ Object

string - Registrant name



18
19
20
 
# File 'lib/files.com/models/inbox_registration.rb', line 18

def name
  @attributes[:name]
end