Class: UntitledApi::TdbController

Inherits:
BaseController show all
Defined in:
lib/untitled_api/controllers/tdb_controller.rb

Overview

TdbController

Constant Summary

Constants inherited from BaseController

BaseController::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#initialize, #new_api_call_builder, #new_parameter, #new_request_builder, #new_response_handler, user_agent

Constructor Details

This class inherits a constructor from UntitledApi::BaseController

Instance Method Details

#tdb_create(view) ⇒ void

This method returns an undefined value.

TODO: type endpoint description here

Parameters:

  • view (String) —

    Required parameter: Example:



28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/untitled_api/controllers/tdb_controller.rb', line 28

def tdb_create(view)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/tdb/{view}',
                                 Server::DEFAULT)
               .template_param(new_parameter(view, key: 'view')
                                .should_encode(true))
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#tdb_retrieve(view) ⇒ void

This method returns an undefined value.

TODO: type endpoint description here

Parameters:

  • view (String) —

    Required parameter: Example:



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/untitled_api/controllers/tdb_controller.rb', line 12

def tdb_retrieve(view)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/tdb/{view}',
                                 Server::DEFAULT)
               .template_param(new_parameter(view, key: 'view')
                                .should_encode(true))
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#tdb_stats_retrieve ⇒ TdbStatsResponse2

TODO: type endpoint description here

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/untitled_api/controllers/tdb_controller.rb', line 43

def tdb_stats_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/tdb/stats',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(TdbStatsResponse2.method(:from_hash)))
    .execute
end

#tdb_stats_retrieve_2(table) ⇒ TdbStatsResponse3

TODO: type endpoint description here

Parameters:

  • table (String) —

    Required parameter: Example:

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/untitled_api/controllers/tdb_controller.rb', line 59

def tdb_stats_retrieve_2(table)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/tdb/stats/{table}',
                                 Server::DEFAULT)
               .template_param(new_parameter(table, key: 'table')
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(TdbStatsResponse3.method(:from_hash)))
    .execute
end