Class: Bfwd::CouponmodifierApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CouponmodifierApi

Returns a new instance of CouponmodifierApi.



19
20
21
 
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_coupon_modifier(coupon_instance, opts = {}) ⇒ CouponModifierBasePagedMetadata

Create a coupon-modifier. a new modifier","request":"createCouponModifierRequest.html","response":"createCouponModifierResponse.html"

Parameters:

  • coupon_instance —

    The coupon-instance object to be created.

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

    the optional parameters

Returns:



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

def create_coupon_modifier(coupon_instance, opts = {})
  data, _status_code, _headers = create_coupon_modifier_with_http_info(coupon_instance, opts)
  return data
end

#create_coupon_modifier_with_http_info(coupon_instance, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>

Create a coupon-modifier. a new modifier&quot;,&quot;request&quot;:&quot;createCouponModifierRequest.html&quot;,&quot;response&quot;:&quot;createCouponModifierResponse.html&quot;

Parameters:

  • coupon_instance —

    The coupon-instance object to be created.

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

    the optional parameters

Returns:



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
 
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 38

def create_coupon_modifier_with_http_info(coupon_instance, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponmodifierApi.create_coupon_modifier ..."
  end
  # verify the required parameter 'coupon_instance' is set
  if @api_client.config.client_side_validation && coupon_instance.nil?
    fail ArgumentError, "Missing the required parameter 'coupon_instance' when calling CouponmodifierApi.create_coupon_modifier"
  end
  # resource path
  local_var_path = "/coupon-modifiers"

  # 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(coupon_instance)
  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 => 'CouponModifierBasePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponmodifierApi#create_coupon_modifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_coupon_modifier(coupon_modifier_id, opts = {}) ⇒ CouponModifierBasePagedMetadata

Retire a coupon-modifier, specified by the coupon-modifier-ID parameter. a modifier","response":"deleteCouponModifierByID.html"

Parameters:

  • coupon_modifier_id —

    ID of the coupon-modifier.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



84
85
86
87
 
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 84

def delete_coupon_modifier(coupon_modifier_id, opts = {})
  data, _status_code, _headers = delete_coupon_modifier_with_http_info(coupon_modifier_id, opts)
  return data
end

#delete_coupon_modifier_with_http_info(coupon_modifier_id, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>

Retire a coupon-modifier, specified by the coupon-modifier-ID parameter. a modifier&quot;,&quot;response&quot;:&quot;deleteCouponModifierByID.html&quot;

Parameters:

  • coupon_modifier_id —

    ID of the coupon-modifier.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



95
96
97
98
99
100
101
102
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
 
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 95

def delete_coupon_modifier_with_http_info(coupon_modifier_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponmodifierApi.delete_coupon_modifier ..."
  end
  # verify the required parameter 'coupon_modifier_id' is set
  if @api_client.config.client_side_validation && coupon_modifier_id.nil?
    fail ArgumentError, "Missing the required parameter 'coupon_modifier_id' when calling CouponmodifierApi.delete_coupon_modifier"
  end
  # resource path
  local_var_path = "/coupon-modifiers/{coupon-modifier-ID}".sub('{' + 'coupon-modifier-ID' + '}', coupon_modifier_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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,
    :return_type => 'CouponModifierBasePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponmodifierApi#delete_coupon_modifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_coupon_modifiers(opts = {}) ⇒ CouponModifierBasePagedMetadata

Returns a collection of coupon-modifiers. By default 10 values are returned. Records are returned in natural order. all modifiers","response":"getCouponModifierAll.html"

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first product-rate-plan to return. (default to 0)

  • :records (Integer) —

    The maximum number of product-rate-plans to return. (default to 10)

Returns:



143
144
145
146
 
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 143

def get_all_coupon_modifiers(opts = {})
  data, _status_code, _headers = get_all_coupon_modifiers_with_http_info(opts)
  return data
end

#get_all_coupon_modifiers_with_http_info(opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>

Returns a collection of coupon-modifiers. By default 10 values are returned. Records are returned in natural order. all modifiers&quot;,&quot;response&quot;:&quot;getCouponModifierAll.html&quot;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first product-rate-plan to return.

  • :records (Integer) —

    The maximum number of product-rate-plans to return.

Returns:



155
156
157
158
159
160
161
162
163
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
 
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 155

def get_all_coupon_modifiers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponmodifierApi.get_all_coupon_modifiers ..."
  end
  # resource path
  local_var_path = "/coupon-modifiers"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'CouponModifierBasePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponmodifierApi#get_all_coupon_modifiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_coupon_modifier_by_coupon_code(coupon_code, opts = {}) ⇒ CouponModifierBasePagedMetadata

Returns a collection of coupon-modifiers, specified by the coupon-code parameter. by coupon code","response":"getCouponCode.html"

Parameters:

  • coupon_code —

    The coupon-code.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first product-rate-plan to return. (default to 0)

  • :records (Integer) —

    The maximum number of product-rate-plans to return. (default to 10)

Returns:



200
201
202
203
 
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 200

def get_coupon_modifier_by_coupon_code(coupon_code, opts = {})
  data, _status_code, _headers = get_coupon_modifier_by_coupon_code_with_http_info(coupon_code, opts)
  return data
end

#get_coupon_modifier_by_coupon_code_with_http_info(coupon_code, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>

Returns a collection of coupon-modifiers, specified by the coupon-code parameter. by coupon code&quot;,&quot;response&quot;:&quot;getCouponCode.html&quot;

Parameters:

  • coupon_code —

    The coupon-code.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first product-rate-plan to return.

  • :records (Integer) —

    The maximum number of product-rate-plans to return.

Returns:



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
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
 
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 213

def get_coupon_modifier_by_coupon_code_with_http_info(coupon_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponmodifierApi.get_coupon_modifier_by_coupon_code ..."
  end
  # verify the required parameter 'coupon_code' is set
  if @api_client.config.client_side_validation && coupon_code.nil?
    fail ArgumentError, "Missing the required parameter 'coupon_code' when calling CouponmodifierApi.get_coupon_modifier_by_coupon_code"
  end
  # resource path
  local_var_path = "/coupon-modifiers/coupon-code/{coupon-code}".sub('{' + 'coupon-code' + '}', coupon_code.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'CouponModifierBasePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponmodifierApi#get_coupon_modifier_by_coupon_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_coupon_modifier_by_coupon_definition_id(coupon_definition_id, opts = {}) ⇒ CouponModifierBasePagedMetadata

Returns a collection of coupon-modifiers, specified by the coupon-definition-ID parameter. by coupon definition","response":"getCouponModifierByCouponDefinitionID.html"

Parameters:

  • coupon_definition_id —

    ID of the coupon-definition.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



262
263
264
265
 
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 262

def get_coupon_modifier_by_coupon_definition_id(coupon_definition_id, opts = {})
  data, _status_code, _headers = get_coupon_modifier_by_coupon_definition_id_with_http_info(coupon_definition_id, opts)
  return data
end

#get_coupon_modifier_by_coupon_definition_id_with_http_info(coupon_definition_id, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>

Returns a collection of coupon-modifiers, specified by the coupon-definition-ID parameter. by coupon definition&quot;,&quot;response&quot;:&quot;getCouponModifierByCouponDefinitionID.html&quot;

Parameters:

  • coupon_definition_id —

    ID of the coupon-definition.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 273

def get_coupon_modifier_by_coupon_definition_id_with_http_info(coupon_definition_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponmodifierApi.get_coupon_modifier_by_coupon_definition_id ..."
  end
  # verify the required parameter 'coupon_definition_id' is set
  if @api_client.config.client_side_validation && coupon_definition_id.nil?
    fail ArgumentError, "Missing the required parameter 'coupon_definition_id' when calling CouponmodifierApi.get_coupon_modifier_by_coupon_definition_id"
  end
  # resource path
  local_var_path = "/coupon-modifiers/coupon-definition/{coupon-definition-ID}".sub('{' + 'coupon-definition-ID' + '}', coupon_definition_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'CouponModifierBasePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponmodifierApi#get_coupon_modifier_by_coupon_definition_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_coupon_modifier_by_id(coupon_modifier_id, opts = {}) ⇒ CouponModifierBasePagedMetadata

Returns a single coupon-modifier, specified by the coupon-modifier-ID parameter. existing modifier","response":"getCouponModifierByID.html"

Parameters:

  • coupon_modifier_id —

    ID of the coupon-modifier.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



320
321
322
323
 
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 320

def get_coupon_modifier_by_id(coupon_modifier_id, opts = {})
  data, _status_code, _headers = get_coupon_modifier_by_id_with_http_info(coupon_modifier_id, opts)
  return data
end

#get_coupon_modifier_by_id_with_http_info(coupon_modifier_id, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>

Returns a single coupon-modifier, specified by the coupon-modifier-ID parameter. existing modifier&quot;,&quot;response&quot;:&quot;getCouponModifierByID.html&quot;

Parameters:

  • coupon_modifier_id —

    ID of the coupon-modifier.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 331

def get_coupon_modifier_by_id_with_http_info(coupon_modifier_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponmodifierApi.get_coupon_modifier_by_id ..."
  end
  # verify the required parameter 'coupon_modifier_id' is set
  if @api_client.config.client_side_validation && coupon_modifier_id.nil?
    fail ArgumentError, "Missing the required parameter 'coupon_modifier_id' when calling CouponmodifierApi.get_coupon_modifier_by_id"
  end
  # resource path
  local_var_path = "/coupon-modifiers/{coupon-modifier-ID}".sub('{' + 'coupon-modifier-ID' + '}', coupon_modifier_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'CouponModifierBasePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponmodifierApi#get_coupon_modifier_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_coupon_modifier(coupon_instance, opts = {}) ⇒ CouponModifierBasePagedMetadata

Update a coupon-instance. a modifier","request":"updateCouponInstanceRequest.html","response":"updateCouponInstanceResponse.html"

Parameters:

  • coupon_instance —

    The coupon-instance object to be updated.

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

    the optional parameters

Returns:



377
378
379
380
 
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 377

def update_coupon_modifier(coupon_instance, opts = {})
  data, _status_code, _headers = update_coupon_modifier_with_http_info(coupon_instance, opts)
  return data
end

#update_coupon_modifier_with_http_info(coupon_instance, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>

Update a coupon-instance. a modifier&quot;,&quot;request&quot;:&quot;updateCouponInstanceRequest.html&quot;,&quot;response&quot;:&quot;updateCouponInstanceResponse.html&quot;

Parameters:

  • coupon_instance —

    The coupon-instance object to be updated.

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

    the optional parameters

Returns:



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 387

def update_coupon_modifier_with_http_info(coupon_instance, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponmodifierApi.update_coupon_modifier ..."
  end
  # verify the required parameter 'coupon_instance' is set
  if @api_client.config.client_side_validation && coupon_instance.nil?
    fail ArgumentError, "Missing the required parameter 'coupon_instance' when calling CouponmodifierApi.update_coupon_modifier"
  end
  # resource path
  local_var_path = "/coupon-modifiers"

  # 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(coupon_instance)
  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 => 'CouponModifierBasePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponmodifierApi#update_coupon_modifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end