Class: BudgeaClient::HUBApi

Inherits:
Object
  • Object
show all
Defined in:
lib/budgea_client/api/hub_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ HUBApi

Returns a new instance of HUBApi.



19
20
21
 
# File 'lib/budgea_client/api/hub_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/budgea_client/api/hub_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#webhooks_id_webhook_add_to_data_post(id_webhook, opts = {}) ⇒ nil

Setup a field to store in user config when calling the endpoint For each parameter, a value will be added in the webhook data. Use the key to set the name of the field. The values that can be added are to be found in the user configuration.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/budgea_client/api/hub_api.rb', line 27

def webhooks_id_webhook_add_to_data_post(id_webhook, opts = {})
  webhooks_id_webhook_add_to_data_post_with_http_info(id_webhook, opts)
  nil
end

#webhooks_id_webhook_add_to_data_post_with_http_info(id_webhook, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Setup a field to store in user config when calling the endpoint For each parameter, a value will be added in the webhook data. Use the key to set the name of the field. The values that can be added are to be found in the user configuration.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/budgea_client/api/hub_api.rb', line 37

def webhooks_id_webhook_add_to_data_post_with_http_info(id_webhook, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HUBApi.webhooks_id_webhook_add_to_data_post ...'
  end
  # verify the required parameter 'id_webhook' is set
  if @api_client.config.client_side_validation && id_webhook.nil?
    fail ArgumentError, "Missing the required parameter 'id_webhook' when calling HUBApi.webhooks_id_webhook_add_to_data_post"
  end
  # resource path
  local_var_path = '/webhooks/{id_webhook}/add_to_data'.sub('{' + 'id_webhook' + '}', id_webhook.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HUBApi#webhooks_id_webhook_add_to_data_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end