Class: Files::FormFieldSet

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of FormFieldSet.



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

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

Class Method Details

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



109
110
111
 
# File 'lib/files.com/models/form_field_set.rb', line 109

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

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

Parameters:

user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
title - string - Title to be displayed
form_fields - array(object)

Raises:



133
134
135
136
137
138
139
140
 
# File 'lib/files.com/models/form_field_set.rb', line 133

def self.create(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: title must be an String") if params.dig(:title) and !params.dig(:title).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: form_fields must be an Array") if params.dig(:form_fields) and !params.dig(:form_fields).is_a?(Array)

  response, options = Api.send_request("/form_field_sets", :post, params, options)
  FormFieldSet.new(response.data, options)
end

.delete(id, params = {}, options = {}) ⇒ Object

Raises:



157
158
159
160
161
162
163
164
165
 
# File 'lib/files.com/models/form_field_set.rb', line 157

def self.delete(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)

  response, _options = Api.send_request("/form_field_sets/#{params[:id]}", :delete, params, options)
  response.data
end

.destroy(id, params = {}, options = {}) ⇒ Object 



167
168
169
 
# File 'lib/files.com/models/form_field_set.rb', line 167

def self.destroy(id, params = {}, options = {})
  delete(id, params, options)
end

.find(id, params = {}, options = {}) ⇒ Object

Parameters:

id (required) - int64 - Form Field Set ID.

Raises:



115
116
117
118
119
120
121
122
123
 
# File 'lib/files.com/models/form_field_set.rb', line 115

def self.find(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)

  response, options = Api.send_request("/form_field_sets/#{params[:id]}", :get, params, options)
  FormFieldSet.new(response.data, options)
end

.get(id, params = {}, options = {}) ⇒ Object 



125
126
127
 
# File 'lib/files.com/models/form_field_set.rb', line 125

def self.get(id, params = {}, options = {})
  find(id, params, options)
end

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

Parameters:

user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
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:



99
100
101
102
103
104
105
106
107
 
# File 'lib/files.com/models/form_field_set.rb', line 99

def self.list(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
  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(FormFieldSet, params) do
    Api.send_request("/form_field_sets", :get, params, options)
  end
end

.update(id, params = {}, options = {}) ⇒ Object

Parameters:

title - string - Title to be displayed
form_fields - array(object)

Raises:



145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/files.com/models/form_field_set.rb', line 145

def self.update(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: title must be an String") if params.dig(:title) and !params.dig(:title).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: form_fields must be an Array") if params.dig(:form_fields) and !params.dig(:form_fields).is_a?(Array)
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)

  response, options = Api.send_request("/form_field_sets/#{params[:id]}", :patch, params, options)
  FormFieldSet.new(response.data, options)
end

Instance Method Details

#delete(params = {}) ⇒ Object

Raises:



72
73
74
75
76
77
78
79
80
 
# File 'lib/files.com/models/form_field_set.rb', line 72

def delete(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)

  Api.send_request("/form_field_sets/#{@attributes[:id]}", :delete, params, @options)
end

#destroy(params = {}) ⇒ Object 



82
83
84
 
# File 'lib/files.com/models/form_field_set.rb', line 82

def destroy(params = {})
  delete(params)
end

#form_fields ⇒ Object

array - Associated form fields



40
41
42
 
# File 'lib/files.com/models/form_field_set.rb', line 40

def form_fields
  @attributes[:form_fields]
end

#form_fields=(value) ⇒ Object 



44
45
46
 
# File 'lib/files.com/models/form_field_set.rb', line 44

def form_fields=(value)
  @attributes[:form_fields] = value
end

#form_layout ⇒ Object

int64 - Layout of the form



31
32
33
 
# File 'lib/files.com/models/form_field_set.rb', line 31

def form_layout
  @attributes[:form_layout]
end

#form_layout=(value) ⇒ Object 



35
36
37
 
# File 'lib/files.com/models/form_field_set.rb', line 35

def form_layout=(value)
  @attributes[:form_layout] = value
end

#id ⇒ Object

int64 - Form field set id



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

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



17
18
19
 
# File 'lib/files.com/models/form_field_set.rb', line 17

def id=(value)
  @attributes[:id] = value
end

#save ⇒ Object 



86
87
88
89
90
91
92
93
 
# File 'lib/files.com/models/form_field_set.rb', line 86

def save
  if @attributes[:id]
    update(@attributes)
  else
    new_obj = FormFieldSet.create(@attributes, @options)
    @attributes = new_obj.attributes
  end
end

#title ⇒ Object

string - Title to be displayed



22
23
24
 
# File 'lib/files.com/models/form_field_set.rb', line 22

def title
  @attributes[:title]
end

#title=(value) ⇒ Object 



26
27
28
 
# File 'lib/files.com/models/form_field_set.rb', line 26

def title=(value)
  @attributes[:title] = value
end

#update(params = {}) ⇒ Object

Parameters:

title - string - Title to be displayed
form_fields - array(object)

Raises:



60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/files.com/models/form_field_set.rb', line 60

def update(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: title must be an String") if params.dig(:title) and !params.dig(:title).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: form_fields must be an Array") if params.dig(:form_fields) and !params.dig(:form_fields).is_a?(Array)
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)

  Api.send_request("/form_field_sets/#{@attributes[:id]}", :patch, params, @options)
end

#user_id ⇒ Object

int64 - User ID. Provide a value of ‘0` to operate the current session’s user.



49
50
51
 
# File 'lib/files.com/models/form_field_set.rb', line 49

def user_id
  @attributes[:user_id]
end

#user_id=(value) ⇒ Object 



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

def user_id=(value)
  @attributes[:user_id] = value
end