Class: TripletexRubyClient::LedgeraccountingPeriodApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LedgeraccountingPeriodApi

Returns a new instance of LedgeraccountingPeriodApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Get accounting period 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/ledgeraccounting_period_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<(ResponseWrapperAccountingPeriod, Fixnum, Hash)>

Get accounting period 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/ledgeraccounting_period_api.rb', line 39

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

#search(opts = {}) ⇒ ListResponseAccountingPeriod

Find accounting periods corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :number_from (Integer) —

    From and including

  • :number_to (Integer) —

    To and excluding

  • :start_from (String) —

    From and including

  • :start_to (String) —

    To and excluding

  • :end_from (String) —

    From and including

  • :end_to (String) —

    To and excluding

  • :count (Integer) —

    Number of elements to return (default to 1400)

  • :from (Integer) —

    From index (default to 0)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



90
91
92
93
 
# File 'lib/tripletex_ruby_client/api/ledgeraccounting_period_api.rb', line 90

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

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

Find accounting periods corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :number_from (Integer) —

    From and including

  • :number_to (Integer) —

    To and excluding

  • :start_from (String) —

    From and including

  • :start_to (String) —

    To and excluding

  • :end_from (String) —

    From and including

  • :end_to (String) —

    To and excluding

  • :count (Integer) —

    Number of elements to return

  • :from (Integer) —

    From index

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/tripletex_ruby_client/api/ledgeraccounting_period_api.rb', line 110

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

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'numberFrom'] = opts[:'number_from'] if !opts[:'number_from'].nil?
  query_params[:'numberTo'] = opts[:'number_to'] if !opts[:'number_to'].nil?
  query_params[:'startFrom'] = opts[:'start_from'] if !opts[:'start_from'].nil?
  query_params[:'startTo'] = opts[:'start_to'] if !opts[:'start_to'].nil?
  query_params[:'endFrom'] = opts[:'end_from'] if !opts[:'end_from'].nil?
  query_params[:'endTo'] = opts[:'end_to'] if !opts[:'end_to'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].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 => 'ListResponseAccountingPeriod')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LedgeraccountingPeriodApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end