Class: Vapi::ObservabilityScorecard::Client

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



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

def initialize(client:)
  @client = client
end

Instance Method Details

#scorecard_controller_create(request_options: {}, **params) ⇒ Vapi::Types::Scorecard

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:



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/vapi/observability_scorecard/client.rb', line 183

def scorecard_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: "observability/scorecard",
    body: Vapi::Types::CreateScorecardDto.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::Scorecard.load(response.body)
  else
    error_class = Vapi::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#scorecard_controller_get(request_options: {}, **params) ⇒ Vapi::Types::Scorecard

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:



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/vapi/observability_scorecard/client.rb', line 23

def scorecard_controller_get(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: "observability/scorecard/#{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::Scorecard.load(response.body)
  else
    error_class = Vapi::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#scorecard_controller_get_paginated(request_options: {}, **params) ⇒ Vapi::Types::ScorecardPaginatedResponse

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):

Returns:



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
 
# File 'lib/vapi/observability_scorecard/client.rb', line 135

def scorecard_controller_get_paginated(request_options: {}, **params)
  params = Vapi::Internal::Types::Utils.normalize_keys(params)
  query_param_names = %i[id 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["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: "observability/scorecard",
    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::ScorecardPaginatedResponse.load(response.body)
  else
    error_class = Vapi::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#scorecard_controller_remove(request_options: {}, **params) ⇒ Vapi::Types::Scorecard

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:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/vapi/observability_scorecard/client.rb', line 55

def scorecard_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: "observability/scorecard/#{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::Scorecard.load(response.body)
  else
    error_class = Vapi::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#scorecard_controller_update(request_options: {}, **params) ⇒ Vapi::Types::Scorecard

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)

Returns:



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
 
# File 'lib/vapi/observability_scorecard/client.rb', line 87

def scorecard_controller_update(request_options: {}, **params)
  params = Vapi::Internal::Types::Utils.normalize_keys(params)
  request_data = Vapi::ObservabilityScorecard::Types::UpdateScorecardDto.new(params).to_h
  non_body_param_names = ["id"]
  body = request_data.except(*non_body_param_names)

  request = Vapi::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "PATCH",
    path: "observability/scorecard/#{URI.encode_uri_component(params[:id].to_s)}",
    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::Scorecard.load(response.body)
  else
    error_class = Vapi::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end