Class: OpenApiOpenAIClient::RealtimeServerEventResponseCreated

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/openapi_openai/models/realtime_server_event_response_created.rb

Overview

Returned when a new Response is created. The first event of response creation, where the response is in an initial state of in_progress.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ RealtimeServerEventResponseCreated

Initializes the object



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/openapi_openai/models/realtime_server_event_response_created.rb', line 85

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::RealtimeServerEventResponseCreated` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenApiOpenAIClient::RealtimeServerEventResponseCreated`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'event_id')
    self.event_id = attributes[:'event_id']
  else
    self.event_id = nil
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = nil
  end

  if attributes.key?(:'response')
    self.response = attributes[:'response']
  else
    self.response = nil
  end
end

Instance Attribute Details

#event_id ⇒ Object

The unique ID of the server event.



20
21
22
 
# File 'lib/openapi_openai/models/realtime_server_event_response_created.rb', line 20

def event_id
  @event_id
end

#response ⇒ Object

Returns the value of attribute response.



25
26
27
 
# File 'lib/openapi_openai/models/realtime_server_event_response_created.rb', line 25

def response
  @response
end

#type ⇒ Object

The event type, must be response.created.



23
24
25
 
# File 'lib/openapi_openai/models/realtime_server_event_response_created.rb', line 23

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



59
60
61
 
# File 'lib/openapi_openai/models/realtime_server_event_response_created.rb', line 59

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



64
65
66
 
# File 'lib/openapi_openai/models/realtime_server_event_response_created.rb', line 64

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



50
51
52
53
54
55
56
 
# File 'lib/openapi_openai/models/realtime_server_event_response_created.rb', line 50

def self.attribute_map
  {
    :'event_id' => :'event_id',
    :'type' => :'type',
    :'response' => :'response'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/openapi_openai/models/realtime_server_event_response_created.rb', line 205

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



78
79
80
81
 
# File 'lib/openapi_openai/models/realtime_server_event_response_created.rb', line 78

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
 
# File 'lib/openapi_openai/models/realtime_server_event_response_created.rb', line 69

def self.openapi_types
  {
    :'event_id' => :'String',
    :'type' => :'String',
    :'response' => :'RealtimeResponse'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



182
183
184
185
186
187
188
 
# File 'lib/openapi_openai/models/realtime_server_event_response_created.rb', line 182

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      event_id == o.event_id &&
      type == o.type &&
      response == o.response
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


192
193
194
 
# File 'lib/openapi_openai/models/realtime_server_event_response_created.rb', line 192

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



198
199
200
 
# File 'lib/openapi_openai/models/realtime_server_event_response_created.rb', line 198

def hash
  [event_id, type, response].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/openapi_openai/models/realtime_server_event_response_created.rb', line 120

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @event_id.nil?
    invalid_properties.push('invalid value for "event_id", event_id cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @response.nil?
    invalid_properties.push('invalid value for "response", response cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash



227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/openapi_openai/models/realtime_server_event_response_created.rb', line 227

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



140
141
142
143
144
145
146
147
148
 
# File 'lib/openapi_openai/models/realtime_server_event_response_created.rb', line 140

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @event_id.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["response.created"])
  return false unless type_validator.valid?(@type)
  return false if @response.nil?
  true
end