Class: BillForward::AddressesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/api/addresses_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AddressesApi

Returns a new instance of AddressesApi.



30
31
32
 
# File 'lib/bf_ruby2/api/addresses_api.rb', line 30

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/bf_ruby2/api/addresses_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#create_address(request, opts = {}) ⇒ AddressPagedMetadata

Create a new address","response":"createAddressResponse.html","request":"createAddressRequest.html"

Parameters:

  • request —

    The address object to be created.

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

    the optional parameters

Returns:



39
40
41
42
 
# File 'lib/bf_ruby2/api/addresses_api.rb', line 39

def create_address(request, opts = {})
  data, _status_code, _headers = create_address_with_http_info(request, opts)
  return data
end

#create_address_with_http_info(request, opts = {}) ⇒ Array<(AddressPagedMetadata, Fixnum, Hash)>

Create a new address&quot;,&quot;response&quot;:&quot;createAddressResponse.html&quot;,&quot;request&quot;:&quot;createAddressRequest.html&quot;

Parameters:

  • request —

    The address object to be created.

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

    the optional parameters

Returns:

  • (Array<(AddressPagedMetadata, Fixnum, Hash)>) —

    AddressPagedMetadata data, response status code and response headers



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/bf_ruby2/api/addresses_api.rb', line 49

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
  fail ArgumentError, "Missing the required parameter 'request' when calling AddressesApi.create_address" if request.nil?
  # resource path
  local_var_path = "/addresses".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['text/xml', 'application/xml', 'application/json; charset=utf-8']
  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; 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(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_address(request, opts = {}) ⇒ AddressPagedMetadata

Update an address","response":"updateAddressResponse.html","request":"updateAddressRequest.html"

Parameters:

  • request —

    The address object to be created.

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

    the optional parameters

Returns:



96
97
98
99
 
# File 'lib/bf_ruby2/api/addresses_api.rb', line 96

def update_address(request, opts = {})
  data, _status_code, _headers = update_address_with_http_info(request, opts)
  return data
end

#update_address_with_http_info(request, opts = {}) ⇒ Array<(AddressPagedMetadata, Fixnum, Hash)>

Update an address&quot;,&quot;response&quot;:&quot;updateAddressResponse.html&quot;,&quot;request&quot;:&quot;updateAddressRequest.html&quot;

Parameters:

  • request —

    The address object to be created.

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

    the optional parameters

Returns:

  • (Array<(AddressPagedMetadata, Fixnum, Hash)>) —

    AddressPagedMetadata data, response status code and response headers



106
107
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
 
# File 'lib/bf_ruby2/api/addresses_api.rb', line 106

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
  fail ArgumentError, "Missing the required parameter 'request' when calling AddressesApi.update_address" if request.nil?
  # resource path
  local_var_path = "/addresses".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['text/xml', 'application/xml', 'application/json; charset=utf-8']
  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; 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(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