Class: TripletexRubyClient::VoucherMessageApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VoucherMessageApi

Returns a new instance of VoucherMessageApi.



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

def api_client
  @api_client
end

Instance Method Details

#post(opts = {}) ⇒ ResponseWrapperVoucherMessage

BETA

Post new voucherMessage.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (VoucherMessage) —

    JSON representing the new object to be created. Should not have ID and version set.

Returns:



27
28
29
30
 
# File 'lib/tripletex_ruby_client/api/voucher_message_api.rb', line 27

def post(opts = {})
  data, _status_code, _headers = post_with_http_info(opts)
  data
end

#post_with_http_info(opts = {}) ⇒ Array<(ResponseWrapperVoucherMessage, Fixnum, Hash)>

BETA

Post new voucherMessage.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (VoucherMessage) —

    JSON representing the new object to be created. Should not have ID and version set.

Returns:



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

def post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VoucherMessageApi.post ...'
  end
  # resource path
  local_var_path = '/voucherMessage'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseWrapperVoucherMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoucherMessageApi#post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(opts = {}) ⇒ ListResponseVoucherMessage

BETA

Find voucherMessage (or a comment) put on a voucher by inputting voucher ids

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :voucher_ids (String) —

    List of IDs

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



79
80
81
82
 
# File 'lib/tripletex_ruby_client/api/voucher_message_api.rb', line 79

def search(opts = {})
  data, _status_code, _headers = search_with_http_info(opts)
  data
end

#search_with_http_info(opts = {}) ⇒ Array<(ListResponseVoucherMessage, Fixnum, Hash)>

BETA

Find voucherMessage (or a comment) put on a voucher by inputting voucher ids

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :voucher_ids (String) —

    List of IDs

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseVoucherMessage data, response status code and response headers



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
122
123
124
125
126
127
128
 
# File 'lib/tripletex_ruby_client/api/voucher_message_api.rb', line 93

def search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VoucherMessageApi.search ...'
  end
  # resource path
  local_var_path = '/voucherMessage'

  # query parameters
  query_params = {}
  query_params[:'voucherIds'] = opts[:'voucher_ids'] if !opts[:'voucher_ids'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  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 => 'ListResponseVoucherMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoucherMessageApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end