Class: VoucherifySdk::RewardsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/VoucherifySdk/api/rewards_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RewardsApi

Returns a new instance of RewardsApi.



19
20
21
 
# File 'lib/VoucherifySdk/api/rewards_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/VoucherifySdk/api/rewards_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_reward(opts = {}) ⇒ RewardsCreateResponseBody

Create Reward Create a new reward.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



27
28
29
30
 
# File 'lib/VoucherifySdk/api/rewards_api.rb', line 27

def create_reward(opts = {})
  data, _status_code, _headers = create_reward_with_http_info(opts)
  data
end

#create_reward_assignment(reward_id, opts = {}) ⇒ RewardsAssignmentsCreateResponseBody

Create Reward Assignment Assigns a reward to a specified loyalty campaign.

Parameters:

  • reward_id (String) —

    A unique reward ID.

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

    the optional parameters

Options Hash (opts):

  • :rewards_assignments_create_request_body (RewardsAssignmentsCreateRequestBody) —

    Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points.

Returns:



92
93
94
95
 
# File 'lib/VoucherifySdk/api/rewards_api.rb', line 92

def create_reward_assignment(reward_id, opts = {})
  data, _status_code, _headers = create_reward_assignment_with_http_info(reward_id, opts)
  data
end

#delete_reward(reward_id, opts = {}) ⇒ nil

Delete Reward Delete a reward.

Parameters:

  • reward_id (String) —

    A unique reward ID.

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

    the optional parameters

Returns:

  • (nil) 


157
158
159
160
 
# File 'lib/VoucherifySdk/api/rewards_api.rb', line 157

def delete_reward(reward_id, opts = {})
  delete_reward_with_http_info(reward_id, opts)
  nil
end

#delete_reward_assignment(reward_id, assignment_id, opts = {}) ⇒ nil

Delete Reward Assignment This method deletes a reward assignment for a particular reward.

Parameters:

  • reward_id (String) —

    A unique reward ID.

  • assignment_id (String) —

    A unique reward assignment ID.

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

    the optional parameters

Returns:

  • (nil) 


215
216
217
218
 
# File 'lib/VoucherifySdk/api/rewards_api.rb', line 215

def delete_reward_assignment(reward_id, assignment_id, opts = {})
  delete_reward_assignment_with_http_info(reward_id, assignment_id, opts)
  nil
end

#get_reward(reward_id, opts = {}) ⇒ Reward

Get Reward Retrieve a reward by the reward ID.

Parameters:

  • reward_id (String) —

    A unique reward ID.

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

    the optional parameters

Returns:



273
274
275
276
 
# File 'lib/VoucherifySdk/api/rewards_api.rb', line 273

def get_reward(reward_id, opts = {})
  data, _status_code, _headers = get_reward_with_http_info(reward_id, opts)
  data
end

#get_reward_assignment(reward_id, assignment_id, opts = {}) ⇒ RewardsAssignmentsGetResponseBody

Get Reward Assignment Retrieve a reward assignment.

Parameters:

  • reward_id (String) —

    A unique reward ID.

  • assignment_id (String) —

    A unique reward assignment ID.

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

    the optional parameters

Returns:



333
334
335
336
 
# File 'lib/VoucherifySdk/api/rewards_api.rb', line 333

def get_reward_assignment(reward_id, assignment_id, opts = {})
  data, _status_code, _headers = get_reward_assignment_with_http_info(reward_id, assignment_id, opts)
  data
end

#list_reward_assignments(reward_id, opts = {}) ⇒ RewardsAssignmentsListResponseBody

List Reward Assignments Retrieve reward assignments by the reward ID.

Parameters:

  • reward_id (String) —

    A unique reward ID.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

  • :page (Integer) —

    Which page of results to return. The lowest value is 1.

Returns:



395
396
397
398
 
# File 'lib/VoucherifySdk/api/rewards_api.rb', line 395

def list_reward_assignments(reward_id, opts = {})
  data, _status_code, _headers = list_reward_assignments_with_http_info(reward_id, opts)
  data
end

#list_rewards(opts = {}) ⇒ RewardsListResponseBody

List Rewards Retrieve rewards.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

  • :page (Integer) —

    Which page of results to return. The lowest value is 1.

  • :assignment_id (String) —

    A unique reward assignment ID. Use this parameter to get the reward details in the context of an assignment ID.

Returns:



460
461
462
463
 
# File 'lib/VoucherifySdk/api/rewards_api.rb', line 460

def list_rewards(opts = {})
  data, _status_code, _headers = list_rewards_with_http_info(opts)
  data
end

#update_reward(reward_id, opts = {}) ⇒ RewardsUpdateResponseBody

Update Reward Update the details of a reward.

Parameters:

  • reward_id (String) —

    A unique reward ID.

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

    the optional parameters

Options Hash (opts):

Returns:



525
526
527
528
 
# File 'lib/VoucherifySdk/api/rewards_api.rb', line 525

def update_reward(reward_id, opts = {})
  data, _status_code, _headers = update_reward_with_http_info(reward_id, opts)
  data
end

#update_reward_assignment(reward_id, assignment_id, opts = {}) ⇒ RewardsAssignmentsUpdateResponseBody

Update Reward Assignment Update the number of points needed to successfully redeem the reward.

Parameters:

  • reward_id (String) —

    A unique reward ID.

  • assignment_id (String) —

    A unique reward assignment ID.

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

    the optional parameters

Options Hash (opts):

Returns:



592
593
594
595
 
# File 'lib/VoucherifySdk/api/rewards_api.rb', line 592

def update_reward_assignment(reward_id, assignment_id, opts = {})
  data, _status_code, _headers = update_reward_assignment_with_http_info(reward_id, assignment_id, opts)
  data
end