Class: Ittybit::FileResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/ittybit/types/file_response.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, media_id:, object:, kind:, type:, filesize:, url:, created:, updated:, status:, codec: OMIT, container: OMIT, width: OMIT, height: OMIT, orientation: OMIT, rotation: OMIT, transparency: OMIT, animated: OMIT, frames: OMIT, duration: OMIT, fps: OMIT, bitrate: OMIT, language: OMIT, label: OMIT, ref: OMIT, folder: OMIT, filename: OMIT, placeholder: OMIT, background: OMIT, metadata: OMIT, original: OMIT, created_by: OMIT, additional_properties: nil) ⇒ Ittybit::FileResponse

Parameters:

  • id (String)
  • media_id (String)
  • object (Ittybit::FileResponseObject)
  • kind (Ittybit::FileResponseKind)
  • type (String)
  • codec (String) (defaults to: OMIT)
  • container (String) (defaults to: OMIT)
  • width (Integer) (defaults to: OMIT)
  • height (Integer) (defaults to: OMIT)
  • orientation (String) (defaults to: OMIT)
  • rotation (Float) (defaults to: OMIT)
  • transparency (Boolean) (defaults to: OMIT)
  • animated (Boolean) (defaults to: OMIT)
  • frames (Integer) (defaults to: OMIT)
  • duration (Float) (defaults to: OMIT)
  • fps (Float) (defaults to: OMIT)
  • filesize (Integer)
  • bitrate (Integer) (defaults to: OMIT)
  • language (String) (defaults to: OMIT)
  • label (String) (defaults to: OMIT)
  • ref (String) (defaults to: OMIT)
  • folder (String) (defaults to: OMIT)
  • filename (String) (defaults to: OMIT)
  • url (String)
  • placeholder (String) (defaults to: OMIT)
  • background (String) (defaults to: OMIT)
  • metadata (Hash{String => Object}) (defaults to: OMIT)
  • original (Boolean) (defaults to: OMIT)
  • created_by (String) (defaults to: OMIT)
  • created (DateTime)
  • updated (DateTime)
  • status (Ittybit::FileResponseStatus)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/ittybit/types/file_response.rb', line 118

def initialize(id:, media_id:, object:, kind:, type:, filesize:, url:, created:, updated:, status:, codec: OMIT, container: OMIT, width: OMIT, height: OMIT,
               orientation: OMIT, rotation: OMIT, transparency: OMIT, animated: OMIT, frames: OMIT, duration: OMIT, fps: OMIT, bitrate: OMIT, language: OMIT, label: OMIT, ref: OMIT, folder: OMIT, filename: OMIT, placeholder: OMIT, background: OMIT, metadata: OMIT, original: OMIT, created_by: OMIT, additional_properties: nil)
  @id = id
  @media_id = media_id
  @object = object
  @kind = kind
  @type = type
  @codec = codec if codec != OMIT
  @container = container if container != OMIT
  @width = width if width != OMIT
  @height = height if height != OMIT
  @orientation = orientation if orientation != OMIT
  @rotation = rotation if rotation != OMIT
  @transparency = transparency if transparency != OMIT
  @animated = animated if animated != OMIT
  @frames = frames if frames != OMIT
  @duration = duration if duration != OMIT
  @fps = fps if fps != OMIT
  @filesize = filesize
  @bitrate = bitrate if bitrate != OMIT
  @language = language if language != OMIT
  @label = label if label != OMIT
  @ref = ref if ref != OMIT
  @folder = folder if folder != OMIT
  @filename = filename if filename != OMIT
  @url = url
  @placeholder = placeholder if placeholder != OMIT
  @background = background if background != OMIT
  @metadata = metadata if metadata != OMIT
  @original = original if original != OMIT
  @created_by = created_by if created_by != OMIT
  @created = created
  @updated = updated
  @status = status
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "media_id": media_id,
    "object": object,
    "kind": kind,
    "type": type,
    "codec": codec,
    "container": container,
    "width": width,
    "height": height,
    "orientation": orientation,
    "rotation": rotation,
    "transparency": transparency,
    "animated": animated,
    "frames": frames,
    "duration": duration,
    "fps": fps,
    "filesize": filesize,
    "bitrate": bitrate,
    "language": language,
    "label": label,
    "ref": ref,
    "folder": folder,
    "filename": filename,
    "url": url,
    "placeholder": placeholder,
    "background": background,
    "metadata": metadata,
    "original": original,
    "created_by": created_by,
    "created": created,
    "updated": updated,
    "status": status
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



