Class: Bfwd::CouponinstanceApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CouponinstanceApi

Returns a new instance of CouponinstanceApi.



19
20
21
 
# File 'lib/bf_ruby2/api/couponinstance_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/couponinstance_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_coupon_instance(coupon_instance, opts = {}) ⇒ CouponInstancePagedMetadata

Create a coupon-instance. a new coupon","request":"createCouponInstanceRequest.html","response":"createCouponInstanceResponse.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/couponinstance_api.rb', line 28

def create_coupon_instance(coupon_instance, opts = {})
  data, _status_code, _headers = create_coupon_instance_with_http_info(coupon_instance, opts)
  return data
end

#create_coupon_instance_with_http_info(coupon_instance, opts = {}) ⇒ Array<(CouponInstancePagedMetadata, Fixnum, Hash)>

Create a coupon-instance. a new coupon&quot;,&quot;request&quot;:&quot;createCouponInstanceRequest.html&quot;,&quot;response&quot;:&quot;createCouponInstanceResponse.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/couponinstance_api.rb', line 38

def create_coupon_instance_with_http_info(coupon_instance, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponinstanceApi.create_coupon_instance ..."
  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 CouponinstanceApi.create_coupon_instance"
  end
  # resource path
  local_var_path = "/coupon-instances"

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

#delete_coupon_instance(coupon_instance_id, opts = {}) ⇒ CouponInstancePagedMetadata

Retire a coupon-instance, specified by the coupon-instance-ID parameter. a coupon","response":"deleteCouponInstanceByID.html"

Parameters:

  • coupon_instance_id —

    ID of the coupon-instance.

  • 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/couponinstance_api.rb', line 84

def delete_coupon_instance(coupon_instance_id, opts = {})
  data, _status_code, _headers = delete_coupon_instance_with_http_info(coupon_instance_id, opts)
  return data
end

#delete_coupon_instance_with_http_info(coupon_instance_id, opts = {}) ⇒ Array<(CouponInstancePagedMetadata, Fixnum, Hash)>

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

Parameters:

  • coupon_instance_id —

    ID of the coupon-instance.

  • 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/couponinstance_api.rb', line 95

def delete_coupon_instance_with_http_info(coupon_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponinstanceApi.delete_coupon_instance ..."
  end
  # verify the required parameter 'coupon_instance_id' is set
  if @api_client.config.client_side_validation && coupon_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'coupon_instance_id' when calling CouponinstanceApi.delete_coupon_instance"
  end
  # resource path
  local_var_path = "/coupon-instances/{coupon-instance-ID}".sub('{' + 'coupon-instance-ID' + '}', coupon_instance_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 => 'CouponInstancePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponinstanceApi#delete_coupon_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_attachable_coupon_instances(attachableness, has_code, opts = {}) ⇒ CouponInstancePagedMetadata

Returns a collection of attachable coupon-instances. An attachable coupon-instance has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order. attachable coupons","response":"getCouponInstanceAllAttachable.html"

Parameters:

  • attachableness —

    The attachableness of the coupon-instance.

  • has_code —

    Whether the coupon-instances have coupon codes or not.

  • 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 coupon-instance to return. (default to 0)

  • :records (Integer) —

    The maximum number of coupon-instances to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

Returns:



147
148
149
150
 
# File 'lib/bf_ruby2/api/couponinstance_api.rb', line 147

def get_all_attachable_coupon_instances(attachableness, has_code, opts = {})
  data, _status_code, _headers = get_all_attachable_coupon_instances_with_http_info(attachableness, has_code, opts)
  return data
end

#get_all_attachable_coupon_instances_with_http_info(attachableness, has_code, opts = {}) ⇒ Array<(CouponInstancePagedMetadata, Fixnum, Hash)>

Returns a collection of attachable coupon-instances. An attachable coupon-instance has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order. attachable coupons&quot;,&quot;response&quot;:&quot;getCouponInstanceAllAttachable.html&quot;

Parameters:

  • attachableness —

    The attachableness of the coupon-instance.

  • has_code —

    Whether the coupon-instances have coupon codes or not.

  • 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 coupon-instance to return.

  • :records (Integer) —

    The maximum number of coupon-instances to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

Returns:



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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/bf_ruby2/api/couponinstance_api.rb', line 163

def get_all_attachable_coupon_instances_with_http_info(attachableness, has_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponinstanceApi.get_all_attachable_coupon_instances ..."
  end
  # verify the required parameter 'attachableness' is set
  if @api_client.config.client_side_validation && attachableness.nil?
    fail ArgumentError, "Missing the required parameter 'attachableness' when calling CouponinstanceApi.get_all_attachable_coupon_instances"
  end
  # verify the required parameter 'has_code' is set
  if @api_client.config.client_side_validation && has_code.nil?
    fail ArgumentError, "Missing the required parameter 'has_code' when calling CouponinstanceApi.get_all_attachable_coupon_instances"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/coupon-instances/attachable/{attachableness}/{has_code}".sub('{' + 'attachableness' + '}', attachableness.to_s).sub('{' + 'has_code' + '}', has_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?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].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 => 'CouponInstancePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponinstanceApi#get_all_attachable_coupon_instances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_coupon_instances(opts = {}) ⇒ CouponInstancePagedMetadata

Returns a collection of coupon-instances. By default 10 values are returned. Records are returned in natural order. all coupons","response":"getCouponInstanceAll.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 coupon-instance to return. (default to 0)

  • :records (Integer) —

    The maximum number of coupon-instances to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired coupon-instances should be returned. (default to true)

Returns:



223
224
225
226
 
# File 'lib/bf_ruby2/api/couponinstance_api.rb', line 223

def get_all_coupon_instances(opts = {})
  data, _status_code, _headers = get_all_coupon_instances_with_http_info(opts)
  return data
end

#get_all_coupon_instances_with_http_info(opts = {}) ⇒ Array<(CouponInstancePagedMetadata, Fixnum, Hash)>

Returns a collection of coupon-instances. By default 10 values are returned. Records are returned in natural order. all coupons&quot;,&quot;response&quot;:&quot;getCouponInstanceAll.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 coupon-instance to return.

  • :records (Integer) —

    The maximum number of coupon-instances to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired coupon-instances should be returned.

Returns:



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

def get_all_coupon_instances_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponinstanceApi.get_all_coupon_instances ..."
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/coupon-instances"

  # 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?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].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 => 'CouponInstancePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponinstanceApi#get_all_coupon_instances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_coupon_instance_by_coupon_code(coupon_code, opts = {}) ⇒ CouponInstancePagedMetadata

Returns a collection of coupon-instances, specified by coupon-code parameter. By default 10 coupon-instances are returned. Records are returned in natural order. by coupon code","response":"getCouponInstanceByCouponCode.html"

Parameters:

  • coupon_code —

    The string coupon-code of the coupon-instance.

  • 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 coupon-instance to return. (default to 0)

  • :records (Integer) —

    The maximum number of coupon-instances to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired coupon-instances should be returned. (default to true)

Returns:



292
293
294
295
 
# File 'lib/bf_ruby2/api/couponinstance_api.rb', line 292

def get_coupon_instance_by_coupon_code(coupon_code, opts = {})
  data, _status_code, _headers = get_coupon_instance_by_coupon_code_with_http_info(coupon_code, opts)
  return data
end

#get_coupon_instance_by_coupon_code_with_http_info(coupon_code, opts = {}) ⇒ Array<(CouponInstancePagedMetadata, Fixnum, Hash)>

Returns a collection of coupon-instances, specified by coupon-code parameter. By default 10 coupon-instances are returned. Records are returned in natural order. by coupon code&quot;,&quot;response&quot;:&quot;getCouponInstanceByCouponCode.html&quot;

Parameters:

  • coupon_code —

    The string coupon-code of the coupon-instance.

  • 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 coupon-instance to return.

  • :records (Integer) —

    The maximum number of coupon-instances to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired coupon-instances should be returned.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
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
 
# File 'lib/bf_ruby2/api/couponinstance_api.rb', line 308

def get_coupon_instance_by_coupon_code_with_http_info(coupon_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponinstanceApi.get_coupon_instance_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 CouponinstanceApi.get_coupon_instance_by_coupon_code"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/coupon-instances/coupon/{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?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].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 => 'CouponInstancePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponinstanceApi#get_coupon_instance_by_coupon_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_coupon_instance_by_coupon_definition_id(coupon_definition_id, opts = {}) ⇒ CouponInstancePagedMetadata

Returns a collection of coupon-instances, specified by coupon-definition-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. by coupon definition","response":"getCouponInstanceByCouponDefinitionID.html"

Parameters:

  • coupon_definition_id —

    The string coupon-definition-ID of the coupon-instance.

  • 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 coupon-instance to return. (default to 0)

  • :records (Integer) —

    The maximum number of coupon-instances to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired coupon-instances should be returned. (default to true)

Returns:



368
369
370
371
 
# File 'lib/bf_ruby2/api/couponinstance_api.rb', line 368

def get_coupon_instance_by_coupon_definition_id(coupon_definition_id, opts = {})
  data, _status_code, _headers = get_coupon_instance_by_coupon_definition_id_with_http_info(coupon_definition_id, opts)
  return data
end

#get_coupon_instance_by_coupon_definition_id_with_http_info(coupon_definition_id, opts = {}) ⇒ Array<(CouponInstancePagedMetadata, Fixnum, Hash)>

Returns a collection of coupon-instances, specified by coupon-definition-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. by coupon definition&quot;,&quot;response&quot;:&quot;getCouponInstanceByCouponDefinitionID.html&quot;

Parameters:

  • coupon_definition_id —

    The string coupon-definition-ID of the coupon-instance.

  • 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 coupon-instance to return.

  • :records (Integer) —

    The maximum number of coupon-instances to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired coupon-instances should be returned.

Returns:



384
385
386
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
426
427
428
429
430
431
 
# File 'lib/bf_ruby2/api/couponinstance_api.rb', line 384

def get_coupon_instance_by_coupon_definition_id_with_http_info(coupon_definition_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponinstanceApi.get_coupon_instance_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 CouponinstanceApi.get_coupon_instance_by_coupon_definition_id"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/coupon-instances/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?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].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 => 'CouponInstancePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponinstanceApi#get_coupon_instance_by_coupon_definition_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_coupon_instance_by_id(coupon_instance_id, opts = {}) ⇒ CouponInstancePagedMetadata

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

Parameters:

  • coupon_instance_id —

    ID of the coupon-instance.

  • 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:



439
440
441
442
 
# File 'lib/bf_ruby2/api/couponinstance_api.rb', line 439

def get_coupon_instance_by_id(coupon_instance_id, opts = {})
  data, _status_code, _headers = get_coupon_instance_by_id_with_http_info(coupon_instance_id, opts)
  return data
end

#get_coupon_instance_by_id_with_http_info(coupon_instance_id, opts = {}) ⇒ Array<(CouponInstancePagedMetadata, Fixnum, Hash)>

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

Parameters:

  • coupon_instance_id —

    ID of the coupon-instance.

  • 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:



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/bf_ruby2/api/couponinstance_api.rb', line 450

def get_coupon_instance_by_id_with_http_info(coupon_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponinstanceApi.get_coupon_instance_by_id ..."
  end
  # verify the required parameter 'coupon_instance_id' is set
  if @api_client.config.client_side_validation && coupon_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'coupon_instance_id' when calling CouponinstanceApi.get_coupon_instance_by_id"
  end
  # resource path
  local_var_path = "/coupon-instances/{coupon-instance-ID}".sub('{' + 'coupon-instance-ID' + '}', coupon_instance_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 => 'CouponInstancePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponinstanceApi#get_coupon_instance_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_coupon_instance_by_target_id(target_id, opts = {}) ⇒ CouponInstancePagedMetadata

Returns a collection of coupon-instances, specified by target-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. by target","response":"getCouponInstanceByTargetID.html"

Parameters:

  • target_id —

    The string target-ID of the coupon-instance.

  • 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 coupon-instance to return. (default to 0)

  • :records (Integer) —

    The maximum number of coupon-instances to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired coupon-instances should be returned. (default to true)

Returns:



502
503
504
505
 
# File 'lib/bf_ruby2/api/couponinstance_api.rb', line 502

def get_coupon_instance_by_target_id(target_id, opts = {})
  data, _status_code, _headers = get_coupon_instance_by_target_id_with_http_info(target_id, opts)
  return data
end

#get_coupon_instance_by_target_id_with_http_info(target_id, opts = {}) ⇒ Array<(CouponInstancePagedMetadata, Fixnum, Hash)>

Returns a collection of coupon-instances, specified by target-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. by target&quot;,&quot;response&quot;:&quot;getCouponInstanceByTargetID.html&quot;

Parameters:

  • target_id —

    The string target-ID of the coupon-instance.

  • 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 coupon-instance to return.

  • :records (Integer) —

    The maximum number of coupon-instances to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired coupon-instances should be returned.

Returns:



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/bf_ruby2/api/couponinstance_api.rb', line 518

def get_coupon_instance_by_target_id_with_http_info(target_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponinstanceApi.get_coupon_instance_by_target_id ..."
  end
  # verify the required parameter 'target_id' is set
  if @api_client.config.client_side_validation && target_id.nil?
    fail ArgumentError, "Missing the required parameter 'target_id' when calling CouponinstanceApi.get_coupon_instance_by_target_id"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/coupon-instances/target/{target-ID}".sub('{' + 'target-ID' + '}', target_id.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?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].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 => 'CouponInstancePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponinstanceApi#get_coupon_instance_by_target_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_coupon_instance_by_target_type(target, opts = {}) ⇒ CouponInstancePagedMetadata

Returns a collection of coupon-instances, specified by target parameter. By default 10 coupon-instances are returned. Records are returned in natural order. by target type","response":"getCouponInstanceByTarget.html"

Parameters:

  • target —

    The string target of the coupon-instance.

  • 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 coupon-instance to return. (default to 0)

  • :records (Integer) —

    The maximum number of coupon-instances to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired coupon-instances should be returned. (default to true)

Returns:



578
579
580
581
 
# File 'lib/bf_ruby2/api/couponinstance_api.rb', line 578

def get_coupon_instance_by_target_type(target, opts = {})
  data, _status_code, _headers = get_coupon_instance_by_target_type_with_http_info(target, opts)
  return data
end

#get_coupon_instance_by_target_type_with_http_info(target, opts = {}) ⇒ Array<(CouponInstancePagedMetadata, Fixnum, Hash)>

Returns a collection of coupon-instances, specified by target parameter. By default 10 coupon-instances are returned. Records are returned in natural order. by target type&quot;,&quot;response&quot;:&quot;getCouponInstanceByTarget.html&quot;

Parameters:

  • target —

    The string target of the coupon-instance.

  • 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 coupon-instance to return.

  • :records (Integer) —

    The maximum number of coupon-instances to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired coupon-instances should be returned.

Returns:



594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
 
# File 'lib/bf_ruby2/api/couponinstance_api.rb', line 594

def get_coupon_instance_by_target_type_with_http_info(target, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponinstanceApi.get_coupon_instance_by_target_type ..."
  end
  # verify the required parameter 'target' is set
  if @api_client.config.client_side_validation && target.nil?
    fail ArgumentError, "Missing the required parameter 'target' when calling CouponinstanceApi.get_coupon_instance_by_target_type"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['none', 'subscription', 'account'].include?(target)
    fail ArgumentError, "invalid value for 'target', must be one of none, subscription, account"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/coupon-instances/target-entity/{target}".sub('{' + 'target' + '}', target.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?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].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 => 'CouponInstancePagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponinstanceApi#get_coupon_instance_by_target_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_coupon_instance(coupon_instance, opts = {}) ⇒ CouponInstancePagedMetadata

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

Parameters:

  • coupon_instance —

    The coupon-instance object to be updated.

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

    the optional parameters

Returns:



650
651
652
653
 
# File 'lib/bf_ruby2/api/couponinstance_api.rb', line 650

def update_coupon_instance(coupon_instance, opts = {})
  data, _status_code, _headers = update_coupon_instance_with_http_info(coupon_instance, opts)
  return data
end

#update_coupon_instance_with_http_info(coupon_instance, opts = {}) ⇒ Array<(CouponInstancePagedMetadata, Fixnum, Hash)>

Update a coupon-instance. a coupon&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:



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/bf_ruby2/api/couponinstance_api.rb', line 660

def update_coupon_instance_with_http_info(coupon_instance, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponinstanceApi.update_coupon_instance ..."
  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 CouponinstanceApi.update_coupon_instance"
  end
  # resource path
  local_var_path = "/coupon-instances"

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