Class: ProcessOut::ExportLayout
- Inherits:
-
Object
- Object
- ProcessOut::ExportLayout
- Defined in:
- lib/processout/export_layout.rb
Instance Attribute Summary collapse
-
#configuration ⇒ Object
Returns the value of attribute configuration.
-
#created_at ⇒ Object
Returns the value of attribute created_at.
-
#id ⇒ Object
Returns the value of attribute id.
-
#is_default ⇒ Object
Returns the value of attribute is_default.
-
#name ⇒ Object
Returns the value of attribute name.
-
#project ⇒ Object
Returns the value of attribute project.
-
#project_id ⇒ Object
Returns the value of attribute project_id.
-
#type ⇒ Object
Returns the value of attribute type.
Instance Method Summary collapse
-
#all(options = {}) ⇒ Object
Get all the export layouts.
-
#create(options = {}) ⇒ Object
Create a new export layout.
-
#delete(export_layout_id, options = {}) ⇒ Object
Delete the export layout.
-
#fill_with_data(data) ⇒ Object
- Fills the object with data coming from the API Params:
data
-
Hash
of data coming from the API.
- Fills the object with data coming from the API Params:
-
#find(export_layout_id, options = {}) ⇒ Object
Find an export layout by its ID.
-
#find_default(export_type, options = {}) ⇒ Object
Find the default export layout for given export type.
-
#initialize(client, data = {}) ⇒ ExportLayout
constructor
- Initializes the ExportLayout object Params:
client
ProcessOut
client instancedata
-
data that can be used to fill the object.
- Initializes the ExportLayout object Params:
-
#new(data = {}) ⇒ Object
Create a new ExportLayout using the current client.
-
#prefill(data) ⇒ Object
- Prefills the object with the data passed as parameters Params:
data
-
Hash
of data.
- Prefills the object with the data passed as parameters Params:
-
#to_json(options) ⇒ Object
Overrides the JSON marshaller to only send the fields we want.
-
#update(export_layout_id, options = {}) ⇒ Object
Update the export layout.
Constructor Details
#initialize(client, data = {}) ⇒ ExportLayout
Initializes the ExportLayout object Params:
client
-
ProcessOut
client instance data
-
data that can be used to fill the object
82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/processout/export_layout.rb', line 82 def initialize(client, data = {}) @client = client self.id = data.fetch(:id, nil) self.project = data.fetch(:project, nil) self.project_id = data.fetch(:project_id, nil) self.created_at = data.fetch(:created_at, nil) self.name = data.fetch(:name, nil) self.type = data.fetch(:type, nil) self.is_default = data.fetch(:is_default, nil) self.configuration = data.fetch(:configuration, nil) end |
Instance Attribute Details
#configuration ⇒ Object
Returns the value of attribute configuration.
18 19 20 |
# File 'lib/processout/export_layout.rb', line 18 def configuration @configuration end |
#created_at ⇒ Object
Returns the value of attribute created_at.
14 15 16 |
# File 'lib/processout/export_layout.rb', line 14 def created_at @created_at end |
#id ⇒ Object
Returns the value of attribute id.
11 12 13 |
# File 'lib/processout/export_layout.rb', line 11 def id @id end |
#is_default ⇒ Object
Returns the value of attribute is_default.
17 18 19 |
# File 'lib/processout/export_layout.rb', line 17 def is_default @is_default end |
#name ⇒ Object
Returns the value of attribute name.
15 16 17 |
# File 'lib/processout/export_layout.rb', line 15 def name @name end |
#project ⇒ Object
Returns the value of attribute project.
12 13 14 |
# File 'lib/processout/export_layout.rb', line 12 def project @project end |
#project_id ⇒ Object
Returns the value of attribute project_id.
13 14 15 |
# File 'lib/processout/export_layout.rb', line 13 def project_id @project_id end |
#type ⇒ Object
Returns the value of attribute type.
16 17 18 |
# File 'lib/processout/export_layout.rb', line 16 def type @type end |
Instance Method Details
#all(options = {}) ⇒ Object
Get all the export layouts. Params:
options
-
Hash
of options
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
# File 'lib/processout/export_layout.rb', line 172 def all( = {}) self.prefill() request = Request.new(@client) path = "/exports/layouts" data = { } response = Response.new(request.get(path, data, )) return_values = Array.new a = Array.new body = response.body for v in body['export_layouts'] tmp = ExportLayout.new(@client) tmp.fill_with_data(v) a.push(tmp) end return_values.push(a) return_values[0] end |
#create(options = {}) ⇒ Object
Create a new export layout. Params:
options
-
Hash
of options
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 |
# File 'lib/processout/export_layout.rb', line 258 def create( = {}) self.prefill() request = Request.new(@client) path = "/exports/layouts" data = { "name" => @name, "type" => @type, "is_default" => @is_default, "configuration" => @configuration } response = Response.new(request.post(path, data, )) return_values = Array.new body = response.body body = body["export_layout"] return_values.push(self.fill_with_data(body)) return_values[0] end |
#delete(export_layout_id, options = {}) ⇒ Object
Delete the export layout. Params:
export_layout_id
-
ID of the export layout
options
-
Hash
of options
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/processout/export_layout.rb', line 317 def delete(export_layout_id, = {}) self.prefill() request = Request.new(@client) path = "/exports/layouts/" + CGI.escape(export_layout_id) + "" data = { } response = Response.new(request.delete(path, data, )) return_values = Array.new return_values.push(response.success) return_values[0] end |
#fill_with_data(data) ⇒ Object
Fills the object with data coming from the API Params:
data
-
Hash
of data coming from the API
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/processout/export_layout.rb', line 118 def fill_with_data(data) if data.nil? return self end if data.include? "id" self.id = data["id"] end if data.include? "project" self.project = data["project"] end if data.include? "project_id" self.project_id = data["project_id"] end if data.include? "created_at" self.created_at = data["created_at"] end if data.include? "name" self.name = data["name"] end if data.include? "type" self.type = data["type"] end if data.include? "is_default" self.is_default = data["is_default"] end if data.include? "configuration" self.configuration = data["configuration"] end self end |
#find(export_layout_id, options = {}) ⇒ Object
Find an export layout by its ID. Params:
export_layout_id
-
ID of the export layout
options
-
Hash
of options
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/processout/export_layout.rb', line 203 def find(export_layout_id, = {}) self.prefill() request = Request.new(@client) path = "/exports/layouts/" + CGI.escape(export_layout_id) + "" data = { } response = Response.new(request.get(path, data, )) return_values = Array.new body = response.body body = body["export_layout"] obj = ExportLayout.new(@client) return_values.push(obj.fill_with_data(body)) return_values[0] end |
#find_default(export_type, options = {}) ⇒ Object
Find the default export layout for given export type. Params:
export_type
-
Export type for which the default layout is assigned.
options
-
Hash
of options
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
# File 'lib/processout/export_layout.rb', line 231 def find_default(export_type, = {}) self.prefill() request = Request.new(@client) path = "/exports/layouts/default/" + CGI.escape(export_type) + "" data = { } response = Response.new(request.get(path, data, )) return_values = Array.new body = response.body body = body["export_layout"] obj = ExportLayout.new(@client) return_values.push(obj.fill_with_data(body)) return_values[0] end |
#new(data = {}) ⇒ Object
Create a new ExportLayout using the current client
97 98 99 |
# File 'lib/processout/export_layout.rb', line 97 def new(data = {}) ExportLayout.new(@client, data) end |
#prefill(data) ⇒ Object
Prefills the object with the data passed as parameters Params:
data
-
Hash
of data
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/processout/export_layout.rb', line 153 def prefill(data) if data.nil? return self end self.id = data.fetch(:id, self.id) self.project = data.fetch(:project, self.project) self.project_id = data.fetch(:project_id, self.project_id) self.created_at = data.fetch(:created_at, self.created_at) self.name = data.fetch(:name, self.name) self.type = data.fetch(:type, self.type) self.is_default = data.fetch(:is_default, self.is_default) self.configuration = data.fetch(:configuration, self.configuration) self end |
#to_json(options) ⇒ Object
Overrides the JSON marshaller to only send the fields we want
102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/processout/export_layout.rb', line 102 def to_json() { "id": self.id, "project": self.project, "project_id": self.project_id, "created_at": self.created_at, "name": self.name, "type": self.type, "is_default": self.is_default, "configuration": self.configuration, }.to_json end |
#update(export_layout_id, options = {}) ⇒ Object
Update the export layout. Params:
export_layout_id
-
ID of the export layout
options
-
Hash
of options
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 |
# File 'lib/processout/export_layout.rb', line 288 def update(export_layout_id, = {}) self.prefill() request = Request.new(@client) path = "/exports/layouts/" + CGI.escape(export_layout_id) + "" data = { "name" => @name, "is_default" => @is_default, "configuration" => @configuration } response = Response.new(request.put(path, data, )) return_values = Array.new body = response.body body = body["export_layout"] return_values.push(self.fill_with_data(body)) return_values[0] end |