Class: Bfwd::CouponbookApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CouponbookApi

Returns a new instance of CouponbookApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_coupon_book(coupon_book, opts = {}) ⇒ CouponBookPagedMetadata

Create a coupon-book. a new coupon book","request":"createCouponBookRequest.html","response":"createCouponBookResponse.html"

Parameters:

  • coupon_book —

    The coupon-book object to be created.

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

    the optional parameters

Returns:



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

def create_coupon_book(coupon_book, opts = {})
  data, _status_code, _headers = create_coupon_book_with_http_info(coupon_book, opts)
  return data
end

#create_coupon_book_with_http_info(coupon_book, opts = {}) ⇒ Array<(CouponBookPagedMetadata, Fixnum, Hash)>

Create a coupon-book. a new coupon book&quot;,&quot;request&quot;:&quot;createCouponBookRequest.html&quot;,&quot;response&quot;:&quot;createCouponBookResponse.html&quot;

Parameters:

  • coupon_book —

    The coupon-book object to be created.

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

    the optional parameters

Returns:

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

    CouponBookPagedMetadata data, response status code and response headers



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/couponbook_api.rb', line 38

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

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

#delete_coupon_book(coupon_book_id, opts = {}) ⇒ CouponBookPagedMetadata

Retire a coupon-book, specified by the coupon-book-ID parameter. coupon book","response":"deleteCouponBookByID.html"

Parameters:

  • coupon_book_id —

    ID of the coupon-book.

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

def delete_coupon_book(coupon_book_id, opts = {})
  data, _status_code, _headers = delete_coupon_book_with_http_info(coupon_book_id, opts)
  return data
end

#delete_coupon_book_with_http_info(coupon_book_id, opts = {}) ⇒ Array<(CouponBookPagedMetadata, Fixnum, Hash)>

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

Parameters:

  • coupon_book_id —

    ID of the coupon-book.

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

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

    CouponBookPagedMetadata data, response status code and response headers



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

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

#get_all_attachable_coupon_books(attachableness, has_code, opts = {}) ⇒ CouponBookPagedMetadata

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

Parameters:

  • attachableness —

    The attachableness of the coupon-book.

  • has_code —

    Whether the coupon-books have book 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-book to return. (default to 0)

  • :records (Integer) —

    The maximum number of coupon-books 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/couponbook_api.rb', line 147

def get_all_attachable_coupon_books(attachableness, has_code, opts = {})
  data, _status_code, _headers = get_all_attachable_coupon_books_with_http_info(attachableness, has_code, opts)
  return data
end

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

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

Parameters:

  • attachableness —

    The attachableness of the coupon-book.

  • has_code —

    Whether the coupon-books have book 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-book to return.

  • :records (Integer) —

    The maximum number of coupon-books 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:

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

    CouponBookPagedMetadata data, response status code and response headers



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/couponbook_api.rb', line 163

def get_all_attachable_coupon_books_with_http_info(attachableness, has_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponbookApi.get_all_attachable_coupon_books ..."
  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 CouponbookApi.get_all_attachable_coupon_books"
  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 CouponbookApi.get_all_attachable_coupon_books"
  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-books/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 => 'CouponBookPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponbookApi#get_all_attachable_coupon_books\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_coupon_books(opts = {}) ⇒ CouponBookPagedMetadata

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

  • :records (Integer) —

    The maximum number of coupon-books 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-books should be returned. (default to true)

Returns:



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

def get_all_coupon_books(opts = {})
  data, _status_code, _headers = get_all_coupon_books_with_http_info(opts)
  return data
end

#get_all_coupon_books_with_http_info(opts = {}) ⇒ Array<(CouponBookPagedMetadata, Fixnum, Hash)>

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

  • :records (Integer) —

    The maximum number of coupon-books 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-books should be returned.

Returns:

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

    CouponBookPagedMetadata data, response status code and response headers



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/couponbook_api.rb', line 238

def get_all_coupon_books_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponbookApi.get_all_coupon_books ..."
  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-books"

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

#get_coupon_book_by_book_code(book_code, opts = {}) ⇒ CouponBookPagedMetadata

Returns a single coupon-book, specified by the book-code parameter. by book code","response":"getCouponBookByBookCode.html"

Parameters:

  • book_code —

    The unique coupon-book-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.

Returns:



287
288
289
290
 
# File 'lib/bf_ruby2/api/couponbook_api.rb', line 287

def get_coupon_book_by_book_code(book_code, opts = {})
  data, _status_code, _headers = get_coupon_book_by_book_code_with_http_info(book_code, opts)
  return data
end

#get_coupon_book_by_book_code_with_http_info(book_code, opts = {}) ⇒ Array<(CouponBookPagedMetadata, Fixnum, Hash)>

Returns a single coupon-book, specified by the book-code parameter. by book code&quot;,&quot;response&quot;:&quot;getCouponBookByBookCode.html&quot;

Parameters:

  • book_code —

    The unique coupon-book-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.

Returns:

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

    CouponBookPagedMetadata data, response status code and response headers



298
299
300
301
302
303
304
305
306
307
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
 
# File 'lib/bf_ruby2/api/couponbook_api.rb', line 298

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

#get_coupon_book_by_coupon_book_definition_id(coupon_book_definition_id, opts = {}) ⇒ CouponBookPagedMetadata

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

Parameters:

  • coupon_book_definition_id —

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

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

  • :records (Integer) —

    The maximum number of coupon-books 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-books should be returned. (default to true)

Returns:



350
351
352
353
 
# File 'lib/bf_ruby2/api/couponbook_api.rb', line 350

def get_coupon_book_by_coupon_book_definition_id(coupon_book_definition_id, opts = {})
  data, _status_code, _headers = get_coupon_book_by_coupon_book_definition_id_with_http_info(coupon_book_definition_id, opts)
  return data
end

#get_coupon_book_by_coupon_book_definition_id_with_http_info(coupon_book_definition_id, opts = {}) ⇒ Array<(CouponBookPagedMetadata, Fixnum, Hash)>

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

Parameters:

  • coupon_book_definition_id —

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

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

  • :records (Integer) —

    The maximum number of coupon-books 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-books should be returned.

Returns:

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

    CouponBookPagedMetadata data, response status code and response headers



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
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
 
# File 'lib/bf_ruby2/api/couponbook_api.rb', line 366

def get_coupon_book_by_coupon_book_definition_id_with_http_info(coupon_book_definition_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponbookApi.get_coupon_book_by_coupon_book_definition_id ..."
  end
  # verify the required parameter 'coupon_book_definition_id' is set
  if @api_client.config.client_side_validation && coupon_book_definition_id.nil?
    fail ArgumentError, "Missing the required parameter 'coupon_book_definition_id' when calling CouponbookApi.get_coupon_book_by_coupon_book_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-books/coupon-book-definition/{coupon-book-definition-ID}".sub('{' + 'coupon-book-definition-ID' + '}', coupon_book_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 => 'CouponBookPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponbookApi#get_coupon_book_by_coupon_book_definition_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_coupon_book_by_coupon_code(coupon_code, opts = {}) ⇒ CouponBookPagedMetadata

Returns a single coupon-book, specified by the coupon-code parameter. by coupon code","response":"getCouponBookByBookCode.html"

Parameters:

  • coupon_code —

    The unique 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.

Returns:



421
422
423
424
 
# File 'lib/bf_ruby2/api/couponbook_api.rb', line 421

def get_coupon_book_by_coupon_code(coupon_code, opts = {})
  data, _status_code, _headers = get_coupon_book_by_coupon_code_with_http_info(coupon_code, opts)
  return data
end

#get_coupon_book_by_coupon_code_with_http_info(coupon_code, opts = {}) ⇒ Array<(CouponBookPagedMetadata, Fixnum, Hash)>

Returns a single coupon-book, specified by the coupon-code parameter. by coupon code&quot;,&quot;response&quot;:&quot;getCouponBookByBookCode.html&quot;

Parameters:

  • coupon_code —

    The unique 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.

Returns:

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

    CouponBookPagedMetadata data, response status code and response headers



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/bf_ruby2/api/couponbook_api.rb', line 432

def get_coupon_book_by_coupon_code_with_http_info(coupon_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponbookApi.get_coupon_book_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 CouponbookApi.get_coupon_book_by_coupon_code"
  end
  # resource path
  local_var_path = "/coupon-books/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?

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

#get_coupon_book_by_id(coupon_book_id, opts = {}) ⇒ CouponBookPagedMetadata

Returns a single coupon-book, specified by the coupon-book-ID parameter. an existing coupon book","response":"getCouponBookByID.html"

Parameters:

  • coupon_book_id —

    ID of the coupon-book.

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



479
480
481
482
 
# File 'lib/bf_ruby2/api/couponbook_api.rb', line 479

def get_coupon_book_by_id(coupon_book_id, opts = {})
  data, _status_code, _headers = get_coupon_book_by_id_with_http_info(coupon_book_id, opts)
  return data
end

#get_coupon_book_by_id_with_http_info(coupon_book_id, opts = {}) ⇒ Array<(CouponBookPagedMetadata, Fixnum, Hash)>

Returns a single coupon-book, specified by the coupon-book-ID parameter. an existing coupon book&quot;,&quot;response&quot;:&quot;getCouponBookByID.html&quot;

Parameters:

  • coupon_book_id —

    ID of the coupon-book.

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

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

    CouponBookPagedMetadata data, response status code and response headers



490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/bf_ruby2/api/couponbook_api.rb', line 490

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

#update_coupon_book(coupon_book, opts = {}) ⇒ CouponBookPagedMetadata

Update a coupon-book. a coupon book","request":"updateCouponBookRequest.html","response":"updateCouponBookResponse.html"

Parameters:

  • coupon_book —

    The coupon-book object to be updated.

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

    the optional parameters

Returns:



536
537
538
539
 
# File 'lib/bf_ruby2/api/couponbook_api.rb', line 536

def update_coupon_book(coupon_book, opts = {})
  data, _status_code, _headers = update_coupon_book_with_http_info(coupon_book, opts)
  return data
end

#update_coupon_book_with_http_info(coupon_book, opts = {}) ⇒ Array<(CouponBookPagedMetadata, Fixnum, Hash)>

Update a coupon-book. a coupon book&quot;,&quot;request&quot;:&quot;updateCouponBookRequest.html&quot;,&quot;response&quot;:&quot;updateCouponBookResponse.html&quot;

Parameters:

  • coupon_book —

    The coupon-book object to be updated.

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

    the optional parameters

Returns:

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

    CouponBookPagedMetadata data, response status code and response headers



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/bf_ruby2/api/couponbook_api.rb', line 546

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

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