Class: YNAB::PayeesApi
- Inherits:
-
Object
- Object
- YNAB::PayeesApi
- Defined in:
- lib/ynab/api/payees_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_payee_by_id(budget_id, payee_id, opts = {}) ⇒ PayeeResponse
Single payee Returns a single payee.
-
#get_payee_by_id_with_http_info(budget_id, payee_id, opts = {}) ⇒ Array<(PayeeResponse, Integer, Hash)>
Single payee Returns a single payee.
-
#get_payees(budget_id, opts = {}) ⇒ PayeesResponse
List payees Returns all payees.
-
#get_payees_with_http_info(budget_id, opts = {}) ⇒ Array<(PayeesResponse, Integer, Hash)>
List payees Returns all payees.
-
#initialize(api_client = ApiClient.default) ⇒ PayeesApi
constructor
A new instance of PayeesApi.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/ynab/api/payees_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#get_payee_by_id(budget_id, payee_id, opts = {}) ⇒ PayeeResponse
Single payee Returns a single payee
28 29 30 31 |
# File 'lib/ynab/api/payees_api.rb', line 28 def get_payee_by_id(budget_id, payee_id, opts = {}) data, _status_code, _headers = get_payee_by_id_with_http_info(budget_id, payee_id, opts) data end |
#get_payee_by_id_with_http_info(budget_id, payee_id, opts = {}) ⇒ Array<(PayeeResponse, Integer, Hash)>
Single payee Returns a single payee
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 89 |
# File 'lib/ynab/api/payees_api.rb', line 39 def get_payee_by_id_with_http_info(budget_id, payee_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PayeesApi.get_payee_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 PayeesApi.get_payee_by_id" end # verify the required parameter 'payee_id' is set if @api_client.config.client_side_validation && payee_id.nil? fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.get_payee_by_id" end # resource path local_var_path = '/budgets/{budget_id}/payees/{payee_id}'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s)).sub('{' + 'payee_id' + '}', CGI.escape(payee_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] || 'PayeeResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearer'] = opts.merge( :operation => :"PayeesApi.get_payee_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: PayeesApi#get_payee_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_payees(budget_id, opts = {}) ⇒ PayeesResponse
List payees Returns all payees
97 98 99 100 |
# File 'lib/ynab/api/payees_api.rb', line 97 def get_payees(budget_id, opts = {}) data, _status_code, _headers = get_payees_with_http_info(budget_id, opts) data end |
#get_payees_with_http_info(budget_id, opts = {}) ⇒ Array<(PayeesResponse, Integer, Hash)>
List payees Returns all payees
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 152 153 154 155 |
# File 'lib/ynab/api/payees_api.rb', line 108 def get_payees_with_http_info(budget_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PayeesApi.get_payees ...' 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 PayeesApi.get_payees" end # resource path local_var_path = '/budgets/{budget_id}/payees'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'last_knowledge_of_server'] = opts[:'last_knowledge_of_server'] if !opts[:'last_knowledge_of_server'].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] || 'PayeesResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearer'] = opts.merge( :operation => :"PayeesApi.get_payees", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: PayeesApi#get_payees\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |