Preparing search index...
The search index is not available
programs
programs
Usher Campaigns
CampaignsApi
Class CampaignsApi
Hierarchy
Api
CampaignsApi
Index
Constructors
constructor
Methods
campaigns
get
Auth
Request
get
Request
Constructors
constructor
new
Campaigns
Api
(
options
?:
Partial
<
ApiOptions
>
)
:
CampaignsApi
Parameters
Optional
options:
Partial
<
ApiOptions
>
Returns
CampaignsApi
Methods
campaigns
campaigns
(
)
:
{
get
(
references
?:
CampaignReference
|
CampaignReference
[]
)
:
Promise
<
{
data
:
Campaign
[]
;
success
:
boolean
;
}
>
;
index
(
id
:
string
)
:
Promise
<
{
campaign
:
Campaign
;
success
:
boolean
;
}
>
;
}
Returns
{
get
(
references
?:
CampaignReference
|
CampaignReference
[]
)
:
Promise
<
{
data
:
Campaign
[]
;
success
:
boolean
;
}
>
;
index
(
id
:
string
)
:
Promise
<
{
campaign
:
Campaign
;
success
:
boolean
;
}
>
;
}
get
:
function
get
(
references
?:
CampaignReference
|
CampaignReference
[]
)
:
Promise
<
{
data
:
Campaign
[]
;
success
:
boolean
;
}
>
Parameters
Optional
references:
CampaignReference
|
CampaignReference
[]
Returns
Promise
<
{
data
:
Campaign
[]
;
success
:
boolean
;
}
>
index
:
function
index
(
id
:
string
)
:
Promise
<
{
campaign
:
Campaign
;
success
:
boolean
;
}
>
Parameters
id:
string
Returns
Promise
<
{
campaign
:
Campaign
;
success
:
boolean
;
}
>
Protected
get
Auth
Request
get
Auth
Request
(
authToken
:
string
)
:
KyInstance
Parameters
authToken:
string
Returns
KyInstance
Protected
get
Request
get
Request
(
)
:
KyInstance
Returns
KyInstance
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
programs
Usher
Auth
Usher
Campaigns
Usher
Datamodels
Usher
Partnerships
Usher
Shared
Facets
Campaigns
Api
constructor
campaigns
get
Auth
Request
get
Request
Generated using
TypeDoc