Class: Bfwd::CouponbookdefinitionApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CouponbookdefinitionApi

Returns a new instance of CouponbookdefinitionApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_coupon_book_definition(coupon_book_definition, opts = {}) ⇒ CouponBookDefinitionPagedMetadata

Create a coupon-book-definition. a new book definition","request":"createCouponBookDefinitionRequest.html","response":"createCouponBookDefinitionResponse.html"

Parameters:

  • coupon_book_definition —

    The coupon-book-definition object to be created.

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

    the optional parameters

Returns:



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

def create_coupon_book_definition(coupon_book_definition, opts = {})
  data, _status_code, _headers = create_coupon_book_definition_with_http_info(coupon_book_definition, opts)
  return data
end

#create_coupon_book_definition_with_http_info(coupon_book_definition, opts = {}) ⇒ Array<(CouponBookDefinitionPagedMetadata, Fixnum, Hash)>

Create a coupon-book-definition. a new book definition&quot;,&quot;request&quot;:&quot;createCouponBookDefinitionRequest.html&quot;,&quot;response&quot;:&quot;createCouponBookDefinitionResponse.html&quot;

Parameters:

  • coupon_book_definition —

    The coupon-book-definition 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/couponbookdefinition_api.rb', line 38

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

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

#delete_coupon_book_definition(coupon_book_definition_id, opts = {}) ⇒ CouponBookDefinitionPagedMetadata

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

Parameters:

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



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

def delete_coupon_book_definition(coupon_book_definition_id, opts = {})
  data, _status_code, _headers = delete_coupon_book_definition_with_http_info(coupon_book_definition_id, opts)
  return data
end

#delete_coupon_book_definition_with_http_info(coupon_book_definition_id, opts = {}) ⇒ Array<(CouponBookDefinitionPagedMetadata, Fixnum, Hash)>

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

Parameters:

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



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

def delete_coupon_book_definition_with_http_info(coupon_book_definition_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponbookdefinitionApi.delete_coupon_book_definition ..."
  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 CouponbookdefinitionApi.delete_coupon_book_definition"
  end
  # resource path
  local_var_path = "/coupon-book-definitions/{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?

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

#get_all_coupon_book_definitions(opts = {}) ⇒ CouponBookDefinitionPagedMetadata

Returns a collection of coupon-book-definitions. By default 10 values are returned. Records are returned in natural order. all book definitions","response":"getCouponBookDefinitionAll.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)

  • :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-book-definitions should be returned. (default to true)

Returns:



146
147
148
149
 
# File 'lib/bf_ruby2/api/couponbookdefinition_api.rb', line 146

def get_all_coupon_book_definitions(opts = {})
  data, _status_code, _headers = get_all_coupon_book_definitions_with_http_info(opts)
  return data
end

#get_all_coupon_book_definitions_with_http_info(opts = {}) ⇒ Array<(CouponBookDefinitionPagedMetadata, Fixnum, Hash)>

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

  • :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-book-definitions should be returned.

Returns:



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
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/bf_ruby2/api/couponbookdefinition_api.rb', line 161

def get_all_coupon_book_definitions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponbookdefinitionApi.get_all_coupon_book_definitions ..."
  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-book-definitions"

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

#get_coupon_book_definition_by_coupon_definition_id(coupon_definition_id, opts = {}) ⇒ CouponBookDefinitionPagedMetadata

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

Parameters:

  • coupon_definition_id —

    The string coupon-definition-ID of the coupon-book-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.

  • :offset (Integer) —

    The offset from the first coupon-book-definition to return. (default to 0)

  • :records (Integer) —

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

Returns:



215
216
217
218
 
# File 'lib/bf_ruby2/api/couponbookdefinition_api.rb', line 215

def get_coupon_book_definition_by_coupon_definition_id(coupon_definition_id, opts = {})
  data, _status_code, _headers = get_coupon_book_definition_by_coupon_definition_id_with_http_info(coupon_definition_id, opts)
  return data
end

#get_coupon_book_definition_by_coupon_definition_id_with_http_info(coupon_definition_id, opts = {}) ⇒ Array<(CouponBookDefinitionPagedMetadata, Fixnum, Hash)>

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

Parameters:

  • coupon_definition_id —

    The string coupon-definition-ID of the coupon-book-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.

  • :offset (Integer) —

    The offset from the first coupon-book-definition to return.

  • :records (Integer) —

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

Returns:



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

def get_coupon_book_definition_by_coupon_definition_id_with_http_info(coupon_definition_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponbookdefinitionApi.get_coupon_book_definition_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 CouponbookdefinitionApi.get_coupon_book_definition_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-book-definitions/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 => 'CouponBookDefinitionPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CouponbookdefinitionApi#get_coupon_book_definition_by_coupon_definition_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_coupon_book_definition_by_id(coupon_book_definition_id, opts = {}) ⇒ CouponBookDefinitionPagedMetadata

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

Parameters:

  • coupon_book_definition_id —

    ID of the coupon-book-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:



286
287
288
289
 
# File 'lib/bf_ruby2/api/couponbookdefinition_api.rb', line 286

def get_coupon_book_definition_by_id(coupon_book_definition_id, opts = {})
  data, _status_code, _headers = get_coupon_book_definition_by_id_with_http_info(coupon_book_definition_id, opts)
  return data
end

#get_coupon_book_definition_by_id_with_http_info(coupon_book_definition_id, opts = {}) ⇒ Array<(CouponBookDefinitionPagedMetadata, Fixnum, Hash)>

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

Parameters:

  • coupon_book_definition_id —

    ID of the coupon-book-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:



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

def get_coupon_book_definition_by_id_with_http_info(coupon_book_definition_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CouponbookdefinitionApi.get_coupon_book_definition_by_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 CouponbookdefinitionApi.get_coupon_book_definition_by_id"
  end
  # resource path
  local_var_path = "/coupon-book-definitions/{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?

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

#update_coupon_book_definition(coupon_book_definition, opts = {}) ⇒ CouponBookDefinitionPagedMetadata

Update a coupon-book-definition. a book definition","request":"updateCouponBookDefinitionRequest.html","response":"updateCouponBookDefinitionResponse.html"

Parameters:

  • coupon_book_definition —

    The coupon-book-definition object to be updated.

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

    the optional parameters

Returns:



343
344
345
346
 
# File 'lib/bf_ruby2/api/couponbookdefinition_api.rb', line 343

def update_coupon_book_definition(coupon_book_definition, opts = {})
  data, _status_code, _headers = update_coupon_book_definition_with_http_info(coupon_book_definition, opts)
  return data
end

#update_coupon_book_definition_with_http_info(coupon_book_definition, opts = {}) ⇒ Array<(CouponBookDefinitionPagedMetadata, Fixnum, Hash)>

Update a coupon-book-definition. a book definition&quot;,&quot;request&quot;:&quot;updateCouponBookDefinitionRequest.html&quot;,&quot;response&quot;:&quot;updateCouponBookDefinitionResponse.html&quot;

Parameters:

  • coupon_book_definition —

    The coupon-book-definition object to be updated.

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

    the optional parameters

Returns:



353
354
355
356
357
358
359
360
361
362
363
364
365
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
 
# File 'lib/bf_ruby2/api/couponbookdefinition_api.rb', line 353

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

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