Class: Files::EventTarget

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of EventTarget.



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

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

Class Method Details

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



157
158
159
 
# File 'lib/files.com/models/event_target.rb', line 157

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

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

Parameters:

name (required) - string - Event Target name.
workspace_id - int64 - Workspace ID. 0 means the default workspace or site-wide.
apply_to_all_workspaces - boolean - If true, this default-workspace target can receive events from all workspaces.
target_type (required) - string - Event Target type.
enabled - boolean - Whether this Event Target can receive events.
config (required) - object - Event Target configuration.
delivery_policy - object - Event Target delivery policy. Email targets support batch_interval in seconds, between 600 and 86400.

Raises:



185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/files.com/models/event_target.rb', line 185

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: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: target_type must be an String") if params[:target_type] and !params[:target_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: config must be an Hash") if params[:config] and !params[:config].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: delivery_policy must be an Hash") if params[:delivery_policy] and !params[:delivery_policy].is_a?(Hash)
  raise MissingParameterError.new("Parameter missing: name") unless params[:name]
  raise MissingParameterError.new("Parameter missing: target_type") unless params[:target_type]
  raise MissingParameterError.new("Parameter missing: config") unless params[:config]

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

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

Raises:



222
223
224
225
226
227
228
229
230
 
# File 'lib/files.com/models/event_target.rb', line 222

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("/event_targets/#{params[:id]}", :delete, params, options)
  nil
end

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



232
233
234
235
 
# File 'lib/files.com/models/event_target.rb', line 232

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

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

Parameters:

id (required) - int64 - Event Target ID.

Raises:



163
164
165
166
167
168
169
170
171
 
# File 'lib/files.com/models/event_target.rb', line 163

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("/event_targets/#{params[:id]}", :get, params, options)
  EventTarget.new(response.data, options)
end

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



173
174
175
 
# File 'lib/files.com/models/event_target.rb', line 173

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).
sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `enabled` and `workspace_id`.
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `enabled`, `target_type` or `workspace_id`. Valid field combinations are `[ enabled, target_type ]`, `[ workspace_id, enabled ]` or `[ workspace_id, enabled, target_type ]`.

Raises:



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

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: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)

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

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

Parameters:

name - string - Event Target name.
workspace_id - int64 - Workspace ID. 0 means the default workspace or site-wide.
apply_to_all_workspaces - boolean - If true, this default-workspace target can receive events from all workspaces.
target_type - string - Event Target type.
enabled - boolean - Whether this Event Target can receive events.
config - object - Event Target configuration.
delivery_policy - object - Event Target delivery policy. Email targets support batch_interval in seconds, between 600 and 86400.

Raises:



207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/files.com/models/event_target.rb', line 207

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: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: target_type must be an String") if params[:target_type] and !params[:target_type].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: config must be an Hash") if params[:config] and !params[:config].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: delivery_policy must be an Hash") if params[:delivery_policy] and !params[:delivery_policy].is_a?(Hash)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

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

Instance Method Details

#apply_to_all_workspaces ⇒ Object

boolean - If true, this default-workspace target can receive events from all workspaces.



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

def apply_to_all_workspaces
  @attributes[:apply_to_all_workspaces]
end

#apply_to_all_workspaces=(value) ⇒ Object 



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

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

#config ⇒ Object

object - Event Target configuration.



67
68
69
 
# File 'lib/files.com/models/event_target.rb', line 67

def config
  @attributes[:config]
end

#config=(value) ⇒ Object 



71
72
73
 
# File 'lib/files.com/models/event_target.rb', line 71

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

#created_at ⇒ Object

date-time - Event Target create date/time.



85
86
87
 
# File 'lib/files.com/models/event_target.rb', line 85

def created_at
  @attributes[:created_at]
end

#delete(params = {}) ⇒ Object

Raises:



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

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("/event_targets/#{@attributes[:id]}", :delete, params, @options)
end

#delivery_policy ⇒ Object

object - Event Target delivery policy. Email targets support batch_interval in seconds, between 600 and 86400.



76
77
78
 
# File 'lib/files.com/models/event_target.rb', line 76

def delivery_policy
  @attributes[:delivery_policy]
end

#delivery_policy=(value) ⇒ Object 



80
81
82
 
# File 'lib/files.com/models/event_target.rb', line 80

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

#destroy(params = {}) ⇒ Object 



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

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

#enabled ⇒ Object

boolean - Whether this Event Target can receive events.



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

def enabled
  @attributes[:enabled]
end

#enabled=(value) ⇒ Object 



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

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

#id ⇒ Object

int64 - Event Target ID



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

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



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

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

#name ⇒ Object

string - Event Target name.



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

def name
  @attributes[:name]
end

#name=(value) ⇒ Object 



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

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

#save ⇒ Object 



130
131
132
133
134
135
136
137
138
139
 
# File 'lib/files.com/models/event_target.rb', line 130

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

  @attributes = new_obj.attributes
  true
end

#target_type ⇒ Object

string - Event Target type.



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

def target_type
  @attributes[:target_type]
end

#target_type=(value) ⇒ Object 



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

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

#update(params = {}) ⇒ Object

Parameters:

name - string - Event Target name.
workspace_id - int64 - Workspace ID. 0 means the default workspace or site-wide.
apply_to_all_workspaces - boolean - If true, this default-workspace target can receive events from all workspaces.
target_type - string - Event Target type.
enabled - boolean - Whether this Event Target can receive events.
config - object - Event Target configuration.
delivery_policy - object - Event Target delivery policy. Email targets support batch_interval in seconds, between 600 and 86400.

Raises:



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

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

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

#updated_at ⇒ Object

date-time - Event Target update date/time.



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

def updated_at
  @attributes[:updated_at]
end

#workspace_id ⇒ Object

int64 - Workspace ID. 0 means the default workspace or site-wide.



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

def workspace_id
  @attributes[:workspace_id]
end

#workspace_id=(value) ⇒ Object 



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

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