Class: Files::Clickwrap

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Clickwrap.



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

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

Class Method Details

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



129
130
131
 
# File 'lib/files.com/models/clickwrap.rb', line 129

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

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

Parameters:

name - string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
body - string - Body text of Clickwrap (supports Markdown formatting).
use_with_bundles - string - Use this Clickwrap for Bundles?
use_with_inboxes - string - Use this Clickwrap for Inboxes?
use_with_users - string - Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.

Raises:



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

def self.create(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: body must be an String") if params[:body] and !params[:body].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: use_with_bundles must be an String") if params[:use_with_bundles] and !params[:use_with_bundles].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: use_with_inboxes must be an String") if params[:use_with_inboxes] and !params[:use_with_inboxes].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: use_with_users must be an String") if params[:use_with_users] and !params[:use_with_users].is_a?(String)

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

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

Raises:



187
188
189
190
191
192
193
194
195
 
# File 'lib/files.com/models/clickwrap.rb', line 187

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

  Api.send_request("/clickwraps/#{params[:id]}", :delete, params, options)
  nil
end

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



197
198
199
200
 
# File 'lib/files.com/models/clickwrap.rb', line 197

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

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

Parameters:

id (required) - int64 - Clickwrap ID.

Raises:



135
136
137
138
139
140
141
142
143
 
# File 'lib/files.com/models/clickwrap.rb', line 135

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

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

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



145
146
147
 
# File 'lib/files.com/models/clickwrap.rb', line 145

def self.get(id, params = {}, options = {})
  find(id, 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

Raises:



118
119
120
121
122
123
124
125
126
127
 
# File 'lib/files.com/models/clickwrap.rb', line 118

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)

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

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

Parameters:

name - string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
body - string - Body text of Clickwrap (supports Markdown formatting).
use_with_bundles - string - Use this Clickwrap for Bundles?
use_with_inboxes - string - Use this Clickwrap for Inboxes?
use_with_users - string - Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.

Raises:



172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/files.com/models/clickwrap.rb', line 172

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

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

Instance Method Details

#body ⇒ Object

string - Body text of Clickwrap (supports Markdown formatting).



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

def body
  @attributes[:body]
end

#body=(value) ⇒ Object 



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

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

#delete(params = {}) ⇒ Object

Raises:



87
88
89
90
91
92
93
94
95
 
# File 'lib/files.com/models/clickwrap.rb', line 87

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[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

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

#destroy(params = {}) ⇒ Object 



97
98
99
100
 
# File 'lib/files.com/models/clickwrap.rb', line 97

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

#id ⇒ Object

int64 - Clickwrap ID



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

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



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

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

#name ⇒ Object

string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)



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

def name
  @attributes[:name]
end

#name=(value) ⇒ Object 



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

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

#save ⇒ Object 



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/files.com/models/clickwrap.rb', line 102

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

  @attributes = new_obj.attributes
  true
end

#update(params = {}) ⇒ Object

Parameters:

name - string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
body - string - Body text of Clickwrap (supports Markdown formatting).
use_with_bundles - string - Use this Clickwrap for Bundles?
use_with_inboxes - string - Use this Clickwrap for Inboxes?
use_with_users - string - Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.

Raises:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/files.com/models/clickwrap.rb', line 72

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[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: body must be an String") if params[:body] and !params[:body].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: use_with_bundles must be an String") if params[:use_with_bundles] and !params[:use_with_bundles].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: use_with_inboxes must be an String") if params[:use_with_inboxes] and !params[:use_with_inboxes].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: use_with_users must be an String") if params[:use_with_users] and !params[:use_with_users].is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

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

#use_with_bundles ⇒ Object

string - Use this Clickwrap for Bundles?



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

def use_with_bundles
  @attributes[:use_with_bundles]
end

#use_with_bundles=(value) ⇒ Object 



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

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

#use_with_inboxes ⇒ Object

string - Use this Clickwrap for Inboxes?



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

def use_with_inboxes
  @attributes[:use_with_inboxes]
end

#use_with_inboxes=(value) ⇒ Object 



62
63
64
 
# File 'lib/files.com/models/clickwrap.rb', line 62

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

#use_with_users ⇒ Object

string - Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.



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

def use_with_users
  @attributes[:use_with_users]
end

#use_with_users=(value) ⇒ Object 



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

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