Class: Buildium::BudgetsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/buildium-ruby/api/budgets_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BudgetsApi

Returns a new instance of BudgetsApi.



19
20
21
 
# File 'lib/buildium-ruby/api/budgets_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/buildium-ruby/api/budgets_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_budget(budget_post_message, opts = {}) ⇒ BudgetMessage

Create a budget Creates a budget. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Budgets</span> - ‘View` `Edit`

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/buildium-ruby/api/budgets_api.rb', line 27

def create_budget(budget_post_message, opts = {})
  data, _status_code, _headers = create_budget_with_http_info(budget_post_message, opts)
  data
end

#create_budget_with_http_info(budget_post_message, opts = {}) ⇒ Array<(BudgetMessage, Integer, Hash)>

Create a budget Creates a budget. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &amp;gt; Budgets&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    BudgetMessage data, response status code and response headers



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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/buildium-ruby/api/budgets_api.rb', line 37

def create_budget_with_http_info(budget_post_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetsApi.create_budget ...'
  end
  # verify the required parameter 'budget_post_message' is set
  if @api_client.config.client_side_validation && budget_post_message.nil?
    fail ArgumentError, "Missing the required parameter 'budget_post_message' when calling BudgetsApi.create_budget"
  end
  # resource path
  local_var_path = '/v1/budgets'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(budget_post_message)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"BudgetsApi.create_budget",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BudgetsApi#create_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_budget_by_id(budget_id, opts = {}) ⇒ BudgetMessage

Retrieve a budget Retrieves a budget. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Budgets</span> - ‘View`

Parameters:

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/buildium-ruby/api/budgets_api.rb', line 95

def get_budget_by_id(budget_id, opts = {})
  data, _status_code, _headers = get_budget_by_id_with_http_info(budget_id, opts)
  data
end

#get_budget_by_id_with_http_info(budget_id, opts = {}) ⇒ Array<(BudgetMessage, Integer, Hash)>

Retrieve a budget Retrieves a budget. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &amp;gt; Budgets&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Returns:

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

    BudgetMessage data, response status code and response headers



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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/buildium-ruby/api/budgets_api.rb', line 105

def get_budget_by_id_with_http_info(budget_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetsApi.get_budget_by_id ...'
  end
  # verify the required parameter 'budget_id' is set
  if @api_client.config.client_side_validation && budget_id.nil?
    fail ArgumentError, "Missing the required parameter 'budget_id' when calling BudgetsApi.get_budget_by_id"
  end
  # resource path
  local_var_path = '/v1/budgets/{budgetId}'.sub('{' + 'budgetId' + '}', CGI.escape(budget_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"BudgetsApi.get_budget_by_id",
    :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: BudgetsApi#get_budget_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_budgets(opts = {}) ⇒ Array<BudgetMessage>

Retrieve all budgets Retrieves all budgets. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Budgets</span> - ‘View`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :propertyids (Array<Integer>) —

    Filters results to any budget associated to any of the specified set of property ids.

  • :fiscalyear (Integer) —

    Filters results to any budgets that end in the given fiscal year. FiscalYear must be a positive number.

  • :name (String) —

    Filters results to any budgets whose name contains the specified value.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:



163
164
165
166
 
# File 'lib/buildium-ruby/api/budgets_api.rb', line 163

def get_budgets(opts = {})
  data, _status_code, _headers = get_budgets_with_http_info(opts)
  data
end

#get_budgets_with_http_info(opts = {}) ⇒ Array<(Array<BudgetMessage>, Integer, Hash)>

Retrieve all budgets Retrieves all budgets. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &amp;gt; Budgets&lt;/span&gt; - &#x60;View&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :propertyids (Array<Integer>) —

    Filters results to any budget associated to any of the specified set of property ids.

  • :fiscalyear (Integer) —

    Filters results to any budgets that end in the given fiscal year. FiscalYear must be a positive number.

  • :name (String) —

    Filters results to any budgets whose name contains the specified value.

  • :orderby (String) —

    &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;&quot;#section/API-Overview/Bulk-Request-Options&quot;&gt;Bulk Request Options&lt;/a&gt; for more information.

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 1000 and the default is 50.

Returns:

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

    Array<BudgetMessage> data, response status code and response headers



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
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/buildium-ruby/api/budgets_api.rb', line 178

def get_budgets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetsApi.get_budgets ...'
  end
  # resource path
  local_var_path = '/v1/budgets'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'propertyids'] = @api_client.build_collection_param(opts[:'propertyids'], :multi) if !opts[:'propertyids'].nil?
  query_params[:'fiscalyear'] = opts[:'fiscalyear'] if !opts[:'fiscalyear'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<BudgetMessage>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"BudgetsApi.get_budgets",
    :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: BudgetsApi#get_budgets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_budget(budget_id, budget_put_message, opts = {}) ⇒ BudgetMessage

Update a budget Updates a budget. <br /><br /><h4>Required permission(s):</h4><span class="permissionBlock">Accounting &gt; Budgets</span> - ‘View` `Edit`

Parameters:

  • budget_id (Integer)
  • budget_put_message (BudgetPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



234
235
236
237
 
# File 'lib/buildium-ruby/api/budgets_api.rb', line 234

def update_budget(budget_id, budget_put_message, opts = {})
  data, _status_code, _headers = update_budget_with_http_info(budget_id, budget_put_message, opts)
  data
end

#update_budget_with_http_info(budget_id, budget_put_message, opts = {}) ⇒ Array<(BudgetMessage, Integer, Hash)>

Update a budget Updates a budget. &lt;br /&gt;&lt;br /&gt;&lt;h4&gt;Required permission(s):&lt;/h4&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;Accounting &amp;gt; Budgets&lt;/span&gt; - &#x60;View&#x60; &#x60;Edit&#x60;

Parameters:

  • budget_id (Integer)
  • budget_put_message (BudgetPutMessage)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BudgetMessage data, response status code and response headers



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/buildium-ruby/api/budgets_api.rb', line 245

def update_budget_with_http_info(budget_id, budget_put_message, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetsApi.update_budget ...'
  end
  # verify the required parameter 'budget_id' is set
  if @api_client.config.client_side_validation && budget_id.nil?
    fail ArgumentError, "Missing the required parameter 'budget_id' when calling BudgetsApi.update_budget"
  end
  # verify the required parameter 'budget_put_message' is set
  if @api_client.config.client_side_validation && budget_put_message.nil?
    fail ArgumentError, "Missing the required parameter 'budget_put_message' when calling BudgetsApi.update_budget"
  end
  # resource path
  local_var_path = '/v1/budgets/{budgetId}'.sub('{' + 'budgetId' + '}', CGI.escape(budget_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(budget_put_message)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"BudgetsApi.update_budget",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BudgetsApi#update_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end