actions/affiliates

Affiliates Actions Channel

Parameters:

Name	Type	Description
`config`	Object
`services`	Object
`emit`	function

Returns:

Type: function

Methods

(inner) claimAffiliateEarnings(params) → {Object}

Clain the users's affiliate earnings

Parameters:

Name	Type	Description
`params`	Object

Returns:

receipt

Type: Object

(inner) claimMyRevsharePayout(params) → {Object}

Claim revshare payout (isStreamer)

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`id`	String
`payoutid`	String
`currency`	String

Returns:

receipt

Type: Object

(inner) createAffiliateCampaign(params) → {Object}

Create a new affiliate campaign

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`code`	String
`duration`	String
`type`	String

Returns:

Type: Object

(inner) endAffiliateCampaign(params) → {Object}

End a campaign

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`code`	String

Returns:

Type: Object

(inner) getAffiliateConfig(params) → {Object}

Get affiliate configuration

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`gamename`	String

Returns:

Type: Object

(inner) isRevshareEnabled(params) → {Array}

Get affiliate configuration

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Default	Description
`start`	Integer	`0`
`end`	Integer	`Date.now()`
`skip`	Integer	`0`	number of documents to skip
`limit`	Integer	`100`	maximum documents to return

Returns:

list of catalog entries

Type: Array

(inner) joinAffiliateCampaign(params) → {Object}

Join a players affiliate campign

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`code`	String

Returns:

Type: Object

(inner) listAffiliateCampaigns(params) → {Array}

Get affiliate configuration

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Attributes	Default	Description
`version`	String	<optional>	`"v2"`
`sortKey`	String	<optional>	`"commissionUsd"`
`start`	Integer	<optional>	`0`
`end`	Integer	<optional>	`Date.now()`
`skip`	Integer	<optional>	`0`	number of documents to skip
`limit`	Integer	<optional>	`100`	maximum documents to return

Returns:

list of affiliate campaigns

Type: Array

(inner) listMyAffiliates(params) → {Array}

List the user's referrals

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Attributes	Default	Description
`campaign`	String
`version`	String	<optional>	`"v2"`
`sortKey`	String	<optional>	`"commissionUsd"`
`start`	Integer	<optional>	`0`
`end`	Integer	<optional>	`Date.now()`
`skip`	Integer	<optional>	`0`	number of documents to skip
`limit`	Integer	<optional>	`100`	maximum documents to return

Returns:

list of catalog entries

Type: Array

(inner) listMyRevsharePayouts(params) → {Array}

List revshare payouts (isStreamer)

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Default	Description
`skip`	Integer	`0`	number of documents to skip
`limit`	Integer	`100`	maximum documents to return

Returns:

list of revshare payouts

Type: Array

(inner) myAffiliateFunds(params) → {Object}

Get information about the users affiliate funds

Parameters:

Name	Type	Description
`params`	Object

Returns:

memo

Type: Object