class OrderCloud::AddressApi
Attributes
Public Class Methods
# File lib/order_cloud/api/address_api.rb, line 30 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
@param buyer_id ID of the buyer. @param address @param [Hash] opts the optional parameters @return [Address]
# File lib/order_cloud/api/address_api.rb, line 40 def create(buyer_id, address, opts = {}) data, _status_code, _headers = create_with_http_info(buyer_id, address, opts) return data end
@param buyer_id ID of the buyer. @param address @param [Hash] opts the optional parameters @return [Array<(Address
, Fixnum, Hash)>] Address
data, response status code and response headers
# File lib/order_cloud/api/address_api.rb, line 51 def create_with_http_info(buyer_id, address, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AddressApi.create ..." end # verify the required parameter 'buyer_id' is set fail ArgumentError, "Missing the required parameter 'buyer_id' when calling AddressApi.create" if buyer_id.nil? # verify the required parameter 'address' is set fail ArgumentError, "Missing the required parameter 'address' when calling AddressApi.create" if address.nil? # resource path local_var_path = "/buyers/{buyerID}/addresses".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(address) auth_names = ['oauth2'] 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 => 'Address') if @api_client.config.debugging @api_client.config.logger.debug "API called: AddressApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
@param buyer_id ID of the buyer. @param address_id ID of the address. @param [Hash] opts the optional parameters @return [nil]
# File lib/order_cloud/api/address_api.rb, line 101 def delete(buyer_id, address_id, opts = {}) delete_with_http_info(buyer_id, address_id, opts) return nil end
@param buyer_id ID of the buyer. @param address_id ID of the address. @param [Hash] opts the optional parameters @option opts [String] :user_id ID of the user. @option opts [String] :user_group_id ID of the user group. @return [nil]
# File lib/order_cloud/api/address_api.rb, line 163 def delete_assignment(buyer_id, address_id, opts = {}) delete_assignment_with_http_info(buyer_id, address_id, opts) return nil end
@param buyer_id ID of the buyer. @param address_id ID of the address. @param [Hash] opts the optional parameters @option opts [String] :user_id ID of the user. @option opts [String] :user_group_id ID of the user group. @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/order_cloud/api/address_api.rb, line 176 def delete_assignment_with_http_info(buyer_id, address_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AddressApi.delete_assignment ..." end # verify the required parameter 'buyer_id' is set fail ArgumentError, "Missing the required parameter 'buyer_id' when calling AddressApi.delete_assignment" if buyer_id.nil? # verify the required parameter 'address_id' is set fail ArgumentError, "Missing the required parameter 'address_id' when calling AddressApi.delete_assignment" if address_id.nil? # resource path local_var_path = "/buyers/{buyerID}/addresses/{addressID}/assignments".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'addressID' + '}', address_id.to_s) # query parameters query_params = {} query_params[:'userID'] = opts[:'user_id'] if !opts[:'user_id'].nil? query_params[:'userGroupID'] = opts[:'user_group_id'] if !opts[:'user_group_id'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['oauth2'] data, status_code, headers = @api_client.call_api(:DELETE, 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: AddressApi#delete_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
@param buyer_id ID of the buyer. @param address_id ID of the address. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/order_cloud/api/address_api.rb, line 112 def delete_with_http_info(buyer_id, address_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AddressApi.delete ..." end # verify the required parameter 'buyer_id' is set fail ArgumentError, "Missing the required parameter 'buyer_id' when calling AddressApi.delete" if buyer_id.nil? # verify the required parameter 'address_id' is set fail ArgumentError, "Missing the required parameter 'address_id' when calling AddressApi.delete" if address_id.nil? # resource path local_var_path = "/buyers/{buyerID}/addresses/{addressID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'addressID' + '}', address_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['oauth2'] data, status_code, headers = @api_client.call_api(:DELETE, 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: AddressApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
@param buyer_id ID of the buyer. @param address_id ID of the address. @param [Hash] opts the optional parameters @return [Address]
# File lib/order_cloud/api/address_api.rb, line 227 def get(buyer_id, address_id, opts = {}) data, _status_code, _headers = get_with_http_info(buyer_id, address_id, opts) return data end
@param buyer_id ID of the buyer. @param address_id ID of the address. @param [Hash] opts the optional parameters @return [Array<(Address
, Fixnum, Hash)>] Address
data, response status code and response headers
# File lib/order_cloud/api/address_api.rb, line 238 def get_with_http_info(buyer_id, address_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AddressApi.get ..." end # verify the required parameter 'buyer_id' is set fail ArgumentError, "Missing the required parameter 'buyer_id' when calling AddressApi.get" if buyer_id.nil? # verify the required parameter 'address_id' is set fail ArgumentError, "Missing the required parameter 'address_id' when calling AddressApi.get" if address_id.nil? # resource path local_var_path = "/buyers/{buyerID}/addresses/{addressID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'addressID' + '}', address_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['oauth2'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Address') if @api_client.config.debugging @api_client.config.logger.debug "API called: AddressApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
@param buyer_id ID of the buyer. @param [Hash] opts the optional parameters @option opts [String] :search Search of the address. @option opts [Array<String>] :search_on Search on of the address. @option opts [Array<String>] :sort_by Sort by of the address. @option opts [Integer] :page Page of the address. @option opts [Integer] :page_size Page size of the address. @option opts [Hash<String, String>] :filters Filters of the address. @return [ListAddress]
# File lib/order_cloud/api/address_api.rb, line 293 def list(buyer_id, opts = {}) data, _status_code, _headers = list_with_http_info(buyer_id, opts) return data end
@param buyer_id ID of the buyer. @param [Hash] opts the optional parameters @option opts [String] :address_id ID of the address. @option opts [String] :user_id ID of the user. @option opts [String] :user_group_id ID of the user group. @option opts [String] :level Level of the address. @option opts [BOOLEAN] :is_shipping Is shipping of the address. @option opts [BOOLEAN] :is_billing Is billing of the address. @option opts [Integer] :page Page of the address. @option opts [Integer] :page_size Page size of the address. @return [ListAddressAssignment]
# File lib/order_cloud/api/address_api.rb, line 370 def list_assignments(buyer_id, opts = {}) data, _status_code, _headers = list_assignments_with_http_info(buyer_id, opts) return data end
@param buyer_id ID of the buyer. @param [Hash] opts the optional parameters @option opts [String] :address_id ID of the address. @option opts [String] :user_id ID of the user. @option opts [String] :user_group_id ID of the user group. @option opts [String] :level Level of the address. @option opts [BOOLEAN] :is_shipping Is shipping of the address. @option opts [BOOLEAN] :is_billing Is billing of the address. @option opts [Integer] :page Page of the address. @option opts [Integer] :page_size Page size of the address. @return [Array<(ListAddressAssignment
, Fixnum, Hash)>] ListAddressAssignment
data, response status code and response headers
# File lib/order_cloud/api/address_api.rb, line 388 def list_assignments_with_http_info(buyer_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AddressApi.list_assignments ..." end # verify the required parameter 'buyer_id' is set fail ArgumentError, "Missing the required parameter 'buyer_id' when calling AddressApi.list_assignments" if buyer_id.nil? # resource path local_var_path = "/buyers/{buyerID}/addresses/assignments".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s) # query parameters query_params = {} query_params[:'addressID'] = opts[:'address_id'] if !opts[:'address_id'].nil? query_params[:'userID'] = opts[:'user_id'] if !opts[:'user_id'].nil? query_params[:'userGroupID'] = opts[:'user_group_id'] if !opts[:'user_group_id'].nil? query_params[:'level'] = opts[:'level'] if !opts[:'level'].nil? query_params[:'isShipping'] = opts[:'is_shipping'] if !opts[:'is_shipping'].nil? query_params[:'isBilling'] = opts[:'is_billing'] if !opts[:'is_billing'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['oauth2'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ListAddressAssignment') if @api_client.config.debugging @api_client.config.logger.debug "API called: AddressApi#list_assignments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
@param buyer_id ID of the buyer. @param [Hash] opts the optional parameters @option opts [String] :search Search of the address. @option opts [Array<String>] :search_on Search on of the address. @option opts [Array<String>] :sort_by Sort by of the address. @option opts [Integer] :page Page of the address. @option opts [Integer] :page_size Page size of the address. @option opts [Hash<String, String>] :filters Filters of the address. @return [Array<(ListAddress
, Fixnum, Hash)>] ListAddress
data, response status code and response headers
# File lib/order_cloud/api/address_api.rb, line 309 def list_with_http_info(buyer_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AddressApi.list ..." end # verify the required parameter 'buyer_id' is set fail ArgumentError, "Missing the required parameter 'buyer_id' when calling AddressApi.list" if buyer_id.nil? # resource path local_var_path = "/buyers/{buyerID}/addresses".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s) # query parameters query_params = {} query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil? query_params[:'searchOn'] = @api_client.build_collection_param(opts[:'search_on'], :csv) if !opts[:'search_on'].nil? query_params[:'sortBy'] = @api_client.build_collection_param(opts[:'sort_by'], :csv) if !opts[:'sort_by'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['oauth2'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ListAddress') if @api_client.config.debugging @api_client.config.logger.debug "API called: AddressApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
@param buyer_id ID of the buyer. @param address_id ID of the address. @param address @param [Hash] opts the optional parameters @return [Address]
# File lib/order_cloud/api/address_api.rb, line 445 def patch(buyer_id, address_id, address, opts = {}) data, _status_code, _headers = patch_with_http_info(buyer_id, address_id, address, opts) return data end
@param buyer_id ID of the buyer. @param address_id ID of the address. @param address @param [Hash] opts the optional parameters @return [Array<(Address
, Fixnum, Hash)>] Address
data, response status code and response headers
# File lib/order_cloud/api/address_api.rb, line 457 def patch_with_http_info(buyer_id, address_id, address, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AddressApi.patch ..." end # verify the required parameter 'buyer_id' is set fail ArgumentError, "Missing the required parameter 'buyer_id' when calling AddressApi.patch" if buyer_id.nil? # verify the required parameter 'address_id' is set fail ArgumentError, "Missing the required parameter 'address_id' when calling AddressApi.patch" if address_id.nil? # verify the required parameter 'address' is set fail ArgumentError, "Missing the required parameter 'address' when calling AddressApi.patch" if address.nil? # resource path local_var_path = "/buyers/{buyerID}/addresses/{addressID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'addressID' + '}', address_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(address) auth_names = ['oauth2'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Address') if @api_client.config.debugging @api_client.config.logger.debug "API called: AddressApi#patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
@param buyer_id ID of the buyer. @param assignment @param [Hash] opts the optional parameters @return [nil]
# File lib/order_cloud/api/address_api.rb, line 509 def save_assignment(buyer_id, assignment, opts = {}) save_assignment_with_http_info(buyer_id, assignment, opts) return nil end
@param buyer_id ID of the buyer. @param assignment @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/order_cloud/api/address_api.rb, line 520 def save_assignment_with_http_info(buyer_id, assignment, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AddressApi.save_assignment ..." end # verify the required parameter 'buyer_id' is set fail ArgumentError, "Missing the required parameter 'buyer_id' when calling AddressApi.save_assignment" if buyer_id.nil? # verify the required parameter 'assignment' is set fail ArgumentError, "Missing the required parameter 'assignment' when calling AddressApi.save_assignment" if assignment.nil? # resource path local_var_path = "/buyers/{buyerID}/addresses/assignments".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(assignment) auth_names = ['oauth2'] 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: AddressApi#save_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
@param buyer_id ID of the buyer. @param address_id ID of the address. @param address @param [Hash] opts the optional parameters @return [Address]
# File lib/order_cloud/api/address_api.rb, line 570 def update(buyer_id, address_id, address, opts = {}) data, _status_code, _headers = update_with_http_info(buyer_id, address_id, address, opts) return data end
@param buyer_id ID of the buyer. @param address_id ID of the address. @param address @param [Hash] opts the optional parameters @return [Array<(Address
, Fixnum, Hash)>] Address
data, response status code and response headers
# File lib/order_cloud/api/address_api.rb, line 582 def update_with_http_info(buyer_id, address_id, address, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AddressApi.update ..." end # verify the required parameter 'buyer_id' is set fail ArgumentError, "Missing the required parameter 'buyer_id' when calling AddressApi.update" if buyer_id.nil? # verify the required parameter 'address_id' is set fail ArgumentError, "Missing the required parameter 'address_id' when calling AddressApi.update" if address_id.nil? # verify the required parameter 'address' is set fail ArgumentError, "Missing the required parameter 'address' when calling AddressApi.update" if address.nil? # resource path local_var_path = "/buyers/{buyerID}/addresses/{addressID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'addressID' + '}', address_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(address) auth_names = ['oauth2'] 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 => 'Address') if @api_client.config.debugging @api_client.config.logger.debug "API called: AddressApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end