Class: MxPlatformRuby::TransactionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mx-platform-ruby/api/transactions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TransactionsApi

Returns a new instance of TransactionsApi.



19
20
21
 
# File 'lib/mx-platform-ruby/api/transactions_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/mx-platform-ruby/api/transactions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#users_user_guid_accounts_account_guid_transactions_post(user_guid, account_guid, transaction_create_request_body, opts = {}) ⇒ TransactionCreateResponseBody

Create manual transaction This endpoint can only be used to create manual transactions that are under a manual account. This endpoint accepts the optional MX-Skip-Webhook header and skip_webhook parameter.

Parameters:

  • user_guid (String) —

    The unique identifier for the user.

  • account_guid (String) —

    The unique identifier for the account.

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/mx-platform-ruby/api/transactions_api.rb', line 29

def (user_guid, , transaction_create_request_body, opts = {})
  data, _status_code, _headers = (user_guid, , transaction_create_request_body, opts)
  data
end

#users_user_guid_accounts_account_guid_transactions_post_with_http_info(user_guid, account_guid, transaction_create_request_body, opts = {}) ⇒ Array<(TransactionCreateResponseBody, Integer, Hash)>

Create manual transaction This endpoint can only be used to create manual transactions that are under a manual account. This endpoint accepts the optional MX-Skip-Webhook header and skip_webhook parameter.

Parameters:

  • user_guid (String) —

    The unique identifier for the user.

  • account_guid (String) —

    The unique identifier for the account.

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

    the optional parameters

Returns:



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
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/mx-platform-ruby/api/transactions_api.rb', line 41

def (user_guid, , transaction_create_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsApi.users_user_guid_accounts_account_guid_transactions_post ...'
  end
  # verify the required parameter 'user_guid' is set
  if @api_client.config.client_side_validation && user_guid.nil?
    fail ArgumentError, "Missing the required parameter 'user_guid' when calling TransactionsApi.users_user_guid_accounts_account_guid_transactions_post"
  end
  # verify the required parameter 'account_guid' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_guid' when calling TransactionsApi.users_user_guid_accounts_account_guid_transactions_post"
  end
  # verify the required parameter 'transaction_create_request_body' is set
  if @api_client.config.client_side_validation && transaction_create_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_create_request_body' when calling TransactionsApi.users_user_guid_accounts_account_guid_transactions_post"
  end
  # resource path
  local_var_path = '/users/{user_guid}/accounts/{account_guid}/transactions'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'account_guid' + '}', CGI.escape(.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/vnd.mx.api.v1+json']) unless header_params['Accept']
  # 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(transaction_create_request_body)

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

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

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