Class: TripletexRubyClient::EventApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/api/event_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EventApi

Returns a new instance of EventApi.



19
20
21
 
# File 'lib/tripletex_ruby_client/api/event_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/tripletex_ruby_client/api/event_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#example(event_type, opts = {}) ⇒ ResponseWrapperEventInfoDTO

BETA

Get example webhook payload

Parameters:

  • event_type —

    Event type, from /event endpoint

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



28
29
30
31
 
# File 'lib/tripletex_ruby_client/api/event_api.rb', line 28

def example(event_type, opts = {})
  data, _status_code, _headers = example_with_http_info(event_type, opts)
  data
end

#example_with_http_info(event_type, opts = {}) ⇒ Array<(ResponseWrapperEventInfoDTO, Fixnum, Hash)>

BETA

Get example webhook payload

Parameters:

  • event_type —

    Event type, from /event endpoint

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



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
 
# File 'lib/tripletex_ruby_client/api/event_api.rb', line 39

def example_with_http_info(event_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventApi.example ...'
  end
  # verify the required parameter 'event_type' is set
  if @api_client.config.client_side_validation && event_type.nil?
    fail ArgumentError, "Missing the required parameter 'event_type' when calling EventApi.example"
  end
  # resource path
  local_var_path = '/event/{eventType}'.sub('{' + 'eventType' + '}', event_type.to_s)

  # query parameters
  query_params = {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  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 => 'ResponseWrapperEventInfoDTO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventApi#example\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(opts = {}) ⇒ ResponseWrapperMapStringEventInfoDescription

BETA

Get all (WebHook) event keys.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



80
81
82
83
 
# File 'lib/tripletex_ruby_client/api/event_api.rb', line 80

def get(opts = {})
  data, _status_code, _headers = get_with_http_info(opts)
  data
end

#get_with_http_info(opts = {}) ⇒ Array<(ResponseWrapperMapStringEventInfoDescription, Fixnum, Hash)>

BETA

Get all (WebHook) event keys.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



90
91
92
93
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
 
# File 'lib/tripletex_ruby_client/api/event_api.rb', line 90

def get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventApi.get ...'
  end
  # resource path
  local_var_path = '/event'

  # query parameters
  query_params = {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'ResponseWrapperMapStringEventInfoDescription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end