77
78
79
 
# File 'lib/ittybit/types/file_response.rb', line 77

def additional_properties
  @additional_properties
end

#animated ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


37
38
39
 
# File 'lib/ittybit/types/file_response.rb', line 37

def animated
  @animated
end

#background ⇒ String (readonly)

Returns:

  • (String) 


63
64
65
 
# File 'lib/ittybit/types/file_response.rb', line 63

def background
  @background
end

#bitrate ⇒ Integer (readonly)

Returns:

  • (Integer) 


47
48
49
 
# File 'lib/ittybit/types/file_response.rb', line 47

def bitrate
  @bitrate
end

#codec ⇒ String (readonly)

Returns:

  • (String) 


23
24
25
 
# File 'lib/ittybit/types/file_response.rb', line 23

def codec
  @codec
end

#container ⇒ String (readonly)

Returns:

  • (String) 


25
26
27
 
# File 'lib/ittybit/types/file_response.rb', line 25

def container
  @container
end

#created ⇒ DateTime (readonly)

Returns:

  • (DateTime) 


71
72
73
 
# File 'lib/ittybit/types/file_response.rb', line 71

def created
  @created
end

#created_by ⇒ String (readonly)

Returns:

  • (String) 


69
70
71
 
# File 'lib/ittybit/types/file_response.rb', line 69

def created_by
  @created_by
end

#duration ⇒ Float (readonly)

Returns:

  • (Float) 


41
42
43
 
# File 'lib/ittybit/types/file_response.rb', line 41

def duration
  @duration
end

#filename ⇒ String (readonly)

Returns:

  • (String) 


57
58
59
 
# File 'lib/ittybit/types/file_response.rb', line 57

def filename
  @filename
end

#filesize ⇒ Integer (readonly)

Returns:

  • (Integer) 


45
46
47
 
# File 'lib/ittybit/types/file_response.rb', line 45

def filesize
  @filesize
end

#folder ⇒ String (readonly)

Returns:

  • (String) 


55
56
57
 
# File 'lib/ittybit/types/file_response.rb', line 55

def folder
  @folder
end

#fps ⇒ Float (readonly)

Returns:

  • (Float) 


43
44
45
 
# File 'lib/ittybit/types/file_response.rb', line 43

def fps
  @fps
end

#frames ⇒ Integer (readonly)

Returns:

  • (Integer) 


39
40
41
 
# File 'lib/ittybit/types/file_response.rb', line 39

def frames
  @frames
end

#height ⇒ Integer (readonly)

Returns:

  • (Integer) 


29
30
31
 
# File 'lib/ittybit/types/file_response.rb', line 29

def height
  @height
end

#id ⇒ String (readonly)

Returns:

  • (String) 


13
14
15
 
# File 'lib/ittybit/types/file_response.rb', line 13

def id
  @id
end

#kind ⇒ Ittybit::FileResponseKind (readonly)

Returns:



19
20
21
 
# File 'lib/ittybit/types/file_response.rb', line 19

def kind
  @kind
end

#label ⇒ String (readonly)

Returns:

  • (String) 


51
52
53
 
# File 'lib/ittybit/types/file_response.rb', line 51

def label
  @label
end

#language ⇒ String (readonly)

Returns:

  • (String) 


49
50
51
 
# File 'lib/ittybit/types/file_response.rb', line 49

def language
  @language
end

#media_id ⇒ String (readonly)

Returns:

  • (String) 


