Class: OpenApiOpenAIClient::RealtimeClientEventResponseCancel

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

Overview

Send this event to cancel an in-progress response. The server will respond with a response.cancelled event or an error if there is no response to cancel.

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 = {}) ⇒ RealtimeClientEventResponseCancel

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
 
# File 'lib/openapi_openai/models/realtime_client_event_response_cancel.rb', line 86

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::RealtimeClientEventResponseCancel` 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::RealtimeClientEventResponseCancel`. 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']
  end

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

  if attributes.key?(:'response_id')
    self.response_id = attributes[:'response_id']
  end
end

Instance Attribute Details

#event_id ⇒ Object

Optional client-generated ID used to identify this event.



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

def event_id
  @event_id
end

#response_id ⇒ Object

A specific response ID to cancel - if not provided, will cancel an in-progress response in the default conversation.



26
27
28
 
# File 'lib/openapi_openai/models/realtime_client_event_response_cancel.rb', line 26

def response_id
  @response_id
end

#type ⇒ Object

The event type, must be response.cancel.



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

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



60
61
62
 
# File 'lib/openapi_openai/models/realtime_client_event_response_cancel.rb', line 60

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



65
66
67
 
# File 'lib/openapi_openai/models/realtime_client_event_response_cancel.rb', line 65

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

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

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/openapi_openai/models/realtime_client_event_response_cancel.rb', line 172

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



79
80
81
82
 
# File 'lib/openapi_openai/models/realtime_client_event_response_cancel.rb', line 79

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



149
150
151
152
153
154
155
 
# File 'lib/openapi_openai/models/realtime_client_event_response_cancel.rb', line 149

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


159
160
161
 
# File 'lib/openapi_openai/models/realtime_client_event_response_cancel.rb', line 159

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



165
166
167
 
# File 'lib/openapi_openai/models/realtime_client_event_response_cancel.rb', line 165

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

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



117
118
119
120
121
122
123
124
125
 
# File 'lib/openapi_openai/models/realtime_client_event_response_cancel.rb', line 117

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/openapi_openai/models/realtime_client_event_response_cancel.rb', line 194

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

Returns:

  • (Boolean) —

    true if the model is valid



129
130
131
132
133
134
135
 
# File 'lib/openapi_openai/models/realtime_client_event_response_cancel.rb', line 129

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