class Bfwd::AddressesApi
Attributes
Public Class Methods
# File lib/bf_ruby2/api/addresses_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create {"nickname":"Create a new address","response":"createAddressResponse.html","request":"createAddressRequest.html"} @param request The address object to be created. @param [Hash] opts the optional parameters @return [AddressPagedMetadata]
# File lib/bf_ruby2/api/addresses_api.rb, line 28 def create_address(request, opts = {}) data, _status_code, _headers = create_address_with_http_info(request, opts) return data end
Create {"nickname":"Create a new address","response":"createAddressResponse.html","request":"createAddressRequest.html"} @param request The address object to be created. @param [Hash] opts the optional parameters @return [Array<(AddressPagedMetadata
, Fixnum, Hash)>] AddressPagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/addresses_api.rb, line 38 def create_address_with_http_info(request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AddressesApi.create_address ..." end # verify the required parameter 'request' is set if @api_client.config.client_side_validation && request.nil? fail ArgumentError, "Missing the required parameter 'request' when calling AddressesApi.create_address" end # resource path local_var_path = "/addresses" # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(request) auth_names = [] 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, :return_type => 'AddressPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: AddressesApi#create_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update {"nickname":"Update an address","response":"updateAddressResponse.html","request":"updateAddressRequest.html"} @param request The address object to be created. @param [Hash] opts the optional parameters @return [AddressPagedMetadata]
# File lib/bf_ruby2/api/addresses_api.rb, line 83 def update_address(request, opts = {}) data, _status_code, _headers = update_address_with_http_info(request, opts) return data end
Update {"nickname":"Update an address","response":"updateAddressResponse.html","request":"updateAddressRequest.html"} @param request The address object to be created. @param [Hash] opts the optional parameters @return [Array<(AddressPagedMetadata
, Fixnum, Hash)>] AddressPagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/addresses_api.rb, line 93 def update_address_with_http_info(request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AddressesApi.update_address ..." end # verify the required parameter 'request' is set if @api_client.config.client_side_validation && request.nil? fail ArgumentError, "Missing the required parameter 'request' when calling AddressesApi.update_address" end # resource path local_var_path = "/addresses" # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(request) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AddressPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: AddressesApi#update_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end