15
16
17
 
# File 'lib/ittybit/types/file_response.rb', line 15

def media_id
  @media_id
end

#metadata ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


65
66
67
 
# File 'lib/ittybit/types/file_response.rb', line 65

def metadata
  @metadata
end

#object ⇒ Ittybit::FileResponseObject (readonly)

Returns:



17
18
19
 
# File 'lib/ittybit/types/file_response.rb', line 17

def object
  @object
end

#orientation ⇒ String (readonly)

Returns:

  • (String) 


31
32
33
 
# File 'lib/ittybit/types/file_response.rb', line 31

def orientation
  @orientation
end

#original ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/ittybit/types/file_response.rb', line 67

def original
  @original
end

#placeholder ⇒ String (readonly)

Returns:

  • (String) 


61
62
63
 
# File 'lib/ittybit/types/file_response.rb', line 61

def placeholder
  @placeholder
end

#ref ⇒ String (readonly)

Returns:

  • (String) 


53
54
55
 
# File 'lib/ittybit/types/file_response.rb', line 53

def ref
  @ref
end

#rotation ⇒ Float (readonly)

Returns:

  • (Float) 


33
34
35
 
# File 'lib/ittybit/types/file_response.rb', line 33

def rotation
  @rotation
end

#status ⇒ Ittybit::FileResponseStatus (readonly)

Returns:



75
76
77
 
# File 'lib/ittybit/types/file_response.rb', line 75

def status
  @status
end

#transparency ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/ittybit/types/file_response.rb', line 35

def transparency
  @transparency
end

#type ⇒ String (readonly)

Returns:

  • (String) 


21
22
23
 
# File 'lib/ittybit/types/file_response.rb', line 21

def type
  @type
end

#updated ⇒ DateTime (readonly)

Returns:

  • (DateTime) 


73
74
75
 
# File 'lib/ittybit/types/file_response.rb', line 73

def updated
  @updated
end

#url ⇒ String (readonly)

Returns:

  • (String) 


59
60
61
 
# File 'lib/ittybit/types/file_response.rb', line 59

def url
  @url
end

#width ⇒ Integer (readonly)

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/ittybit/types/file_response.rb', line 27

def width
  @width
end

Class Method Details

.from_json(json_object:) ⇒ Ittybit::FileResponse

Deserialize a JSON object to an instance of FileResponse

Parameters:

  • json_object (String)

