class DwollaSwagger::CustomersApi
Public Class Methods
Create a new customer.
@param [Hash] opts the optional parameters @option opts [CreateCustomer] :body Customer
to create. @return [Unit]
# File lib/dwolla_swagger/api/customers_api.rb, line 60 def self.create(opts = {}) # resource path path = "/customers".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/vnd.dwolla.v1.hal+json'] _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/vnd.dwolla.v1.hal+json'] header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = Swagger::Request.object_to_http_body(opts[:'body']) response = Swagger::Request.new(:POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => @auth_names}).make response.code == 201 ? obj = response.headers['Location'] : (obj = Unit.new() and obj.build_from_hash(response.body)) end
Create an OAuth token that is capable of adding a financial institution for the given customer.
@param id ID of customer. @param [Hash] opts the optional parameters @return [CustomerOAuthToken]
# File lib/dwolla_swagger/api/customers_api.rb, line 278 def self.create_funding_sources_token_for_customer(id, opts = {}) # verify the required parameter 'id' is set raise "Missing the required parameter 'id' when calling create_funding_sources_token_for_customer" if id.nil? # resource path path = "/customers/{id}/funding-sources-token".sub('{format}','json') # check if id parameter is resource URI, otherwise substitute for ID path = id =~ URI::regexp ? path.sub('{' + 'id' + '}', id.split('/')[-1].to_s) : path.sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/vnd.dwolla.v1.hal+json'] _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = [] header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil response = Swagger::Request.new(:POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => @auth_names}).make response.code == 201 ? obj = response.headers['Location'] : (obj = CustomerOAuthToken.new() and obj.build_from_hash(response.body)) end
Get a customer by id
@param id Id
of customer to get. @param [Hash] opts the optional parameters @return [Customer]
# File lib/dwolla_swagger/api/customers_api.rb, line 100 def self.get_customer(id, opts = {}) # verify the required parameter 'id' is set raise "Missing the required parameter 'id' when calling get_customer" if id.nil? # resource path path = "/customers/{id}".sub('{format}','json') # check if id parameter is resource URI, otherwise substitute for ID path = id =~ URI::regexp ? path.sub('{' + 'id' + '}', id.split('/')[-1].to_s) : path.sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/vnd.dwolla.v1.hal+json'] _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/vnd.dwolla.v1.hal+json'] header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => @auth_names}).make response.code == 201 ? obj = response.headers['Location'] : (obj = Customer.new() and obj.build_from_hash(response.body)) end
Get documents uploaded for customer.
@param id ID of customer. @param [Hash] opts the optional parameters @return [DocumentListResponse]
# File lib/dwolla_swagger/api/customers_api.rb, line 193 def self.get_customer_documents(id, opts = {}) # verify the required parameter 'id' is set raise "Missing the required parameter 'id' when calling get_customer_documents" if id.nil? # resource path path = "/customers/{id}/documents".sub('{format}','json') # check if id parameter is resource URI, otherwise substitute for ID path = id =~ URI::regexp ? path.sub('{' + 'id' + '}', id.split('/')[-1].to_s) : path.sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/vnd.dwolla.v1.hal+json'] _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = [] header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => @auth_names}).make response.code == 201 ? obj = response.headers['Location'] : (obj = DocumentListResponse.new() and obj.build_from_hash(response.body)) end
Get iav token for customer.
@param id ID of customer. @param [Hash] opts the optional parameters @return [IavToken]
# File lib/dwolla_swagger/api/customers_api.rb, line 324 def self.get_customer_iav_token(id, opts = {}) # verify the required parameter 'id' is set raise "Missing the required parameter 'id' when calling get_customer_iav_token" if id.nil? # resource path path = "/customers/{id}/iav-token".sub('{format}','json') # check if id parameter is resource URI, otherwise substitute for ID path = id =~ URI::regexp ? path.sub('{' + 'id' + '}', id.split('/')[-1].to_s) : path.sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/vnd.dwolla.v1.hal+json'] _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = [] header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil response = Swagger::Request.new(:POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => @auth_names}).make response.code == 201 ? obj = response.headers['Location'] : (obj = IavToken.new() and obj.build_from_hash(response.body)) end
Get a list of customers.
@param [Hash] opts the optional parameters @option opts [int] :limit How many results to return. @option opts [int] :offset How many results to skip. @option opts [string] :search Search term. @return [CustomerListResponse]
# File lib/dwolla_swagger/api/customers_api.rb, line 17 def self.list(opts = {}) # resource path path = "/customers".sub('{format}','json') # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if opts[:'limit'] query_params[:'offset'] = opts[:'offset'] if opts[:'offset'] query_params[:'search'] = opts[:'search'] if opts[:'search'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/vnd.dwolla.v1.hal+json'] _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = [] header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil response = Swagger::Request.new(:GET, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => @auth_names}).make response.code == 201 ? obj = response.headers['Location'] : (obj = CustomerListResponse.new() and obj.build_from_hash(response.body)) end
Update customer record. Personal customer records are re-verified upon update.
@param id Id
of customer to update. @param [Hash] opts the optional parameters @option opts [UpdateCustomer] :body Customer
to update. @return [Customer]
# File lib/dwolla_swagger/api/customers_api.rb, line 147 def self.update_customer(id, opts = {}) # verify the required parameter 'id' is set raise "Missing the required parameter 'id' when calling update_customer" if id.nil? # resource path path = "/customers/{id}".sub('{format}','json') # check if id parameter is resource URI, otherwise substitute for ID path = id =~ URI::regexp ? path.sub('{' + 'id' + '}', id.split('/')[-1].to_s) : path.sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/vnd.dwolla.v1.hal+json'] _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/vnd.dwolla.v1.hal+json'] header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = Swagger::Request.object_to_http_body(opts[:'body']) response = Swagger::Request.new(:POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => @auth_names}).make response.code == 201 ? obj = response.headers['Location'] : (obj = Customer.new() and obj.build_from_hash(response.body)) end
Upload a verification document.
@param [Hash] opts the optional parameters @return [Unit]
# File lib/dwolla_swagger/api/customers_api.rb, line 238 def self.upload_document(opts = {}) # resource path path = "/customers/{id}/documents".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = [] _header_accept_result = Swagger::Request.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['multipart/form-data'] header_params['Content-Type'] = Swagger::Request.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil response = Swagger::Request.new(:POST, path, {:params => query_params, :headers => header_params, :form_params => form_params, :body => post_body, :auth_names => @auth_names}).make response.code == 201 ? obj = response.headers['Location'] : (obj = Unit.new() and obj.build_from_hash(response.body)) end