Class: TripletexRubyClient::ReminderApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ReminderApi

Returns a new instance of ReminderApi.



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

def api_client
  @api_client
end

Instance Method Details

#download_pdf(reminder_id, opts = {}) ⇒ String

Get reminder document by reminder ID.

Parameters:

  • reminder_id —

    Reminder ID from which PDF is downloaded.

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

    the optional parameters

Options Hash (opts):

  • :return_type (String) —

    ‘String’ type set as default

Returns:

  • (String) 


81
82
83
84
 
# File 'lib/tripletex_ruby_client/api/reminder_api.rb', line 81

def download_pdf(reminder_id, opts = {})
  data, _status_code, _headers = download_pdf_with_http_info(reminder_id, opts)
  data
end

#download_pdf_with_http_info(reminder_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get reminder document by reminder ID.

Parameters:

  • reminder_id —

    Reminder ID from which PDF is downloaded.

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

    the optional parameters

Options Hash (opts):

  • :return_type (String) —

    ‘String’ type set as default

Returns:

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

    String data, response status code and response headers



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
123
124
125
126
127
128
129
130
131
 
# File 'lib/tripletex_ruby_client/api/reminder_api.rb', line 92

def download_pdf_with_http_info(reminder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReminderApi.download_pdf ...'
  end
  # verify the required parameter 'reminder_id' is set
  if @api_client.config.client_side_validation && reminder_id.nil?
    fail ArgumentError, "Missing the required parameter 'reminder_id' when calling ReminderApi.download_pdf"
  end
  # resource path
  local_var_path = '/reminder/{reminderId}/pdf'.sub('{' + 'reminderId' + '}', reminder_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/octet-stream'])

  # form parameters
  form_params = {}

  # return_type
  return_type = opts[:'return_type'] || 'String'

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

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

Get reminder 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/reminder_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<(ResponseWrapperReminder, Fixnum, Hash)>

Get reminder by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ResponseWrapperReminder data, response status code and response headers



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

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

#search(date_from, date_to, opts = {}) ⇒ ListResponseReminder

Find reminders corresponding with sent data.

Parameters:

  • date_from —

    From and including

  • date_to —

    To and excluding

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :term_of_payment_to (String) —

    To and excluding

  • :term_of_payment_from (String) —

    From and including

  • :invoice_id (Integer) —

    Equals

  • :customer_id (Integer) —

    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:



147
148
149
150
 
# File 'lib/tripletex_ruby_client/api/reminder_api.rb', line 147

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

#search_with_http_info(date_from, date_to, opts = {}) ⇒ Array<(ListResponseReminder, Fixnum, Hash)>

Find reminders corresponding with sent data.

Parameters:

  • date_from —

    From and including

  • date_to —

    To and excluding

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :term_of_payment_to (String) —

    To and excluding

  • :term_of_payment_from (String) —

    From and including

  • :invoice_id (Integer) —

    Equals

  • :customer_id (Integer) —

    Equals

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseReminder data, response status code and response headers



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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/tripletex_ruby_client/api/reminder_api.rb', line 167

def search_with_http_info(date_from, date_to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReminderApi.search ...'
  end
  # verify the required parameter 'date_from' is set
  if @api_client.config.client_side_validation && date_from.nil?
    fail ArgumentError, "Missing the required parameter 'date_from' when calling ReminderApi.search"
  end
  # verify the required parameter 'date_to' is set
  if @api_client.config.client_side_validation && date_to.nil?
    fail ArgumentError, "Missing the required parameter 'date_to' when calling ReminderApi.search"
  end
  # resource path
  local_var_path = '/reminder'

  # query parameters
  query_params = {}
  query_params[:'dateFrom'] = date_from
  query_params[:'dateTo'] = date_to
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'termOfPaymentTo'] = opts[:'term_of_payment_to'] if !opts[:'term_of_payment_to'].nil?
  query_params[:'termOfPaymentFrom'] = opts[:'term_of_payment_from'] if !opts[:'term_of_payment_from'].nil?
  query_params[:'invoiceId'] = opts[:'invoice_id'] if !opts[:'invoice_id'].nil?
  query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].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 => 'ListResponseReminder')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReminderApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end