Returns:



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/ittybit/types/file_response.rb', line 195

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  media_id = parsed_json["media_id"]
  object = parsed_json["object"]
  kind = parsed_json["kind"]
  type = parsed_json["type"]
  codec = parsed_json["codec"]
  container = parsed_json["container"]
  width = parsed_json["width"]
  height = parsed_json["height"]
  orientation = parsed_json["orientation"]
  rotation = parsed_json["rotation"]
  transparency = parsed_json["transparency"]
  animated = parsed_json["animated"]
  frames = parsed_json["frames"]
  duration = parsed_json["duration"]
  fps = parsed_json["fps"]
  filesize = parsed_json["filesize"]
  bitrate = parsed_json["bitrate"]
  language = parsed_json["language"]
  label = parsed_json["label"]
  ref = parsed_json["ref"]
  folder = parsed_json["folder"]
  filename = parsed_json["filename"]
  url = parsed_json["url"]
  placeholder = parsed_json["placeholder"]
  background = parsed_json["background"]
  metadata = parsed_json["metadata"]
  original = parsed_json["original"]
  created_by = parsed_json["created_by"]
  created = (DateTime.parse(parsed_json["created"]) unless parsed_json["created"].nil?)
  updated = (DateTime.parse(parsed_json["updated"]) unless parsed_json["updated"].nil?)
  status = parsed_json["status"]
  new(
    id: id,
    media_id: media_id,
    object: object,
    kind: kind,
    type: type,
    codec: codec,
    container: container,
    width: width,
    height: height,
    orientation: orientation,
    rotation: rotation,
    transparency: transparency,
    animated: animated,
    frames: frames,
    duration: duration,
    fps: fps,
    filesize: filesize,
    bitrate: bitrate,
    language: language,
    label: label,
    ref: ref,
    folder: folder,
    filename: filename,
    url: url,
    placeholder: placeholder,
    background: background,
    metadata: metadata,
    original: original,
    created_by: created_by,
    created: created,
    updated: updated,
    status: status,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/ittybit/types/file_response.rb', line 280

def self.validate_raw(obj:)
  obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.media_id.is_a?(String) != false || raise("Passed value for field obj.media_id is not the expected type, validation failed.")
  obj.object.is_a?(Ittybit::FileResponseObject) != false || raise("Passed value for field obj.object is not the expected type, validation failed.")
  obj.kind.is_a?(Ittybit::FileResponseKind) != false || raise("Passed value for field obj.kind is not the expected type, validation failed.")
  obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
  obj.codec&.is_a?(String) != false || raise("Passed value for field obj.codec is not the expected type, validation failed.")
  obj.container&.is_a?(String) != false || raise("Passed value for field obj.container is not the expected type, validation failed.")
  obj.width&.is_a?(Integer) != false || raise("Passed value for field obj.width is not the expected type, validation failed.")
  obj.height&.is_a?(Integer) != false || raise("Passed value for field obj.height is not the expected type, validation failed.")
  obj.orientation&.is_a?(String) != false || raise("Passed value for field obj.orientation is not the expected type, validation failed.")
  obj.rotation&.is_a?(Float) != false || raise("Passed value for field obj.rotation is not the expected type, validation failed.")
  obj.transparency&.is_a?(Boolean) != false || raise("Passed value for field obj.transparency is not the expected type, validation failed.")
  obj.animated&.is_a?(Boolean) != false || raise("Passed value for field obj.animated is not the expected type, validation failed.")
  obj.frames&.is_a?(Integer) != false || raise("Passed value for field obj.frames is not the expected type, validation failed.")
  obj.duration&.is_a?(Float) != false || raise("Passed value for field obj.duration is not the expected type, validation failed.")
  obj.fps&.is_a?(Float) != false || raise("Passed value for field obj.fps is not the expected type, validation failed.")
  obj.filesize.is_a?(Integer) != false || raise("Passed value for field obj.filesize is not the expected type, validation failed.")
  obj.bitrate&.is_a?(Integer) != false || raise("Passed value for field obj.bitrate is not the expected type, validation failed.")
  obj.language&.is_a?(String) != false || raise("Passed value for field obj.language is not the expected type, validation failed.")
  obj.label&.is_a?(String) != false || raise("Passed value for field obj.label is not the expected type, validation failed.")
  obj.ref&.is_a?(String) != false || raise("Passed value for field obj.ref is not the expected type, validation failed.")
  obj.folder&.is_a?(String) != false || raise("Passed value for field obj.folder is not the expected type, validation failed.")
  obj.filename&.is_a?(String) != false || raise("Passed value for field obj.filename is not the expected type, validation failed.")
  obj.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
  obj.placeholder&.is_a?(String) != false || raise("Passed value for field obj.placeholder is not the expected type, validation failed.")
  obj.background&.is_a?(String) != false || raise("Passed value for field obj.background is not the expected type, validation failed.")
  obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
  obj.original&.is_a?(Boolean) != false || raise("Passed value for field obj.original is not the expected type, validation failed.")
  obj.created_by&.is_a?(String) != false || raise("Passed value for field obj.created_by is not the expected type, validation failed.")
  obj.created.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
  obj.updated.is_a?(DateTime) != false || raise("Passed value for field obj.updated is not the expected type, validation failed.")
  obj.status.is_a?(Ittybit::FileResponseStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of FileResponse to a JSON object

Returns:

  • (String) 


270
271
272
 
# File 'lib/ittybit/types/file_response.rb', line 270

def to_json(*_args)
  @_field_set&.to_json
end