Class: MergeAccountingClient::AccountingPeriodsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_accounting_client/api/accounting_periods_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccountingPeriodsApi

Returns a new instance of AccountingPeriodsApi.



19
20
21
 
# File 'lib/merge_accounting_client/api/accounting_periods_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/merge_accounting_client/api/accounting_periods_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#accounting_periods_list(x_account_token, opts = {}) ⇒ PaginatedAccountingPeriodList

Returns a list of ‘AccountingPeriod` objects.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :cursor (String) —

    The pagination cursor value.

  • :include_deleted_data (Boolean) —

    Whether to include data that was marked as deleted by third party webhooks.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:



30
31
32
33
 
# File 'lib/merge_accounting_client/api/accounting_periods_api.rb', line 30

def accounting_periods_list(, opts = {})
  data, _status_code, _headers = accounting_periods_list_with_http_info(, opts)
  data
end

#accounting_periods_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedAccountingPeriodList, Integer, Hash)>

Returns a list of &#x60;AccountingPeriod&#x60; objects.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :cursor (String) —

    The pagination cursor value.

  • :include_deleted_data (Boolean) —

    Whether to include data that was marked as deleted by third party webhooks.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:



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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/merge_accounting_client/api/accounting_periods_api.rb', line 43

def accounting_periods_list_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingPeriodsApi.accounting_periods_list ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling AccountingPeriodsApi.accounting_periods_list"
  end
  # resource path
  local_var_path = '/accounting-periods'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Account-Token'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PaginatedAccountingPeriodList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"AccountingPeriodsApi.accounting_periods_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingPeriodsApi#accounting_periods_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#accounting_periods_retrieve(x_account_token, id, opts = {}) ⇒ AccountingPeriod

Returns an ‘AccountingPeriod` object with the given `id`.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

Returns:



102
103
104
105
 
# File 'lib/merge_accounting_client/api/accounting_periods_api.rb', line 102

def accounting_periods_retrieve(, id, opts = {})
  data, _status_code, _headers = accounting_periods_retrieve_with_http_info(, id, opts)
  data
end

#accounting_periods_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(AccountingPeriod, Integer, Hash)>

Returns an &#x60;AccountingPeriod&#x60; object with the given &#x60;id&#x60;.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

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

    the optional parameters

Options Hash (opts):

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

Returns:

  • (Array<(AccountingPeriod, Integer, Hash)>) —

    AccountingPeriod data, response status code and response headers



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/merge_accounting_client/api/accounting_periods_api.rb', line 113

def accounting_periods_retrieve_with_http_info(, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountingPeriodsApi.accounting_periods_retrieve ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling AccountingPeriodsApi.accounting_periods_retrieve"
  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 AccountingPeriodsApi.accounting_periods_retrieve"
  end
  # resource path
  local_var_path = '/accounting-periods/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Account-Token'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'AccountingPeriod'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"AccountingPeriodsApi.accounting_periods_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountingPeriodsApi#accounting_periods_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end