Class: TripletexRubyClient::VoucherStatusApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VoucherStatusApi

Returns a new instance of VoucherStatusApi.



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

def api_client
  @api_client
end

Instance Method Details

#get(id, opts = {}) ⇒ ResponseWrapperVoucherStatus

BETA

Get voucherStatus by ID.

Parameters:

  • id —

    Element ID

  • 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/voucher_status_api.rb', line 28

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

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

BETA

Get voucherStatus by ID.

Parameters:

  • id —

    Element ID

  • 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/voucher_status_api.rb', line 39

def get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VoucherStatusApi.get ...'
  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 VoucherStatusApi.get"
  end
  # resource path
  local_var_path = '/voucherStatus/{id}'.sub('{' + 'id' + '}', id.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 => 'ResponseWrapperVoucherStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoucherStatusApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post(opts = {}) ⇒ ResponseWrapperVoucherStatus

BETA

Post new voucherStatus.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (VoucherStatus) —

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

Returns:



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

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

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

BETA

Post new voucherStatus.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (VoucherStatus) —

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

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
122
 
# File 'lib/tripletex_ruby_client/api/voucher_status_api.rb', line 90

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

  # 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 => 'ResponseWrapperVoucherStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoucherStatusApi#post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(opts = {}) ⇒ ListResponseVoucherStatus

BETA

Find voucherStatus corresponding with sent data. The voucherStatus is used to coordinate integration processes. Requires setup done by Tripletex, currently supports debt collection.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    List of IDs

  • :voucher_ids (String) —

    List of IDs

  • :status (String) —

    Equals

  • :type (String) —

    Equals

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



135
136
137
138
 
# File 'lib/tripletex_ruby_client/api/voucher_status_api.rb', line 135

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

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

BETA

Find voucherStatus corresponding with sent data. The voucherStatus is used to coordinate integration processes. Requires setup done by Tripletex, currently supports debt collection.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    List of IDs

  • :voucher_ids (String) —

    List of IDs

  • :status (String) —

    Equals

  • :type (String) —

    Equals

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseVoucherStatus 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
191
192
193
194
195
196
 
# File 'lib/tripletex_ruby_client/api/voucher_status_api.rb', line 152

def search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VoucherStatusApi.search ...'
  end
  if @api_client.config.client_side_validation && opts[:'status'] && !['WAITING', 'DONE', 'SKIPPED', 'ERROR', 'NONE', 'PROCESSING', 'RECLAIMED'].include?(opts[:'status'])
    fail ArgumentError, 'invalid value for "status", must be one of WAITING, DONE, SKIPPED, ERROR, NONE, PROCESSING, RECLAIMED'
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['TRIPLETEX', 'SUPPLIERINVOICE_EXTERNAL', 'DEBT_COLLECTION'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of TRIPLETEX, SUPPLIERINVOICE_EXTERNAL, DEBT_COLLECTION'
  end
  # resource path
  local_var_path = '/voucherStatus'

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