Class: VericredClient::VisionPlansApi

Inherits:
Object
  • Object
show all
Defined in:
lib/vericred_client/api/vision_plans_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VisionPlansApi

Returns a new instance of VisionPlansApi.



19
20
21
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_vision_plan(vericred_id, opts = {}) ⇒ nil

Delete a Vision Plan. Delete a Vision Plan from the database.

Parameters:

  • vericred_id —

    The unique Vericred id

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

    the optional parameters

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 28

def delete_vision_plan(vericred_id, opts = {})
  delete_vision_plan_with_http_info(vericred_id, opts)
  return nil
end

#delete_vision_plan_with_http_info(vericred_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Vision Plan. Delete a Vision Plan from the database.

Parameters:

  • vericred_id —

    The unique Vericred id

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
74
75
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 38

def delete_vision_plan_with_http_info(vericred_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VisionPlansApi.delete_vision_plan ..."
  end
  # verify the required parameter 'vericred_id' is set
  if @api_client.config.client_side_validation && vericred_id.nil?
    fail ArgumentError, "Missing the required parameter 'vericred_id' when calling VisionPlansApi.delete_vision_plan"
  end
  # resource path
  local_var_path = "/plans/vision/{vericred_id}".sub('{' + 'vericred_id' + '}', vericred_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Vericred-Api-Key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VisionPlansApi#delete_vision_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_vision_plan(vericred_id, body, opts = {}) ⇒ nil

Create/update a Vision Plan Add or update a Vision Plan to the database.

Parameters:

  • vericred_id —

    The unique Vericred id

  • body —

    Vision Plan Record

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

    the optional parameters

Returns:

  • (nil) 


83
84
85
86
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 83

def put_vision_plan(vericred_id, body, opts = {})
  put_vision_plan_with_http_info(vericred_id, body, opts)
  return nil
end

#put_vision_plan_with_http_info(vericred_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create/update a Vision Plan Add or update a Vision Plan to the database.

Parameters:

  • vericred_id —

    The unique Vericred id

  • body —

    Vision Plan Record

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 94

def put_vision_plan_with_http_info(vericred_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VisionPlansApi.put_vision_plan ..."
  end
  # verify the required parameter 'vericred_id' is set
  if @api_client.config.client_side_validation && vericred_id.nil?
    fail ArgumentError, "Missing the required parameter 'vericred_id' when calling VisionPlansApi.put_vision_plan"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling VisionPlansApi.put_vision_plan"
  end
  # resource path
  local_var_path = "/plans/vision/{vericred_id}".sub('{' + 'vericred_id' + '}', vericred_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['Vericred-Api-Key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VisionPlansApi#put_vision_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#show_vision_plan(id, opts = {}) ⇒ VisionPlanShowResponse

Show Plan Show the details of a VisionPlan.

Parameters:

  • id —

    ID of the Plan

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

    the optional parameters

Returns:



142
143
144
145
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 142

def show_vision_plan(id, opts = {})
  data, _status_code, _headers = show_vision_plan_with_http_info(id, opts)
  return data
end

#show_vision_plan_with_http_info(id, opts = {}) ⇒ Array<(VisionPlanShowResponse, Fixnum, Hash)>

Show Plan Show the details of a VisionPlan.

Parameters:

  • id —

    ID of the Plan

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

    the optional parameters

Returns:

  • (Array<(VisionPlanShowResponse, Fixnum, Hash)>) —

    VisionPlanShowResponse data, response status code and response headers



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
190
 
# File 'lib/vericred_client/api/vision_plans_api.rb', line 152

def show_vision_plan_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VisionPlansApi.show_vision_plan ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling VisionPlansApi.show_vision_plan"
  end
  # resource path
  local_var_path = "/plans/vision/{vericred_id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Vericred-Api-Key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VisionPlanShowResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VisionPlansApi#show_vision_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end