Class: Fastly::BillingAddressApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/billing_address_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BillingAddressApi

Returns a new instance of BillingAddressApi.



17
18
19
 
# File 'lib/fastly/api/billing_address_api.rb', line 17

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/billing_address_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#add_billing_addr(opts = {}) ⇒ BillingAddressResponse

Add a billing address to a customer Add a billing address to a customer.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :customer_id (String) —

    Alphanumeric string identifying the customer. (required)

  • :billing_address_request (BillingAddressRequest) —

    Billing address

Returns:



25
26
27
28
 
# File 'lib/fastly/api/billing_address_api.rb', line 25

def add_billing_addr(opts = {})
  data, _status_code, _headers = add_billing_addr_with_http_info(opts)
  data
end

#add_billing_addr_with_http_info(opts = {}) ⇒ Array<(BillingAddressResponse, Integer, Hash)>

Add a billing address to a customer Add a billing address to a customer.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :customer_id (String) —

    Alphanumeric string identifying the customer. (required)

  • :billing_address_request (BillingAddressRequest) —

    Billing address

Returns:

  • (Array<(BillingAddressResponse, Integer, Hash)>) —

    BillingAddressResponse data, response status code and response headers



35
36
37
38
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
 
# File 'lib/fastly/api/billing_address_api.rb', line 35

def add_billing_addr_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingAddressApi.add_billing_addr ...'
  end
  # unbox the parameters from the hash
  customer_id = opts[:'customer_id']
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling BillingAddressApi.add_billing_addr"
  end
  # resource path
  local_var_path = '/customer/{customer_id}/billing_address'.sub('{' + 'customer_id' + '}', CGI.escape(customer_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/vnd.api+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'billing_address_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'BillingAddressResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"BillingAddressApi.add_billing_addr",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingAddressApi#add_billing_addr\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_billing_addr(opts = {}) ⇒ nil

Delete a billing address Delete a customer’s billing address.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :customer_id (String) —

    Alphanumeric string identifying the customer. (required)

Returns:

  • (nil) 


94
95
96
97
 
# File 'lib/fastly/api/billing_address_api.rb', line 94

def delete_billing_addr(opts = {})
  delete_billing_addr_with_http_info(opts)
  nil
end

#delete_billing_addr_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a billing address Delete a customer&#39;s billing address.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :customer_id (String) —

    Alphanumeric string identifying the customer. (required)

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



103
104
105
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
147
148
149
 
# File 'lib/fastly/api/billing_address_api.rb', line 103

def delete_billing_addr_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingAddressApi.delete_billing_addr ...'
  end
  # unbox the parameters from the hash
  customer_id = opts[:'customer_id']
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling BillingAddressApi.delete_billing_addr"
  end
  # resource path
  local_var_path = '/customer/{customer_id}/billing_address'.sub('{' + 'customer_id' + '}', CGI.escape(customer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"BillingAddressApi.delete_billing_addr",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingAddressApi#delete_billing_addr\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_billing_addr(opts = {}) ⇒ BillingAddressResponse

Get a billing address Get a customer’s billing address.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :customer_id (String) —

    Alphanumeric string identifying the customer. (required)

Returns:



155
156
157
158
 
# File 'lib/fastly/api/billing_address_api.rb', line 155

def get_billing_addr(opts = {})
  data, _status_code, _headers = get_billing_addr_with_http_info(opts)
  data
end

#get_billing_addr_with_http_info(opts = {}) ⇒ Array<(BillingAddressResponse, Integer, Hash)>

Get a billing address Get a customer&#39;s billing address.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :customer_id (String) —

    Alphanumeric string identifying the customer. (required)

Returns:

  • (Array<(BillingAddressResponse, Integer, Hash)>) —

    BillingAddressResponse data, response status code and response headers



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/fastly/api/billing_address_api.rb', line 164

def get_billing_addr_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingAddressApi.get_billing_addr ...'
  end
  # unbox the parameters from the hash
  customer_id = opts[:'customer_id']
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling BillingAddressApi.get_billing_addr"
  end
  # resource path
  local_var_path = '/customer/{customer_id}/billing_address'.sub('{' + 'customer_id' + '}', CGI.escape(customer_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/vnd.api+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BillingAddressResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"BillingAddressApi.get_billing_addr",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingAddressApi#get_billing_addr\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_billing_addr(opts = {}) ⇒ BillingAddressResponse

Update a billing address Update a customer’s billing address. You may update only part of the customer’s billing address.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :customer_id (String) —

    Alphanumeric string identifying the customer. (required)

  • :update_billing_address_request (UpdateBillingAddressRequest) —

    One or more billing address attributes

Returns:



219
220
221
222
 
# File 'lib/fastly/api/billing_address_api.rb', line 219

def update_billing_addr(opts = {})
  data, _status_code, _headers = update_billing_addr_with_http_info(opts)
  data
end

#update_billing_addr_with_http_info(opts = {}) ⇒ Array<(BillingAddressResponse, Integer, Hash)>

Update a billing address Update a customer&#39;s billing address. You may update only part of the customer&#39;s billing address.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :customer_id (String) —

    Alphanumeric string identifying the customer. (required)

  • :update_billing_address_request (UpdateBillingAddressRequest) —

    One or more billing address attributes

Returns:

  • (Array<(BillingAddressResponse, Integer, Hash)>) —

    BillingAddressResponse data, response status code and response headers



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/fastly/api/billing_address_api.rb', line 229

def update_billing_addr_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingAddressApi.update_billing_addr ...'
  end
  # unbox the parameters from the hash
  customer_id = opts[:'customer_id']
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling BillingAddressApi.update_billing_addr"
  end
  # resource path
  local_var_path = '/customer/{customer_id}/billing_address'.sub('{' + 'customer_id' + '}', CGI.escape(customer_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/vnd.api+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'update_billing_address_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'BillingAddressResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"BillingAddressApi.update_billing_addr",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingAddressApi#update_billing_addr\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end