Class: Vapi::StructuredOutputs::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi/structured_outputs/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



9
10
11
 
# File 'lib/vapi/structured_outputs/client.rb', line 9

def initialize(client:)
  @client = client
end

Instance Method Details

#structured_output_controller_create(request_options: {}, **params) ⇒ Vapi::Types::StructuredOutput

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/vapi/structured_outputs/client.rb', line 84

def structured_output_controller_create(request_options: {}, **params)
  params = Vapi::Internal::Types::Utils.normalize_keys(params)
  request = Vapi::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "structured-output",
    body: Vapi::Types::CreateStructuredOutputDto.new(params).to_h,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Vapi::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Vapi::Types::StructuredOutput.load(response.body)
  else
    error_class = Vapi::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#structured_output_controller_find_all(request_options: {}, **params) ⇒ Vapi::Types::StructuredOutputPaginatedResponse

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :id (String, nil)
  • :name (String, nil)
  • :page (Integer, nil)
  • :sort_order (Vapi::StructuredOutputs::Types::StructuredOutputControllerFindAllRequestSortOrder, nil)
  • :limit (Integer, nil)
  • :created_at_gt (String, nil)
  • :created_at_lt (String, nil)
  • :created_at_ge (String, nil)
  • :created_at_le (String, nil)
  • :updated_at_gt (String, nil)
  • :updated_at_lt (String, nil)
  • :updated_at_ge (String, nil)
  • :updated_at_le (String, nil)

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/vapi/structured_outputs/client.rb', line 35

def structured_output_controller_find_all(request_options: {}, **params)
  params = Vapi::Internal::Types::Utils.normalize_keys(params)
  query_param_names = %i[id name page sort_order limit created_at_gt created_at_lt created_at_ge created_at_le updated_at_gt updated_at_lt updated_at_ge updated_at_le]
  query_params = {}
  query_params["id"] = params[:id] if params.key?(:id)
  query_params["name"] = params[:name] if params.key?(:name)
  query_params["page"] = params[:page] if params.key?(:page)
  query_params["sortOrder"] = params[:sort_order] if params.key?(:sort_order)
  query_params["limit"] = params[:limit] if params.key?(:limit)
  query_params["createdAtGt"] = params[:created_at_gt] if params.key?(:created_at_gt)
  query_params["createdAtLt"] = params[:created_at_lt] if params.key?(:created_at_lt)
  query_params["createdAtGe"] = params[:created_at_ge] if params.key?(:created_at_ge)
  query_params["createdAtLe"] = params[:created_at_le] if params.key?(:created_at_le)
  query_params["updatedAtGt"] = params[:updated_at_gt] if params.key?(:updated_at_gt)
  query_params["updatedAtLt"] = params[:updated_at_lt] if params.key?(:updated_at_lt)
  query_params["updatedAtGe"] = params[:updated_at_ge] if params.key?(:updated_at_ge)
  query_params["updatedAtLe"] = params[:updated_at_le] if params.key?(:updated_at_le)
  params.except(*query_param_names)

  request = Vapi::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "structured-output",
    query: query_params,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Vapi::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Vapi::Types::StructuredOutputPaginatedResponse.load(response.body)
  else
    error_class = Vapi::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#structured_output_controller_find_one(request_options: {}, **params) ⇒ Vapi::Types::StructuredOutput

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :id (String)

Returns:



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/vapi/structured_outputs/client.rb', line 117

def structured_output_controller_find_one(request_options: {}, **params)
  params = Vapi::Internal::Types::Utils.normalize_keys(params)
  request = Vapi::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "structured-output/#{URI.encode_uri_component(params[:id].to_s)}",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Vapi::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Vapi::Types::StructuredOutput.load(response.body)
  else
    error_class = Vapi::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#structured_output_controller_remove(request_options: {}, **params) ⇒ Vapi::Types::StructuredOutput

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :id (String)

Returns:



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/vapi/structured_outputs/client.rb', line 149

def structured_output_controller_remove(request_options: {}, **params)
  params = Vapi::Internal::Types::Utils.normalize_keys(params)
  request = Vapi::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "DELETE",
    path: "structured-output/#{URI.encode_uri_component(params[:id].to_s)}",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Vapi::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Vapi::Types::StructuredOutput.load(response.body)
  else
    error_class = Vapi::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#structured_output_controller_run(request_options: {}, **params) ⇒ Vapi::Types::StructuredOutput

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/vapi/structured_outputs/client.rb', line 224

def structured_output_controller_run(request_options: {}, **params)
  params = Vapi::Internal::Types::Utils.normalize_keys(params)
  request = Vapi::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "structured-output/run",
    body: Vapi::StructuredOutputs::Types::StructuredOutputRunDto.new(params).to_h,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Vapi::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Vapi::Types::StructuredOutput.load(response.body)
  else
    error_class = Vapi::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#structured_output_controller_update(request_options: {}, **params) ⇒ Vapi::Types::StructuredOutput

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :id (String)
  • :schema_override (String)

Returns:



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/vapi/structured_outputs/client.rb', line 182

def structured_output_controller_update(request_options: {}, **params)
  params = Vapi::Internal::Types::Utils.normalize_keys(params)
  request_data = Vapi::StructuredOutputs::Types::UpdateStructuredOutputDto.new(params).to_h
  non_body_param_names = %w[id schemaOverride]
  body = request_data.except(*non_body_param_names)

  query_param_names = %i[schema_override]
  query_params = {}
  query_params["schemaOverride"] = params[:schema_override] if params.key?(:schema_override)
  params = params.except(*query_param_names)

  request = Vapi::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "PATCH",
    path: "structured-output/#{URI.encode_uri_component(params[:id].to_s)}",
    query: query_params,
    body: body,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Vapi::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Vapi::Types::StructuredOutput.load(response.body)
  else
    error_class = Vapi::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end