Class: BillForward::CouponmodifierApi
- Inherits:
-
Object
- Object
- BillForward::CouponmodifierApi
- Defined in:
- lib/bf_ruby2/api/couponmodifier_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_coupon_modifier(coupon_instance, opts = {}) ⇒ CouponModifierBasePagedMetadata
Create a coupon-modifier.
-
#create_coupon_modifier_with_http_info(coupon_instance, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>
Create a coupon-modifier.
-
#delete_coupon_modifier(coupon_modifier_id, opts = {}) ⇒ CouponModifierBasePagedMetadata
Retire a coupon-modifier, specified by the coupon-modifier-ID parameter.
-
#delete_coupon_modifier_with_http_info(coupon_modifier_id, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>
Retire a coupon-modifier, specified by the coupon-modifier-ID parameter.
-
#get_all_coupon_modifiers(opts = {}) ⇒ CouponModifierBasePagedMetadata
Returns a collection of coupon-modifiers.
-
#get_all_coupon_modifiers_with_http_info(opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>
Returns a collection of coupon-modifiers.
-
#get_coupon_modifier_by_coupon_code(coupon_code, opts = {}) ⇒ CouponModifierBasePagedMetadata
Returns a collection of coupon-modifiers, specified by the coupon-code parameter.
-
#get_coupon_modifier_by_coupon_code_with_http_info(coupon_code, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>
Returns a collection of coupon-modifiers, specified by the coupon-code parameter.
-
#get_coupon_modifier_by_coupon_definition_id(coupon_definition_id, opts = {}) ⇒ CouponModifierBasePagedMetadata
Returns a collection of coupon-modifiers, specified by the coupon-definition-ID parameter.
-
#get_coupon_modifier_by_coupon_definition_id_with_http_info(coupon_definition_id, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>
Returns a collection of coupon-modifiers, specified by the coupon-definition-ID parameter.
-
#get_coupon_modifier_by_id(coupon_modifier_id, opts = {}) ⇒ CouponModifierBasePagedMetadata
Returns a single coupon-modifier, specified by the coupon-modifier-ID parameter.
-
#get_coupon_modifier_by_id_with_http_info(coupon_modifier_id, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>
Returns a single coupon-modifier, specified by the coupon-modifier-ID parameter.
-
#initialize(api_client = ApiClient.default) ⇒ CouponmodifierApi
constructor
A new instance of CouponmodifierApi.
-
#update_coupon_modifier(coupon_instance, opts = {}) ⇒ CouponModifierBasePagedMetadata
Update a coupon-instance.
-
#update_coupon_modifier_with_http_info(coupon_instance, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>
Update a coupon-instance.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ CouponmodifierApi
Returns a new instance of CouponmodifierApi.
30 31 32 |
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 30 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
28 29 30 |
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 28 def api_client @api_client end |
Instance Method Details
#create_coupon_modifier(coupon_instance, opts = {}) ⇒ CouponModifierBasePagedMetadata
Create a coupon-modifier. a new modifier","request":"createCouponModifierRequest.html","response":"createCouponModifierResponse.html"
39 40 41 42 |
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 39 def create_coupon_modifier(coupon_instance, opts = {}) data, _status_code, _headers = create_coupon_modifier_with_http_info(coupon_instance, opts) return data end |
#create_coupon_modifier_with_http_info(coupon_instance, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>
Create a coupon-modifier. a new modifier","request":"createCouponModifierRequest.html","response":"createCouponModifierResponse.html"
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 49 def create_coupon_modifier_with_http_info(coupon_instance, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CouponmodifierApi.create_coupon_modifier ..." end # verify the required parameter 'coupon_instance' is set fail ArgumentError, "Missing the required parameter 'coupon_instance' when calling CouponmodifierApi.create_coupon_modifier" if coupon_instance.nil? # resource path local_var_path = "/coupon-modifiers".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['text/xml', 'application/xml', 'application/json; charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(coupon_instance) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CouponModifierBasePagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: CouponmodifierApi#create_coupon_modifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_coupon_modifier(coupon_modifier_id, opts = {}) ⇒ CouponModifierBasePagedMetadata
Retire a coupon-modifier, specified by the coupon-modifier-ID parameter. a modifier","response":"deleteCouponModifierByID.html"
97 98 99 100 |
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 97 def delete_coupon_modifier(coupon_modifier_id, opts = {}) data, _status_code, _headers = delete_coupon_modifier_with_http_info(coupon_modifier_id, opts) return data end |
#delete_coupon_modifier_with_http_info(coupon_modifier_id, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>
Retire a coupon-modifier, specified by the coupon-modifier-ID parameter. a modifier","response":"deleteCouponModifierByID.html"
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 108 def delete_coupon_modifier_with_http_info(coupon_modifier_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CouponmodifierApi.delete_coupon_modifier ..." end # verify the required parameter 'coupon_modifier_id' is set fail ArgumentError, "Missing the required parameter 'coupon_modifier_id' when calling CouponmodifierApi.delete_coupon_modifier" if coupon_modifier_id.nil? # resource path local_var_path = "/coupon-modifiers/{coupon-modifier-ID}".sub('{format}','json').sub('{' + 'coupon-modifier-ID' + '}', coupon_modifier_id.to_s) # query parameters query_params = {} query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json; charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['text/plain'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CouponModifierBasePagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: CouponmodifierApi#delete_coupon_modifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_all_coupon_modifiers(opts = {}) ⇒ CouponModifierBasePagedMetadata
Returns a collection of coupon-modifiers. By default 10 values are returned. Records are returned in natural order. all modifiers","response":"getCouponModifierAll.html"
158 159 160 161 |
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 158 def get_all_coupon_modifiers(opts = {}) data, _status_code, _headers = get_all_coupon_modifiers_with_http_info(opts) return data end |
#get_all_coupon_modifiers_with_http_info(opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>
Returns a collection of coupon-modifiers. By default 10 values are returned. Records are returned in natural order. all modifiers","response":"getCouponModifierAll.html"
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/couponmodifier_api.rb', line 170 def get_all_coupon_modifiers_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CouponmodifierApi.get_all_coupon_modifiers ..." end # resource path local_var_path = "/coupon-modifiers".sub('{format}','json') # query parameters query_params = {} query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json; charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = [] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CouponModifierBasePagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: CouponmodifierApi#get_all_coupon_modifiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_coupon_modifier_by_coupon_code(coupon_code, opts = {}) ⇒ CouponModifierBasePagedMetadata
Returns a collection of coupon-modifiers, specified by the coupon-code parameter. by coupon code","response":"getCouponCode.html"
221 222 223 224 |
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 221 def get_coupon_modifier_by_coupon_code(coupon_code, opts = {}) data, _status_code, _headers = get_coupon_modifier_by_coupon_code_with_http_info(coupon_code, opts) return data end |
#get_coupon_modifier_by_coupon_code_with_http_info(coupon_code, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>
Returns a collection of coupon-modifiers, specified by the coupon-code parameter. by coupon code","response":"getCouponCode.html"
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 |
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 234 def get_coupon_modifier_by_coupon_code_with_http_info(coupon_code, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CouponmodifierApi.get_coupon_modifier_by_coupon_code ..." end # verify the required parameter 'coupon_code' is set fail ArgumentError, "Missing the required parameter 'coupon_code' when calling CouponmodifierApi.get_coupon_modifier_by_coupon_code" if coupon_code.nil? # resource path local_var_path = "/coupon-modifiers/coupon-code/{coupon-code}".sub('{format}','json').sub('{' + 'coupon-code' + '}', coupon_code.to_s) # query parameters query_params = {} query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json; charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['text/plain'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CouponModifierBasePagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: CouponmodifierApi#get_coupon_modifier_by_coupon_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_coupon_modifier_by_coupon_definition_id(coupon_definition_id, opts = {}) ⇒ CouponModifierBasePagedMetadata
Returns a collection of coupon-modifiers, specified by the coupon-definition-ID parameter. by coupon definition","response":"getCouponModifierByCouponDefinitionID.html"
285 286 287 288 |
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 285 def get_coupon_modifier_by_coupon_definition_id(coupon_definition_id, opts = {}) data, _status_code, _headers = get_coupon_modifier_by_coupon_definition_id_with_http_info(coupon_definition_id, opts) return data end |
#get_coupon_modifier_by_coupon_definition_id_with_http_info(coupon_definition_id, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>
Returns a collection of coupon-modifiers, specified by the coupon-definition-ID parameter. by coupon definition","response":"getCouponModifierByCouponDefinitionID.html"
296 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 337 |
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 296 def get_coupon_modifier_by_coupon_definition_id_with_http_info(coupon_definition_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CouponmodifierApi.get_coupon_modifier_by_coupon_definition_id ..." end # verify the required parameter 'coupon_definition_id' is set fail ArgumentError, "Missing the required parameter 'coupon_definition_id' when calling CouponmodifierApi.get_coupon_modifier_by_coupon_definition_id" if coupon_definition_id.nil? # resource path local_var_path = "/coupon-modifiers/coupon-definition/{coupon-definition-ID}".sub('{format}','json').sub('{' + 'coupon-definition-ID' + '}', coupon_definition_id.to_s) # query parameters query_params = {} query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json; charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['text/plain'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CouponModifierBasePagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: CouponmodifierApi#get_coupon_modifier_by_coupon_definition_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_coupon_modifier_by_id(coupon_modifier_id, opts = {}) ⇒ CouponModifierBasePagedMetadata
Returns a single coupon-modifier, specified by the coupon-modifier-ID parameter. existing modifier","response":"getCouponModifierByID.html"
345 346 347 348 |
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 345 def get_coupon_modifier_by_id(coupon_modifier_id, opts = {}) data, _status_code, _headers = get_coupon_modifier_by_id_with_http_info(coupon_modifier_id, opts) return data end |
#get_coupon_modifier_by_id_with_http_info(coupon_modifier_id, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>
Returns a single coupon-modifier, specified by the coupon-modifier-ID parameter. existing modifier","response":"getCouponModifierByID.html"
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 392 393 394 395 396 397 |
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 356 def get_coupon_modifier_by_id_with_http_info(coupon_modifier_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CouponmodifierApi.get_coupon_modifier_by_id ..." end # verify the required parameter 'coupon_modifier_id' is set fail ArgumentError, "Missing the required parameter 'coupon_modifier_id' when calling CouponmodifierApi.get_coupon_modifier_by_id" if coupon_modifier_id.nil? # resource path local_var_path = "/coupon-modifiers/{coupon-modifier-ID}".sub('{format}','json').sub('{' + 'coupon-modifier-ID' + '}', coupon_modifier_id.to_s) # query parameters query_params = {} query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json; charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['text/plain'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CouponModifierBasePagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: CouponmodifierApi#get_coupon_modifier_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_coupon_modifier(coupon_instance, opts = {}) ⇒ CouponModifierBasePagedMetadata
Update a coupon-instance. a modifier","request":"updateCouponInstanceRequest.html","response":"updateCouponInstanceResponse.html"
404 405 406 407 |
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 404 def update_coupon_modifier(coupon_instance, opts = {}) data, _status_code, _headers = update_coupon_modifier_with_http_info(coupon_instance, opts) return data end |
#update_coupon_modifier_with_http_info(coupon_instance, opts = {}) ⇒ Array<(CouponModifierBasePagedMetadata, Fixnum, Hash)>
Update a coupon-instance. a modifier","request":"updateCouponInstanceRequest.html","response":"updateCouponInstanceResponse.html"
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 |
# File 'lib/bf_ruby2/api/couponmodifier_api.rb', line 414 def update_coupon_modifier_with_http_info(coupon_instance, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: CouponmodifierApi.update_coupon_modifier ..." end # verify the required parameter 'coupon_instance' is set fail ArgumentError, "Missing the required parameter 'coupon_instance' when calling CouponmodifierApi.update_coupon_modifier" if coupon_instance.nil? # resource path local_var_path = "/coupon-modifiers".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['text/xml', 'application/xml', 'application/json; charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(coupon_instance) auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CouponModifierBasePagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: CouponmodifierApi#update_coupon_modifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |