Global

Methods

#createEvent(payload) → {object}

createEvent function

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userId to event
title string

title of event
startDate string

startDate of event
endDate string

endDate of event
publishDate string

publishDate of event
promotionalVideoEmbedCode string

publishDate of event
generalCapacity string

generalCapacity of event
vipCapacity string

vipCapacity of event
generalTicketPrice string

generalTicketPrice of event
vipTicketPrice string

vipTicketPrice of event
archiveDate string

archiveDate of event
eventType string

eventType of event
visibility boolean

visibility of event (isPrivate)
streamType string

streamType of event (vimeo, youtube, etc)
shopUrl string

shopUrl of event
learnmoreUrl string

learnmoreUrl of event
availableLanguages Array

availableLanguages of event
countDownDisplay boolean

event has countdown or not
eventGroupEventsAttributes Array

eventGroupEventsAttributes of event
Source:
Returns:

{ id, type, name, location, startDate, endDate, promotionalVideoEmbedCode, state, userId, tenantId, liveStreamName, broadcasted, streamType, shopUrl, learnmoreUrl, eventType, shareUrl, eventImageUrl, host, eventGroupEventsAttributes }

Type
object
Example
createEvent({
      userId,
      title,
      startDate,
      endDate,
      publishDate,
      promotionalVideoEmbedCode,
      generalCapacity,
      vipCapacity,
      generalTicketPrice,
      vipTicketPrice,
      archiveDate,
      eventType,
      isPrivate,
      streamType,
      shopUrl,
      learnmoreUrl,
      availableLanguages,
      countDownDisplay,
      eventGroupEventsAttributes
    })

associateEventSpeaker(payload) → {EventSpeaker}

Parameters:
Name Type Description
payload object

The eventSpeaker payload

Properties
Name Type Attributes Description
eventId number

event id
kwivrrId number <optional>

associate by user id if exists, otherwise, check for speaker profile id
speakerProfileId number <optional>

associate by speaker_profile_id (fallthrough if kwivrrId not provided)
topic string

topic speaker is covering
description string

more detailed description of topic
startTime string

when speaker goes on
endTime string

when speaker's session is over
Source:
Returns:
  • EventSpeaker instance
Type
EventSpeaker
Example
associateEventSpeaker({
  eventId: 100,
  speakerProfileId: 6,
  topic:"9d3fjpsarasdgywm7lj8snq5pr39e3",
  description:"5zbn5idwlpvbg3miqidwwm2pvkxohm",
  startTime:"2021-07-07T07:39:05.797-05:00",
  endTime:"2021-07-09T07:39:05.797-05:00"
})

banEventAttendee(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
eventId number

event id
userId number

userId to ban
Source:
Returns:
Type
void
Example
banEventAttendee({
  eventId: 81818
  userId: 222
})

blockEventAttendee(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
eventId number

event id
userId number

user id
Source:
Returns:
Type
void
Example
blockEventAttendee({
  eventId: 1127,
  userId: 3
})

calculateCartTotals(payload) → {CartTotals}

Parameters:
Name Type Description
payload object

ticket info payload

Properties
Name Type Description
gaTicketPrice number

price of a general ticket
gaTicketCount number

how many ga tickets
vipTicketPrice number

price of a vip ticket
vipTicketCount number

how many vip tickets
Source:
Returns:

cart totals

Type
CartTotals
Example
calculateCartTotals({
 vipTicketCount: 5,
 vipTicketPrice: 10,
 gaTicketCount: 1,
 gaTicketPrice: 3
})

calculateServiceFee(payload) → {number}

Parameters:
Name Type Description
payload object

ticket info payload

Properties
Name Type Description
gaTicketPrice number

price of a general ticket
gaTicketCount number

how many ga tickets
vipTicketPrice number

price of a vip ticket
vipTicketCount number

how many vip tickets
Source:
Returns:

service fee for cart

Type
number
Example
calculateServiceFee({
 vipTicketCount: 5,
 vipTicketPrice: 10,
 gaTicketCount: 1,
 gaTicketPrice: 3
})

checkinPhysicalEventTicket(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
id number

ticket id
credentialsId number

credentials to tag the ticket with
Source:
Returns:
Type
void
Example
checkinPhysicalEventTicket({
  id: 2,
  credentialsId: 894848
})

checkinVirtualEventTicket(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
id number

ticket id
Source:
Returns:
Type
void
Example
checkinVirtualEventTicket({
  id: 2
})

claimEventTicket(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
id number

ticket id
giftToken string

token needed to claim ticket
Source:
Returns:
Type
void
Example
claimEventTicket({
  id: 2,
  giftToken: '282828282asdfdsafjalsdfj8'
})

cloneEvent(payload) → {Event}

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

user to assign cloned event to
id number

event id
title string

title for cloned event
Source:
Returns:
  • new Event object
Type
Event

createAccountManager(payload) → {AccountManager}

Parameters:
Name Type Description
payload object

The event wait list payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign
Source:
Returns:

accountManager object

Type
AccountManager
Example
createEventWaitList({
  userId: 'me',
  eventId: 100
})

createCreditCard(payload) → {CreditCard}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign
nameOnCard string

name on card
cardNumber string

credit card number
expirationMonth number

exp month
expirationYear number

exp year
ccv number

card ccv
cardType string

visa/mc/discover/amex card type
address Address

address object
isDefault boolean

whether or not default
Source:
Returns:
  • new credit card entity
Type
CreditCard
Example
createCreditCard({
  nameOnCard: 'Primary Checking',
  cardNumber: 'Joe Jones',
  expirationMonth: '1212121212121',
  expirationYear: '123444332422223'
  ccv: '123444332422223'
  cardType: '123444332422223'
  address: {
    line1: '123 foo street',
    city: 'Flavortown',
    state: 'ID',
    country: 'US',
    zipCode: '83842'
  }
})

createECheck(payload) → {BankAccount}

Parameters:
Name Type Description
payload object

The eCheck payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign this echeck
nickname string <optional>

nickname for account
accountHolderName string

name of account holder
routingNumber string

routing number of account
accountNumber string

account number of account
isDefault boolean

whether or not default
Source:
Returns:
  • new bank account entitty
Type
BankAccount
Example
createECheck({
  nickname: 'Primary Checking',
  accountHolderName: 'Joe Jones',
  routingNumber: '1212121212121',
  accountNumber: '123444332422223'
})

createEventGroup(payload) → {EventGroup}

Parameters:
Name Type Description
payload object

The event group payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

user id
title string

title of group
Source:
Returns:
  • event group
Type
EventGroup
Example
createEventGroup({
  title: 'test'
})

createEventInterest(payload) → {void}

Parameters:
Name Type Description
payload object

The event interest payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign
id number

event id
Source:
Returns:
Type
void
Example
createEventInterest({
  eventId: 100
})

createEventManager(payload) → {EventManager}

Parameters:
Name Type Description
payload object

The event watch payload

Properties
Name Type Description
eventId number

event id
userId number

userId of the manager to assign
role string

enum('ticket_taker', 'basic_cs')
Source:
Returns:
  • event manager object
Type
EventManager
Example
createEventManager({
  eventId: 1127,
  userId: 2838,
  role: 'ticket_taker'
})

createEventMessage(payload) → {void}

Parameters:
Name Type Description
payload object

The event message payload

Properties
Name Type Description
eventId number

id of the event
message string

message to send
Source:
Returns:
Type
void
Example
createEventMessage({
  eventId: 1000,
  message: "Hi Wington!"
})

createEventWaitList(payload) → {void}

Parameters:
Name Type Description
payload object

The event wait list payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign
id number

event id
Source:
Returns:
Type
void
Example
createEventWaitList({
  eventId: 100
})

createEventWatch(payload) → {EventWatch}

Parameters:
Name Type Description
payload object

The event watch payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign
eventId number

event to watch
Source:
Returns:
Type
EventWatch
Example
createEventWatch({
  eventId: 100
})

createFeaturedItem(payload) → {FeaturedItem}

Parameters:
Name Type Description
payload object

The featured item payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign
title string

title
sortingWeight string <optional>
 0

lighter is earlier in list
description string <optional>
 'n/a'

description (we don't use it)
price number

price of item
url string

url to link to
imageUrl string <optional>

product image url
imageBase64 string <optional>

product image base64 (one of this or imageUrl is required)
Source:
Returns:
Type
FeaturedItem
Example
createFeaturedItem({
  title: 'Brown Socks',
  price: 100,
  url: 'https://amazon.com/blah',
  price: 20.00,
  imageUrl: 'https://reallycoolimage.com/home.jpg'
})

createPayoutMethod(payload) → {PayoutMethod}

Parameters:
Name Type Description
payload object

The user payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

user id
provider string

Venmo vs CashApp
externalId string

User identifier
externalIdType string

Type of identifier
isDefault boolean

whether or not it's the default payment
Source:
Returns:
  • payout method
Type
PayoutMethod
Example
createPayoutMethod({
  provider: 'venmo',
  externalId: 'andy123',
  externalIdType: 'username',
  isDefault: false
})

createPrivacySettings(payload) → {PrivacySettings}

Parameters:
Name Type Description
payload object

the payload -- should include 1 or more privacy settings

Properties
Name Type Attributes Default Description
id string <optional>
 'me'

user id to assign preferences
showFollowees boolean <optional>

show followees?
showEventsAttending boolean <optional>

show events attending?
showEventsAttended boolean <optional>

show events previously attended?
showInUserSearch boolean <optional>

should user show in user search results?
showInSpeakerSearch boolean <optional>

should user show in speaker search results?
Source:
Returns:
  • Privacy Settings object
Type
PrivacySettings
Example
createPrivacySettings({
  showFollowees: true
})

createSpeakerProfile(payload) → {SpeakerProfile}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

user id
name string

speaker's name
email string

speaker's email
about string

about the speaker
avatarUrl string <optional>

avatar image url
avatarBase64 string <optional>

uploaded avatar image (takes precedent over avatarUrl)
Source:
Returns:
  • speaker profile object
Type
SpeakerProfile
Example
createSpeakerProfile({
  name: 'Mitch Cain',
  email: 'mitch.cain@icentris.com',
  about: 'password',
  avatarUrl: 'https://imgur.com/coolphoto.jpg'
})

createTicketingType(payload) → {TicketingType}

Parameters:
Name Type Description
payload object

TicketingType payload

Properties
Name Type Description
eventId number

event id
name string

name of ticketing type
capacity number

number of ticketing type available
price number

price of ticketing type
description string

more detailed description of ticketing type
Source:
Returns:
  • TicketingType instance
Type
TicketingType
Example
createTicketingType({
  eventId: 10,
  name: 'VIP',
  capacity: 1000,
  price: 500,
  description: "Special backstage pass"
})

createUser(payload) → {CreateUserReturn}

Parameters:
Name Type Description
payload object

The user payload

Properties
Name Type Attributes Default Description
firstName string

first name of user
lastName string

last name of user
email string

email address of user
password string

password for user
withLogin boolean <optional>
 true

should we also log the new user in?
Source:
Returns:
  • loggedIn user
Type
CreateUserReturn
Example
createUser({
  firstName: 'Joe',
  lastName: 'Blow',
  email: 'joe@foo.com',
  password: '1234'
})

createUserPreferences(payload) → {UserPreferences}

Parameters:
Name Type Description
payload object

the payload -- should include 1 or more preferences

Properties
Name Type Attributes Default Description
id string <optional>
 'me'

user id to assign preferences
registeredEventStart boolean <optional>

notify user when event starts?
registeredEvent1HourBefore boolean <optional>

notify user 1 hour before event starts?
registeredEvent24HoursBefore boolean <optional>

notify 24 hours before?
registeredEventIsLive boolean <optional>

notify right when event goes live?
Source:
Returns:
  • UserPreferences object
Type
UserPreferences
Example
createUserPreferences({
  registeredEventStart: true
})

deleteAccountManager(payload) → {void}

Parameters:
Name Type Description
payload object

The account manager payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign
id object

The account manager id
Source:
Returns:
Type
void
Example
deleteAccountManager({
  userId: 'me',
  id: 100
})

deleteAccountManagerAssignment(payload) → {void}

Parameters:
Name Type Description
payload object

The event watch payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign
id number

account manager assignment id
Source:
Returns:
Type
void
Example
deleteAccountManagerAssignment({
  userId: 'me',
  id: 1
})

deleteCreditCard(payload)

Parameters:
Name Type Description
payload object

The creditCard payload

Properties
Name Type Attributes Default Description
userId number | string <optional>
 'me'

userid to assign this echeck
id number

creditCard id
Source:
Example
deleteCreditCard({
  id: 1234
})

deleteECheck(payload) → {void}

Parameters:
Name Type Description
payload object

The eCheck payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign this echeck
id number

eCheck id
Source:
Returns:
Type
void
Example
deleteECheck({
  id: 1234
})

deleteEvent(payload) → {void}

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userId tied to event
id string

id of event
Source:
Returns:
Type
void
Example
deleteEvent({
  id: 123
})

deleteEventGroup(payload) → {void}

Parameters:
Name Type Description
payload object

The event group payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

user id
id number

event group id
Source:
Returns:
Type
void
Example
deleteEventGroup({
  id: 123
})

deleteEventInterest(payload) → {void}

Parameters:
Name Type Description
payload object

The event interest payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign
id number

event id
Source:
Returns:
Type
void
Example
deleteEventInterest({
  eventId: 100
})

deleteEventManager(payload) → {void}

Parameters:
Name Type Description
payload object

The event manager payload

Properties
Name Type Description
eventId number

event id
userId number

userId to remove from event manager role
Source:
Returns:
Type
void
Example
deleteEventManager({
  eventId: 100,
  userId: 3838
})

deleteEventManager(payload) → {void}

Parameters:
Name Type Description
payload object

The event group payload

Properties
Name Type Description
eventId number

event id
userId number

event manager id
Source:
Returns:
Type
void
Example
deleteEventManager({
  eventId: 1,
  userId: 123
})

deleteEventWaitList(payload)

Parameters:
Name Type Description
payload object

The event wait list payloadeventId userId: 'me', id: 100 })
Source:

deleteEventWatch(payload) → {void}

Parameters:
Name Type Description
payload object

The event watch payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign
id number

event watch join id NOT event_id
Source:
Returns:
Type
void
Example
deleteEventWatch({
  id: 100
})

deleteFeaturedItem(payload) → {void}

Parameters:
Name Type Description
payload object

The featured item payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

user id
id number

featured item id
Source:
Returns:
Type
void
Example
deleteFeaturedItem({
  id: 123
})

deletePayoutMethod(payload) → {void}

Parameters:
Name Type Description
payload object

The user payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

user id
id number

payout method id
Source:
Returns:
Type
void
Example
deletePayoutMethod({
  id: 123
})

deleteSpeakerProfile(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

user id
id number

speaker profile id
Source:
Returns:
Type
void
Example
deleteSpeakerProfile({
  id: 1
})

deleteTicketingType(payload) → {void}

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Description
eventId number

event id
id number

ticketing type id
Source:
Returns:
Type
void
Example
deleteEvent({
  eventId: 100,
  id: 3838
})

deprovisionStream(payload) → {void}

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Description
id string

event id to start
Source:
Returns:
Type
void
Example
deprovisionStream({
  id: 11818
})

directTransferEventTicket(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
id number

ticket id
userId number

user to transfer ticket to
Source:
Returns:
Type
void
Example
directTransferEventTicket({
  id: 2,
  userId: 1503
})

disjoinEventSpeaker(payload) → {void}

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Description
eventId number

eventId speaker is assigned to
eventSpeakerJoinId string

event speaker join table id
Source:
Returns:
Type
void
Example
deleteEvent({
  eventId: 100,
  eventSpeakerJoinId: 3838
})

endEventStream(payload) → {void}

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Description
id string

event id to end
Source:
Returns:
Type
void
Example
endEventStream({
  id: 11818
})

follow(payload) → {void}

Parameters:
Name Type Description
payload object

The user payload

Properties
Name Type Description
userId string

user's id
Source:
Returns:
Type
void
Example
follow({
userId: 1948
})

getAccountManagerAssignments(payload) → {getAccountManagerAssignmentsReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign
page number <optional>
 1

page
Source:
Returns:
  • getAccountManagerAssignments return
Type
getAccountManagerAssignmentsReturn
Example
getAccountManagerAssignments({
  userId: 'me',
  page: 2
})

getAccountManagers(payload) → {getAccountManagersReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign
page number <optional>
 1

page
Source:
Returns:

getAccountManagersReturn

Type
getAccountManagersReturn
Example
getAccountManagers({
  page: 2
})

getAttendanceReport(payload) → {getAttendanceReportReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
searchTerm number

search term
startDate number

search start date
endDate number

search end date
page number <optional>
 1

page of results
Source:
Returns:
Type
getAttendanceReportReturn
Example
getAttendanceReport({
  searchTerm: 'Sam',
  startDate: null,
  endDate: null,
  page: 2
})

getClaimEventTicketDetails(payload) → {ClaimEventTicketDetails}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
id object

The ticket id
giftToken string

gift token hash tied to claim event
Source:
Returns:
  • getClaimEventTicketDetailsReturn
Type
ClaimEventTicketDetails
Example
getClaimEventTicketDetails({
  id: 123,
  giftToken: 223gfsdfger
})

getCreditBalance(payload) → {number}

Parameters:
Name Type Description
payload object

The eChecks payload

Properties
Name Type Attributes Default Description
id string <optional>
 'me'

userid to assign this echeck
Source:
Returns:
  • credit balance
Type
number
Example
getCreditBalance()

getECheck(payload)

Parameters:
Name Type Description
payload object

The eCheck payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign this echeck
id number

eCheck id
Source:
Example
getECheck({
       id: 1234
    })

getEChecks(payload) → {getEchecksReturn}

Parameters:
Name Type Description
payload object

The eChecks payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign this echeck
page number <optional>
 0

page of results
Source:
Returns:
  • array of echeck objects
Type
getEchecksReturn
Example
getEChecks({
       page: 0
    })

getEvent(payload) → {Event}

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Description
id number

eventId
Source:
Returns:
  • Event object
Type
Event
Example
getEvent({
  id: 100
})

getEventAttendeeCount(payload) → {number}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
eventId number

event id
Source:
Returns:
  • the current attendee count for the event
Type
number
Example
getEventAttendeeCount({
  eventId: 1127
})

getEventAttendees(payload) → {getEventAttendeesReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
eventId number

event ID
page number <optional>
 1

page
Source:
Returns:
  • attendee return
Type
getEventAttendeesReturn
Example
getEventAttendees({
  eventId: 1127,
  page: 2
})

getEventCalendar(payload) → {object}

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Attributes Description
userId string <optional>

userId to masquerade if needed
startDate string

start date of lookup range
endDate string

end date of lookup range
Source:
Returns:
  • object with date strings as keys and counts for that date
Type
object
Example
getEventCalendar({
  startDate: '2021-02-01'
  endDate: '2021-03-01'
})

getEventGroups() → {getEventGroupsReturn}

Source:
Returns:

getEventGroupsReturn

Type
getEventGroupsReturn
Example
getEventGroups()

getEventManagers(payload) → {getEventManagersReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
eventId string

event id
page number <optional>
 1

page
Source:
Returns:
  • getEventManagersReturn
Type
getEventManagersReturn
Example
getEventManagers({
  eventId: 1
})

getEventMessages(payload) → {getEventMessagesReturn}

Parameters:
Name Type Description
payload object

The payload object

Properties
Name Type Attributes Default Description
eventId number

event id
page number <optional>
 1

page of result set
Source:
Returns:

eventMessagesReturn

Type
getEventMessagesReturn
Example
getEventMessages({
  eventId: 123
})

getEventOverview(payload) → {EventOverview}

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Description
id number

event id
Source:
Returns:
  • Event overview detail
Type
EventOverview

getEvents(payload) → {getEventsReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
scope number

scope to limit returns to (completed, upcoming, attended, registeredFor)
page number <optional>
 1

page of results
selectedDate string <optional>

for ranged queries, start of range
Source:
Returns:
Type
getEventsReturn
Example
getEvents({
  scope: 'completed'
})

getEventsByUserId(payload) → {getEventsByUserIdReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
scope number

scope to limit returns to (attended, attending, hosted, hosting)
page number <optional>
 1

page of results
userId number <optional>

user's id
Source:
Returns:
Type
getEventsByUserIdReturn
Example
getEventsByUserId({
  scope: 'completed'
})

getEventServiceFees() → {Array.<EventServiceFeeTableRow>}

Source:
Returns:
  • row of service fee table
Type
Array.<EventServiceFeeTableRow>
Example
getEventServiceFees()

getEventServiceFeesSync() → {Array.<EventServiceFeeTableRow>}

Source:
Returns:
  • row of service fee table
Type
Array.<EventServiceFeeTableRow>
Example
getEventServiceFeesSync()

getEventSpeakers(payload) → {getEventSpeakersReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
id number

event id
page number <optional>
 1

result set page
Source:
Returns:
  • getEventSpeakersReturn
Type
getEventSpeakersReturn
Example
getEventSpeakers({
  page: 2
})

getEventSpeakers(payload) → {getEventSpeakersReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
id number

event id
page number <optional>
 1

result set page
Source:
Returns:
  • getEventSpeakersReturn
Type
getEventSpeakersReturn
Example
getEventSpeakers({
  id: 10,
  page: 2
})

getEventTicketHistory(payload) → {Array.<EventTicketHistoryEntry>}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
id number

ticket id
Source:
Returns:

entries

Type
Array.<EventTicketHistoryEntry>
Example
getEventTicketHistory({
  id: 2
})

getEventWaitList(payload) → {getEventWaitListReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign
page number <optional>
 1

page
Source:
Returns:
  • get waitlist
Type
getEventWaitListReturn
Example
getEventWaitList({
  page: 2
})

getEventWatches(payload) → {getEventWatchesReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign
page number <optional>
 1

page
Source:
Returns:
Type
getEventWatchesReturn
Example
getEventWatches({
  page: 2
})

getFeaturedItem(payload) → {FeaturedItem}

Parameters:
Name Type Description
payload object

The featured item payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign this echeck
id string

featured item id
Source:
Returns:
Type
FeaturedItem
Example
getFeaturedItem({
  id: 34
})

getFeaturedItems(payloadopt) → {Array.<FeaturedItem>}

Parameters:
Name Type Attributes Description
payload object <optional>

The featured item payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userid to assign this echeck
Source:
Returns:
Type
Array.<FeaturedItem>
Example
getFeaturedItem({
  id: 34
})

getFeeds(payload) → {getFeedsReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
scope number

scope to limit returns to (completed, upcoming, attended, registeredFor)
page number <optional>
 1

page of results
Source:
Returns:
Type
getFeedsReturn
Example
getFeeds({
  page: 2
})

getForMeEvents(payload) → {getForMeEventsReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
page number <optional>
 1

page of results
queryFilters number <optional>

filters options = [attending, hosting, live, interested]
Source:
Returns:
Type
getForMeEventsReturn
Example
getForMeEvents({
  filters: ['interested', 'attending']
})

getLanguages() → {Array.<Languages>}

Source:
Returns:
  • language return object
Type
Array.<Languages>
Example
getLanguages()

getLanguagesSync() → {Array.<Languages>}

Source:
Returns:
Type
Array.<Languages>
Example
getLanguagesSync()

getNotification(payload) → {object}

Parameters:
Name Type Description
payload object

The payload object

Properties
Name Type Description
id number

notification id
Source:
Returns:

notifications

Type
object
Example
getNotification({
  page: 1
})

getNotifications(payload) → {object}

Parameters:
Name Type Description
payload object

The payload object

Properties
Name Type Attributes Default Description
page number <optional>
 1

page of results
Source:
Returns:

notifications

Type
object
Example
getNotifications({
  page: 1
})

getPaymentChoices(payload) → {getPaymentChoicesReturn}

Parameters:
Name Type Description
payload object

The payload object

Properties
Name Type Attributes Default Description
page number <optional>
 1

page of result set
Source:
Returns:

searchUsersReturn

Type
getPaymentChoicesReturn
Example
getPaymentChoices({
  page: 1
})

getPayoutMethod(payload) → {PayoutMethod}

Parameters:
Name Type Description
payload object

The user payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

user id
id number

payout method id
Source:
Returns:
  • loggedIn user
Type
PayoutMethod
Example
getPayoutMethod({
  id: 123
})

getPayoutMethods(payload) → {getPayoutMethodsReturn}

Parameters:
Name Type Description
payload object

The payload object

Properties
Name Type Attributes Default Description
page number <optional>
 1

page of result set
Source:
Returns:

searchUsersReturn

Type
getPayoutMethodsReturn
Example
getPayoutMethods({
  page: 1
})

getPrivacySettings(payloadopt) → {PrivacySettings}

Parameters:
Name Type Attributes Description
payload object <optional>

the payload

Properties
Name Type Attributes Default Description
id string <optional>
 'me'

user id to assign privacy settings
Source:
Returns:
  • Privacy Settings object
Type
PrivacySettings
Example
getPrivacySettings()

getRevokeEventTicketRefundBreakdown(payload) → {revokeEventTicketReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
id number

ticket id
Source:
Returns:
Type
revokeEventTicketReturn
Example
getRevokeEventTicketRefundBreakdown({
  id: 2
})

getSpeakerProfile(payload) → {SpeakerProfile}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

user id
id number

speaker profile id
Source:
Returns:
  • speaker profile
Type
SpeakerProfile
Example
getSpeakerProfile({
  id: 1
})

getSpeakerProfiles(payload) → {Array.<SpeakerProfile>}

Parameters:
Name Type Description
payload object

The payload object

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

user id context
page number <optional>
 1

page of results
Source:
Returns:

speakerProfiles

Type
Array.<SpeakerProfile>
Example
getSpeakerProfiles({
  page: 1
})

getTicketIdFromQrCode(payload) → {string}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
text string

text from qr code reader
Source:
Returns:
  • ticket id
Type
string
Example
getTicketIdFromQrCode({
  text: scan_ticket_6655
})

getTicketingTypes(payload) → {getTicketingTypesReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
id number

event id
page number <optional>
 1

result set page
Source:
Returns:
  • getTicketingTypesReturn
Type
getTicketingTypesReturn
Example
getTicketingTypes({
  id: 10,
  page: 2
})

getUpgradeEventTicketDetails(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
id number

ticket id
Source:
Returns:
Type
void
Example
getUpgradeEventTicketDetails({
  id: 2
})

getUserAccount(payload) → {getUserAccountReturn}

Parameters:
Name Type Description
payload object

The user payload

Properties
Name Type Attributes Default Description
id string <optional>
 'me'

ID of user
Source:
Returns:
Type
getUserAccountReturn
Example
getUserAccount()

getUserPreferences(payloadopt) → {UserPreferences}

Parameters:
Name Type Attributes Description
payload object <optional>

the payload

Properties
Name Type Attributes Default Description
id string <optional>
 'me'

user id to assign preferences
Source:
Returns:
  • UserPreferences object
Type
UserPreferences
Example
getUserPreferences()

getUserProfile(payload) → {getUserProfileReturn}

Parameters:
Name Type Description
payload object

The user payload

Properties
Name Type Description
id number

ID of user
Source:
Returns:
Type
getUserProfileReturn
Example
getUserAccount({
  id: 123
})

getUsersReport(payload) → {getUsersReportReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
term number

search term
page number <optional>
 1

page of results
Source:
Returns:
Type
getUsersReportReturn
Example
getUsersReport({
  searchTerm: 'Sam',
  page: 2
})

login(payload) → {LoginReturn}

Parameters:
Name Type Description
payload object

The login payload

Properties
Name Type Description
email string

email address of user
password string

password to test against
Source:
Returns:
  • LoginReturn return
Type
LoginReturn
Example
login({
  email: 'b@.com',
  password: 'bah'
})

loginWithFirebase(payload) → {FirebaseLoginReturn}

Parameters:
Name Type Description
payload object

The loginWithFirebase payload

Properties
Name Type Description
firebaseToken string

user email
Source:
Returns:
  • login return
Type
FirebaseLoginReturn
Example
loginWithFirebase({
  firebaseToken: 'xxxxxxxxxxxxxxx'
})

logout(payloadopt) → {void}

Parameters:
Name Type Attributes Description
payload object <optional>

The logout payload

Properties
Name Type Attributes Default Description
accessToken string <optional>
 this.authable.getAccessToken()

accessToken to process
Source:
Returns:
Type
void
Example
logout({
  accessToken: 'asdfasdfasdfadsfd'
})

manualLogin(payload) → {ManualLoginReturn}

Parameters:
Name Type Description
payload object

The manualLogin payload

Properties
Name Type Description
accessToken string

current accessToken
refreshToken string

current refreshToken
Source:
Returns:
  • manualLogin return
Type
ManualLoginReturn
Example
manualLogin({
  accessToken: 'asdfasdfsdfadsf',
  refreshToken: 'asdfasdfasdf'
})

muteEventAttendee(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
eventId number

event id
userId number

user id
Source:
Returns:
Type
void
Example
muteEventAttendee({
  eventId: 1127,
  userId: 3
})

pauseEventStream(payload) → {void}

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Description
id string

event id to pause
Source:
Returns:
Type
void
Example
pauseEventStream({
  id: 11818
})

postEventAttendee(payload) → {postEventAttendeeReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
eventId number

event ID
page number <optional>
 1

page
Source:
Returns:
  • attendee return
Type
postEventAttendeeReturn
Example
postEventAttendee({
 eventId: 1127
})

provisionStream(payload) → {void}

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Description
id string

event id to start
Source:
Returns:
Type
void
Example
provisionStream({
  id: 11818
})

purchaseEventTickets(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Description
id number

event id
generalTicketCount number

how many general tickets
vipTicketCount number

how many vip tickets
applyCredits number

should kwivrr credit be applied
preferredLanguage string <optional>

if event is multi-lingual, which language would you prefer?
payment Payment

payment object
Source:
Returns:
Type
void

reclaimEventTicket(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
id number

ticket id
Source:
Returns:
Type
void
Example
reclaimEventTicket({
  id: 2
})

refresh(payloadopt) → {RefreshReturn}

Parameters:
Name Type Attributes Description
payload object <optional>

The refresh payload

Properties
Name Type Attributes Default Description
refreshToken string <optional>
 this.authable.getRefreshToken()

refreshToken to process
Source:
Returns:

refresh return

Type
RefreshReturn
Example
refresh({
  refreshToken: '12345'
})

registerForEvent(payload) → {void}

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Description
id string

event id to register for
Source:
Returns:
Type
void
Example
registerForEvent({
  id: 11818
})

registerForPushNotifications(payload) → {void}

Parameters:
Name Type Description
payload object

The verifyEmail payload

Properties
Name Type Description
token string

expo push token
platform string

enum(ios, android)
deviceDetails string

JSON.stringify'd info for device details
Source:
Returns:
Type
void
Example
registerForPushNotifications({
  token: 'asdfasdfasdfdsafsdafdsafdsafdsf',
  platform: 'ios',
  deviceDetails: '{\"foo\": \"bar\"}'
})

resendUserEmail(payload) → {void}

Parameters:
Name Type Description
payload object

The user payload

Properties
Name Type Attributes Default Description
id number | string <optional>
 'me'

ID of user
Source:
Returns:
Type
void
Example
resendUserEmail({
  id: 123,
})

resetPasswordConfirm(payload) → {ResetPasswordConfirmReturn}

Parameters:
Name Type Description
payload object

The payload object

Properties
Name Type Attributes Default Description
resetPasswordToken string

token to reset password
password string

password for login
withLogin string <optional>
 true

should we login this user after reset?
Source:
Returns:
  • reset password return
Type
ResetPasswordConfirmReturn
Example
resetPasswordConfirm({
  resetPasswordToken: 'asdfasdfasfdfasdf',
  password: 'foo'
})

resetPasswordInit(payload) → {void}

Parameters:
Name Type Description
payload object

The payload object

Properties
Name Type Description
email string

email to reset
Source:
Returns:
Type
void
Example
resetPasswordInit({
  email: 'jim@bob.com'
})

resumeEventStream(payload) → {void}

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Description
id string

event id to pause
Source:
Returns:
Type
void
Example
resumeEventStream({
  id: 11818
})

revokeEventTicket(payload) → {revokeEventTicketReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
id number

ticket id
refundType string <optional>
 'default'

none, default, kwivrrCredit
Source:
Returns:
Type
revokeEventTicketReturn
Example
revokeEventTicket({
  id: 2
})

searchEvents(payload) → {searchEventsReturn}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
page number <optional>
 1

result set page
term string

term to search against
Source:
Returns:
  • searchEvents instance
Type
searchEventsReturn
Example
searchEvents({
  term: 'foo',
  page: 2
})

searchSpeakerProfilesAndUsers(payload) → {getSearchSpeakerReturn}

Parameters:
Name Type Description
payload object

The searchSpeakerProfiles payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

user id to scope against
term string

term to filter against
Source:
Returns:
  • searchSpeakersReturn
Type
getSearchSpeakerReturn
Example
searchSpeakerProfilesAndUsers({
    userId: 1,
    term: "stu",
   })

searchUsers(payload) → {searchUsersReturn}

Parameters:
Name Type Description
payload object

The payload object

Properties
Name Type Attributes Default Description
term string <optional>

search across user's first name, last name and email
page string <optional>
 1

search across user's first name, last name and email
Source:
Returns:

searchUsersReturn

Type
searchUsersReturn
Example
searchUsers({
  term: 'bonnie'
})

sellCustomEventTickets(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Description
id number

event id
userId number

user id to assign tickets
preferredLanguage string <optional>

if event is multi-lingual, which language would you prefer?
generalTicketCount number

how many general tickets
generalTicketPrice number

how much for general ticket?
vipTicketCount number <optional>

if vip tickets are sold, how many vip tickets
vipTicketPrice number <optional>

if vip tickets are sold, how much for vip ticket?
payment Payment

payment object
Source:
Returns:
Type
void

setDefaultCreditCard(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

user id
id number

credit card id
Source:
Returns:
Type
void
Example
setDefaultCreditCard({
  id: 123
})

setDefaultPayoutMethod(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

user id
id number

payout method id
Source:
Returns:
Type
void
Example
setDefaultPayoutMethod({
  id: 123
})

setEventTicketCredentials(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
id number

ticket id
credentialsId number

credentials to assign
Source:
Returns:
  • ticket id
Type
void
Example
setEventTicketCredentials({
  id: 1000,
  credentialsId: 292929
})

showEventSpeaker(payload) → {EventSpeaker}

Parameters:
Name Type Description
payload object

The eventSpeaker payload

Properties
Name Type Description
id number

event id
speakerEventJoinId number

event speaker join id
Source:
Returns:
  • EventSpeaker instance
Type
EventSpeaker
Example
showEventSpeaker({
  id: 10,
  speakerEventJoinId: 100
})

showTicketingType(payload) → {TicketingType}

Parameters:
Name Type Description
payload object

TicketingType payload

Properties
Name Type Description
eventId number

event id
id number

ticketing type id
Source:
Returns:
  • TicketingType instance
Type
TicketingType
Example
showTicketingType({
  eventId: 10,
  id: 100
})

SSOLogin(payload) → {ManualLoginReturn}

Parameters:
Name Type Description
payload object

The SSOLogin payload

Properties
Name Type Description
accessToken string

current accessToken
refreshToken string

current refreshToken
Source:
Returns:
  • SSOLogin return
Type
ManualLoginReturn
Example
SSOLogin({
  accessToken: 'asdfasdfsdfadsf',
  refreshToken: 'asdfasdfasdf'
})

startEventStream(payload) → {void}

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Description
id string

event id to start
Source:
Returns:
Type
void
Example
startEventStream({
  id: 11818
})

transferEventTicket(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
id number

ticket id
email string

email address to transfer ticket to
Source:
Returns:
Type
void
Example
transferEventTicket({
  id: 2,
  email: 'jim.bob@test.com'
})

unbanEventAttendee(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
eventId number

event id
userId number

user id
Source:
Returns:
Type
void
Example
unbanEventAttendee({
  eventId: 1127,
  userId: 1818
})

unblockEventAttendee(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
eventId number

event id
userId number

user id
Source:
Returns:
Type
void
Example
unblockEventAttendee({
  eventId: 1127,
  attendeeId: 1818
})

unCheckinEventTicket(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
id number

ticket id
Source:
Returns:
Type
void
Example
unCheckinEventTicket({
  id: 2
})

unegisterForEvent(payload) → {void}

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Description
id string

event id to unregister for
Source:
Returns:
Type
void
Example
unregisterForEvent({
  id: 11818
})

unfollow(payload) → {void}

Parameters:
Name Type Description
payload object

The verifyEmail payload

Properties
Name Type Description
token string

expo push token
platform string

enum(ios, android)
deviceDetails string

JSON.stringify'd info for device details
Source:
Returns:
Type
void
Example
unfollow({
  token: 'asdfasdfasdfdsafsdafdsafdsafdsf',
  platform: 'ios',
  deviceDetails: '{\"foo\": \"bar\"}'
})

unmuteEventAttendee(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
eventId number

event id
userId number

user id
Source:
Returns:
Type
void
Example
unmuteEventAttendee({
  eventId: 1127,
  userId: 2828
})

unregisterForEvent(payload) → {void}

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Description
id string

event id to unregister for
Source:
Returns:
Type
void
Example
unregisterForEvent({
  id: 11818
})

updateAccountManager(payload) → {AccountManager}

Parameters:
Name Type Description
payload object

The user payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

user id
id string

account manager id
role string

role - moderator, ticket_taker
Source:
Returns:
  • account manager
Type
AccountManager
Example
updateAccountManager({
  userId: me,
  id: 123,
  role: 'ticket_taker'
})

updateEvent(payload) → {object}

Parameters:
Name Type Description
payload object

The event payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userId to event
title string

title of event
startDate string

startDate of event
endDate string

endDate of event
publishDate string

publishDate of event
embedCode string

publishDate of event
generalCapacity string

generalCapacity of event
vipCapacity string

vipCapacity of event
generalTicketPrice string

generalTicketPrice of event
vipTicketPrice string

vipTicketPrice of event
archiveDate string

archiveDate of event
eventType string

eventType of event
visibility boolean

visibility of event (isPrivate)
streamType string

streamType of event (vimeo, youtube, etc)
shopUrl string

shopUrl of event
learnmoreUrl string

learnmoreUrl of event
availableLanguages Array

availableLanguages of event
countDownDisplay boolean

event has countdown or not
eventGroupEventsAttributes Array

eventGroupEventsAttributes of event
Source:
Returns:

{ id, type, name, location, startDate,getEve state, userId, tenantId, liveStreamName, broadcasted, streamType, shopUrl, learnmoreUrl, eventType, shareUrl, eventImageUrl, host, eventGroupEventsAttributes }

Type
object
Example
updatEvent({
      title,
      startDate,
      endDate,
      publishDate,
      embedCode,
      generalCapacity,
      vipCapacity,
      generalTicketPrice,
      vipTicketPrice,
      archiveDate,
      eventType,
      isPrivate,
      streamType,
      shopUrl,
      learnmoreUrl,
      availableLanguages,
      countDownDisplay,
      eventGroupEventsAttributes
    })

updateEventGroup(payload) → {EventGroup}

Parameters:
Name Type Description
payload object

The event group payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

user id
id string

event group id
title string

event group title
Source:
Returns:
  • event group
Type
EventGroup
Example
updateEventGroup({
  id: 123,
  title: 'test'
})

updateEventSpeaker(payload) → {EventSpeaker}

Parameters:
Name Type Description
payload object

The eventSpeaker payload

Properties
Name Type Attributes Description
eventId number

event id
speakerEventJoinId number

event speaker join id
kwivrrId number <optional>

associate by user id if exists, otherwise, check for speaker profile id
speakerProfileId number <optional>

associate by speaker_profile_id (fallthrough if kwivrrId not provided)
topic string

topic speaker is covering
description string

more detailed description of topic
startTime string

when speaker goes on
endTime string

when speaker's session is over
Source:
Returns:
  • EventSpeaker instance
Type
EventSpeaker
Example
updateEventSpeaker({
  eventId: 10,
  speakerEventJoinId: 100,
  speakerProfileId: 6,
  topic:"9d3fjpsarasdgywm7lj8snq5pr39e3",
  description:"5zbn5idwlpvbg3miqidwwm2pvkxohm",
  startTime:"2021-07-07T07:39:05.797-05:00",
  endTime:"2021-07-09T07:39:05.797-05:00"
})

updateFeaturedItem(payload) → {FeaturedItem}

Parameters:
Name Type Description
payload object

The featured item payload

Properties
Name Type Attributes Default Description
id number

The featured item id
userId string <optional>
 'me'

userid to assign this echeck
title string <optional>

title
sortingWeight string <optional>
 0

lighter is earlier in list
description string <optional>
 'n/a'

description (we don't use it)
url string <optional>

url to link to
imageUrl string <optional>

product image url
imageBase64 string <optional>

product image base64
price string <optional>

product price
Source:
Returns:
  • featured item
Type
FeaturedItem
Example
updateFeaturedItem({
  title: 'Brown Socks',
  url: 'https://amazon.com/blah',
  imageUrl: 'https://reallycoolimage.com/home.jpg',
  price: 100
})

updatePayoutMethod(payload) → {PayoutMethod}

Parameters:
Name Type Description
payload object

The user payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

user id
id string

payout method id
provider string

Venmo vs CashApp
externalId string

User identifier
externalIdType string

Type of identifier
isDefault boolean

whether or not it's the default payment
Source:
Returns:
  • payout method
Type
PayoutMethod
Example
updatePayoutMethod({
  id: 123,
  provider: 'venmo',
  externalId: 'andy123',
  externalIdType: 'username',
  isDefault: false
})

updateSpeakerProfile(payload) → {SpeakerProfile}

Parameters:
Name Type Description
payload object

The searchSpeakerProfiles payload

Properties
Name Type Attributes Default Description
userId string <optional>
 'me'

userId profile belongs to
id string

speaker profile id
name string

speaker's name
email string

speaker's email
about string

about the speaker
avatarUrl string <optional>

avatar image url
avatarBase64 string <optional>

uploaded avatar image (takes precedent over avatarUrl)
Source:
Returns:
  • speaker profile object
Type
SpeakerProfile
Example
updateSpeakerProfile({
  id: 11
  name: 'Mitch Cain',
  email: 'mitch.cain@icentris.com',
  about: 'password',
  avatarUrl: 'https://imgur.com/coolphoto.jpg'
})

updateTicketingType(payload) → {TicketingType}

Parameters:
Name Type Description
payload object

TicketingType payload

Properties
Name Type Description
eventId number

event id
id number

ticketing type id
name string

name of ticketing type
capacity number

number of ticketing type available
price number

price of ticketing type
description string

more detailed description of ticketing type
Source:
Returns:
  • TicketingType instance
Type
TicketingType
Example
updateTicketingType({
  eventId: 10,
  id: 100,
  name: 'VIP',
  capacity: 1000,
  price: 500,
  description: "Special backstage pass"
})

updateUserAccount(payload) → {void}

All parameters are optional and can be updated independently of others

Parameters:
Name Type Description
payload object

The user payload

Properties
Name Type Attributes Default Description
id number | string <optional>
 'me'

ID of user
firstName string <optional>

first name
lastName string <optional>

last name
tagLine string <optional>

tag line
facebook string <optional>

facebook handle
instagram string <optional>

instagram handle
pinterest string <optional>

last name
linkedin string <optional>

last name
twitter string <optional>

last name
avatarUrl string <optional>

avatar url
shopUrl string <optional>

shop url
avatarBase64 string <optional>

avatar base64 data
bannerUrl string <optional>

banner url
bannerBase64 string <optional>

banner base64 data
phone string <optional>

phone number
showEmail boolean <optional>

should email be displayed on profile?
Source:
Returns:
Type
void
Example
updateUserAccount({
  id: 123,
  firstName: 'Test',
  lastName; 'User'
})

updateUserEmail(payload) → {void}

Parameters:
Name Type Description
payload object

The user payload

Properties
Name Type Attributes Default Description
id number | string <optional>
 'me'

ID of user
email string

email address
Source:
Returns:
Type
void
Example
updateUserEmail({
  id: 123,
  email: 'foo@bar.com'
})

updateUserPassword(payload) → {void}

currentPassword is required to validate user is allowed to change password

Parameters:
Name Type Description
payload object

The user payload

Properties
Name Type Attributes Default Description
id number | string <optional>
 'me'

ID of user
newPassword string

new password
currentPassword string

current password
Source:
Returns:
Type
void
Example
updateUserPassword({
  newPassword: 'moonbase'
  currentPassword: 'oaktree'
})

updateUserUsername(payload) → {void}

Parameters:
Name Type Description
payload object

The user payload

Properties
Name Type Attributes Default Description
id number | string <optional>
 'me'

ID of user
username string

username
Source:
Returns:
Type
void
Example
updateUserUsername({
  id: 123,
  username: 'user123'
})

upgradeEventTicket(payload) → {void}

Parameters:
Name Type Description
payload object

The payload

Properties
Name Type Description
id number

ticket id
credentialsId number

credentials to assign
Source:
Returns:
Type
void
Example
upgradeEventTicket({
  id: 1000,
  credentialsId: 292929
})

verifyEmail(payload) → {VerifyEmailReturn}

Parameters:
Name Type Description
payload object

The verifyEmail payload

Properties
Name Type Attributes Default Description
confirmationToken string

change confirmation token
withLogin boolean <optional>
 true

should we also log the user in?
Source:
Returns:
  • VerifyEmailReturn
Type
VerifyEmailReturn
Example
verifyEmail({
  confirmationToken: 'asdfasdfasdfdsafsdafdsafdsafdsf'
})

Type Definitions

AccountManager

Type:
  • object
Properties:
Name Type Description
id number

id,
type string

type,
name string

name,
email string

email,
avatarUrl string

avatarUrl,
role string

role
Source:

AccountManagerAssignment

Type:
  • object
Properties:
Name Type Description
id number

credit card id
name string

name of account holder
about string

last four digits of account
email string

is this the default payment method?
avatarUrl string

is this the default payment method?
Source:

Address

Type:
  • object
Properties:
Name Type Description
line1 string

line1 of address
city string

city
state string

state
country string

country
zipCode string

zipCode
Source:

BankAccount

Type:
  • object
Properties:
Name Type Description
id number

credit card id
accountHolderName string

name of account holder
lastFour string

last four digits of account
isDefault boolean

is this the default payment method?
Source:

BankAccount

Type:
  • object
Properties:
Name Type Description
id number

credit card id
accountHolderName string

name of account holder
lastFour string

last four digits of account
isDefault boolean

is this the default payment method?
Source:

CartTotals

Type:
  • object
Properties:
Name Type Description
serviceFee number

total service for for order
subtotal number

(vipTicketCount * vipTicketPrice) + (gaTicketCount * gaTicketPrice)
tax number

tax (currently 0)
total number

overall cart total
Source:

ClaimEventTicketDetails

Type:
  • object
Properties:
Name Type Description
giftedUserEmail string

email address attached to claim
isExistingUser boolean

is this email address tied to an existing kwivrr user?
eventData EventTicketClaimEvent

EventTicketClaimEvent entity
Source:

CreateUserReturn

Type:
  • object
Properties:
Name Type Description
accessToken string

access token
refreshToken string

refresh token
expiresIn number

seconds until accessToken is expired
createdAt number

when account was created
Source:

CreditCard

Type:
  • object
Properties:
Name Type Description
id number

credit card id
cardType string

type of card, visa, discover, amex, mc
lastFour string

last four digits of card
expirationMonth number

expiration month (1-12)
expirationYear number

expiration year
isDefault boolean

is this the default payment method?
Source:

CreditCard

Type:
  • object
Properties:
Name Type Description
id number

credit card id
cardType string

type of card, visa, discover, amex, mc
lastFour string

last four digits of card
expirationMonth number

expiration month (1-12)
expirationYear number

expiration year
isDefault boolean

is this the default payment method?
Source:

creditCardRefundBreakdownItem

Type:
  • object
Properties:
Name Type Description
lastFour number

last four of credit card
cardType string

card type used (visa/mc/discover/amex)
Source:

echeckRefundBreakdownItem

Type:
  • object
Properties:
Name Type Description
lastFour number

last four of bank account number
Source:

Event

Type:
  • object
Properties:
Name Type Description
id number

event id
title string

event title
description string

event description
descriptionText string

event description (stripped)
emailContent string

event email content
emailContentText string

emailContent (stripped)
startDate Date

when does event start?
endDate Date

when does event end?
archiveDate Date

when should event fall off home page feed and should ticket sales be disabled?
publishDate Date

when should event be available and ticket sales commence?
shopUrl string

shopping link for live stream event
learnMoreUrl string

external splash page url
eventPageUrl string

url for splash page sharing
livestreamPageUrl string

url for livestream page sharing
eventImageUrl string

image for hero on splash, and thumbs elsewhere
hasImage boolean

was an image uploaded, eventImageUrl will always have a default image even if none was provided
hasGeneralTicketsRemaining boolean

are general tickets still available?
generalTicketSales number

if host, how many general ticket sales have occurred?
generalTicketsSold number

if host, how many general tickets have been sold?
generalTicketPrice number

general ticket price
generalTicketDescription string

general ticket description
generalTicketDescriptionText string

generalTicketDescription (stripped)
generalCapacity number

total general tickets
hasVipTicketsRemaining boolean

are vip tickets are still available?
vipTicketSales number

if host, how many vip ticket sales have occurred?
vipTicketsSold number

if host, how many vip tickets have been sold?
vipTicketPrice number

general ticket price
vipTicketDescription string

vip ticket description
vipTicketDescriptionText string

vipTicketDescription (stripped)
vipCapacity number

vip ticket description
userTicketsCount number

how many tickets does currentUser have?
isOnWaitlist boolean

is current user already on the wait list?
withCountdownDisplay boolean

should a countdown display on the splash page?
isPrivate boolean

is this a private event?
isPublic boolean

is this a public event?
isPhysical boolean

is this a physical event?
isDigital boolean

is this a digital event?
isTicketed boolean

is this a ticketed event?
isFree boolean

is this a free event?
isGeneralTicketed boolean

alias of isTicketed
isVipTicketed boolean

is this a vip ticketed event?
eventGroupIds Array.<number>

event group ids event is part of
availableLanguages Array.<string>

languages available for this event
streamType string

if digital event, enum('youtube', 'vimeo', 'kwivrr')
streamUrl string

if digital event and not streamType = 'kwivrr', this is the video url to play
promotionalVideoType string

service type for promotional video enum('youtube', 'vimeo', 'kwivrr')
promotionalVideoUrl string

url for promotional video if provided
hasPromotionalVideo boolean

do we have a promo video to attempt to load?
hasTicketsRemaining boolean

does this event have tickets of any type remaining?
totalTicketSales number

sum of vip and ga ticket sales
totalTicketsSold number

sum of vip and ga tickets sold
isPublished boolean

is this event published?
isArchived boolean

is this event archived?
isCurrentlySellingGeneralTickets boolean

are general tickets currently available for purchase?
isCurrentlySellingVipTickets boolean

are vip tickets currently available for sale?
hasEnded boolean

has the event ended?
isPastDate boolean

alias of hasEnded
hasStarted boolean

has the event started?
isInProgress boolean

is the event currently in progress?
isLive boolean

alias of isInProgress
isKwivrrStream boolean

is this a red5 stream event?
isCurrentlyStreaming boolean

if a digital event, is this currently active?
hasEventGroups boolean

does event have any event groups?
hasAvailableLanguages boolean

does event have available languages?
hostStreamPageUrl string

if isDigital, host stream url
viewStreamPageUrl string

if isDigital, viewer stream url
shareUrl string

url to share, if currently streaming and a free event, this will point to stream viewer page
isSoldOutOfGeneralTickets boolean

if tickets were being sold, are we sold out of general tickets?
isSoldOutOfVipTickets boolean

if isVipTicketed are we sold out of vip tickets?
isSoldOut boolean

if ticketed are we sold out of all ticket classes?
hasTickets boolean

if currentUser logged in, do they have tickets?
hasImageOrPromotionalVideo boolean

does event have a cover image or promo video?
hostName string

host full name
hostId string

host id
hostAvatarUrl string

host avatar url
hostTagLine string

host tagLine
hostFirstName string

host first name
hostLastName string

host last name
isStreamEmbed boolean

for streamType = 'resi', we use raw embed code
streamEmbed string

for resi this is the raw embed code
inProgressAction string

cta for splash page enum('watch', 'sold_out', 'buy_now', false)
hasInProgressAction boolean

does it have an inProgress action?
hasInProgressActionWatch boolean

is watch the inProgress cta?
hasInProgressActionBuyTickets boolean

is buy_tickets the inProgress cta?
hasInProgressActionSoldOut boolean

is sold_out the inProgress cta?
hasInProgressActionRegister boolean

is register the inProgress cta?
hasInProgressActionUnregister boolean

is unregister the inProgress cta?
secondsUntilStart boolean

how many seconds until event begins? 0 if completed or started
hasStreamOrEmbed boolean

does the record actually have a provider attached?
isDeleteable boolean

this event deletable?
joinUrl string

for Zoom, this is the viewer url
startUrl string

for Zoom, this is the host url
providerId number

provider id for event (must be passed with update call for a live stream)
isStreamLive boolean

for digital events, did the host start the stream?
isStreamEnded boolean

for digital events, did the host end the stream?
isStreamLiveAndUnpaused boolean

for digital events, is the host currently streaming and the stream is unpaused?
isInterested boolean

is user interested in event?
Source:

EventAttendee

Type:
  • object
Properties:
Name Type Description
userId number

user id
type string

type
url string

url to link to
name number

name
avatarUrl string

url
isBanned boolean

is the user banned from chat?
isBlocked boolean

is the user blocked from the event entirely?
Source:

EventGroup

Type:
  • object
Properties:
Name Type Description
id number

event group id
title string

event group id
Source:

EventGroup

Type:
  • object
Properties:
Name Type Description
id number

event group id
title string

group title
Source:

EventManager

Type:
  • object
Properties:
Name Type Description
id number

EventWatch join id
type string

type
email string

email
avatarUrl string

email
role string

role
Source:

EventMessage

Type:
  • object
Properties:
Name Type Description
id number

message id
avatarUrl string

User picture
commenter string

User display name
dateCommented string

Message created date
commentText string

User posted message
Source:

EventOverview

Type:
  • object
Properties:
Name Type Description
gaTicketTotalSales number

ga ticket total sales
vipTicketTotalSales number

vip ticket total sales
gaTicketsSold number

ga tickets sold count
vipTicketsSold number

vip tickets sold count
gaTicketsCheckedInCount number

ga tickets checked in count
vipTicketsCheckedInCount number

vip tickets checked in count
gaTicketsAllocated number

ga tickets capacity
vipTicketsAllocated number

vip tickets capacity
Source:

EventServiceFeeTableRow

Type:
  • object
Properties:
Name Type Description
gte number

greater-than-or-equal
lt number

less than, if null, this is the max bucket
fee number

per ticket fee for this row
Source:

EventServiceFeeTableRow

Type:
  • object
Properties:
Name Type Description
gte number

greater-than-or-equal
lt number

less than, if null, this is the max bucket
fee number

per ticket fee for this row
Source:

EventSpeaker

Type:
  • object
Properties:
Name Type Description
eventSpeakerJoinId number

join entity id (used for delete/update actions)
id number

entity id (kwivvrId or speakerProfileId)
name string

speaker name
topic string

topic to discuss
description string

more details on topic
startTime string

when speaker goes on
endTime string

when speaker goes off
avatarUrl string

speaker's avatar
isKwivvrUser boolean

is "id" a kwivrr account id or a speaker profile id?
Source:

EventTicketClaimEvent

Type:
  • object
Properties:
Name Type Description
id number

event id
title string

event title
description string

event description, plain text
descriptionHtml string

event description, html
startDate string

event start date
endDate string

event end date
eventImageUrl string

cover image for event
promotionalVideoUrl string

url for promo video, takes precedence over cover image if provided
hasImage boolean

eventImageUrl will always return something valid, but does the event have an intentionally added image tied to it?
Source:

EventTicketHistoryEntry

Type:
  • object
Properties:
Name Type Description
action string

action happening to ticket, see api_status options
datePerformed string

date history event occurred
text string

text description of event
Source:

EventWatch

Type:
  • object
Properties:
Name Type Description
id number

EventWatch join id
eventId number

event to watch
Source:

FeaturedItem

Type:
  • object
Properties:
Name Type Description
id number

featured item id
title string

title
url string

url to link to
sortingWeight number

priority of featured item (lighter is earlier in list)
imageUrl string

product image url
price number

product price
Source:

FirebaseLoginReturn

Type:
  • object
Properties:
Name Type Description
accessToken string

access token
refreshToken string

refresh token
expiresIn string

expires in
createdAt string

created at
isAdmin string

whether or not user is admin
Source:

getAccountManagerAssignmentsListSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

getAccountManagerAssignmentsReturn

Type:
  • object
Properties:
Name Type Description
accountManagerAssignments Array.<AccountManagerAssignment>

list of account manager assignments returned
listSummary getAccountManagerAssignmentsListSummary

list summary object
criteriaSummary object

list summary object (empty)
Source:

getAccountManagersReturn

Type:
  • object
Properties:
Name Type Description
accountManagers Array.<AccountManager>

list of account managers returned
listSummary getAccountManagersSummary

list summary object
criteriaSummary object

list summary object (empty)
Source:

getAccountManagersSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

getAttendanceReportListSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

getAttendanceReportReturn

Type:
  • object
Properties:
Name Type Description
entries Array.<Event>

list of users returned
listSummary getAttendanceReportListSummary

list summary object
criteriaSummary object

criteria summary object (empty)
Source:

getEchecksReturn

Type:
  • object
Properties:
Name Type Description
id number

echeck id
accountHolderName string

name on account
lastFour string

last for of account number
isDefault string

whether or not it's the default payment
Source:

getEventAttendeesReturn

Type:
  • object
Properties:
Name Type Description
eventWatches Array.<EventAttendee>

list of users returned
listSummary getEventAttendeesSummary

list summary object
criteriaSummary object

list summary object (empty)
Source:

getEventAttendeesSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

getEventGroupsReturn

Type:
  • object
Properties:
Name Type Description
eventGroups Array.<EventGroup>

list of event groups returned
Source:

getEventManagersReturn

Type:
  • object
Properties:
Name Type Description
entries Array.<EventManager>

list of event managers returned
listSummary getEventManagersSummary

list summary object
criteriaSummary object

list summary object (empty)
Source:

getEventManagersSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

getEventMessageListSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

getEventMessagesReturn

Type:
  • object
Properties:
Name Type Description
entries Array.<EventMessage>

list of event message returned
listSummary getEventMessageListSummary

list summary object
criteriaSummary object

criteria summary object (empty)
Source:

getEventsByUserIdCriteriaSummary

Type:
  • object
Properties:
Name Type Description
scope string

scope
userId number

userId
Source:

getEventsByUserIdListSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

getEventsByUserIdReturn

Type:
  • object
Properties:
Name Type Description
entries Array.<Event>

list of users returned
listSummary getEventsByUserIdListSummary

list summary object
criteriaSummary getEventsByUserIdCriteriaSummary

list summary object (empty)
Source:

getEventsCriteriaSummary

Type:
  • object
Properties:
Name Type Description
scope string

scope
startDate string

startDate
endDate string

endDate
hostId number

hostId
userId number

userId
Source:

getEventsListSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

getEventSpeakersReturn

Type:
  • object
Properties:
Name Type Description
entries Array.<EventSpeaker>

list of speaker profile ids returned
listSummary getEventSpeakerSummary

list summary object
criteriaSummary object

criteria summary object (empty)
Source:

getEventSpeakerSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

getEventsReturn

Type:
  • object
Properties:
Name Type Description
entries Array.<Event>

list of users returned
listSummary getEventsListSummary

list summary object
criteriaSummary getEventsCriteriaSummary

list summary object (empty)
Source:

getEventWaitListListSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

getEventWaitListReturn

Type:
  • object
Properties:
Name Type Description
eventWaitList Array.<object>

list of users returned
listSummary getEventWaitListListSummary

list summary object
criteriaSummary object

list summary object (empty)
Source:

getEventWatchesListSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

getEventWatchesReturn

Type:
  • object
Properties:
Name Type Description
eventWatches Array.<EventWatch>

list of users returned
listSummary getEventWatchesListSummary

list summary object
criteriaSummary object

list summary object (empty)
Source:

getFeedsListSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

getFeedsReturn

Type:
  • object
Properties:
Name Type Description
entries Array.<Event>

list of users returned
listSummary getFeedsListSummary

list summary object
criteriaSummary object

criteria summary object (empty)
Source:

getForMeEventsListSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

getForMeEventsReturn

Type:
  • object
Properties:
Name Type Description
entries Array.<Event>

list of users returned
listSummary getForMeEventsListSummary

list summary object
criteriaSummary object

criteria summary object (empty)
Source:

getPaymentChoicesReturn

Type:
  • object
Properties:
Name Type Description
creditCards Array.<CreditCard>

credit card entities
bankAccounts Array.<BankAccount>

bank account entities
Source:

getPayoutMethodsListSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

getPayoutMethodsReturn

Type:
  • object
Properties:
Name Type Description
entries Array.<PayoutMethod>

list of users returned
listSummary getPayoutMethodsListSummary

list summary object
criteriaSummary object

criteria summary object (empty)
Source:

getSearchSpeakerReturn

Type:
  • object
Properties:
Name Type Description
entries Array.<SpeakerProfileOrUser>

list of speaker profile ids returned
listSummary getSearchSpeakerSummary

list summary object
criteriaSummary object

criteria summary object (empty)
Source:

getSearchSpeakerSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
term string

term searched against
Source:

getTicketingTypesReturn

Type:
  • object
Properties:
Name Type Description
entries Array.<TicketingType>

list of ticketing types returned
listSummary getTicketingTypesSummary

list summary object
criteriaSummary object

criteria summary object (empty)
Source:

getTicketingTypesSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

getUserAccountReturn

Type:
  • object
Properties:
Name Type Description
id number

user id
firstName string

first name
lastName string

last name
tagLine string

tag line for use in profile
facebook string

facebook handle
instagram string

instagram handle
pinterest string

pinterest handle
linkedin string

linkedin handle
twitter string

twitter handle
avatarUrl string

image url for avatar
bannerUrl string

image url for banner
shopUrl string

url for shop link
email string

email address
phone string

phone number
hasAvatarImage boolean

did the user upload an avatar image?
hasBannerImage boolean

did the user upload a banner image?
showEmail boolean

should email display on user's profile? If this is false, then email will also be empty (unless requester is self or admin)
showFollowees boolean

show followees?
showEventsAttended boolean

show events attended?
showEventsAttending boolean

show events user is attending?
showInUserSearch boolean

show profile in user search?
showInSpeakerSearch boolean

show profile in speaker search?
shareUrl string

url to share profile
Source:

getUserProfileReturn

Type:
  • object
Properties:
Name Type Description
id number

user id
firstName string

first name
lastName string

last name
tagLine string

tag line for use in profile
facebook string

facebook handle
instagram string

instagram handle
pinterest string

pinterest handle
linkedin string

linkedin handle
twitter string

twitter handle
avatarUrl string

image url for avatar
bannerUrl string

image url for banner
shopUrl string

url for shop link
email string

email address
phone string

phone number
showEmail boolean

should email display on user's profile? If this is false, then email will also be empty (unless requester is self or admin)
Source:

getUsersReportListSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

getUsersReportReturn

Type:
  • object
Properties:
Name Type Description
entries Array.<Event>

list of users returned
listSummary getUsersReportListSummary

list summary object
criteriaSummary object

criteria summary object (empty)
Source:

Languages

Type:
  • object
Properties:
Name Type Description
id number

language id
label number

language label
Source:

Languages

Type:
  • Array
Properties:
Name Type Description
id number

language id
label number

language label
Source:

LoginReturn

Type:
  • object
Properties:
Name Type Description
id number

user id
accessToken string

access token
refreshToken string

refresh token
expiresIn number

seconds until accessToken is expired
createdAt number

access token create timestamp
isAdmin string

whether or not user is admin
Source:

ManualLoginReturn

Type:
  • object
Properties:
Name Type Description
accessToken string

access token
refreshToken string

refresh token
Source:

Payment

Type:
  • object
Properties:
Name Type Attributes Description
cardId number <optional>

credit card id on file to use
echeckId number <optional>

echeck id on file to use
echeck PaymentEcheck <optional>

new echeck details
creditCard PaymentCreditCard <optional>

new echeck details
Source:

PaymentAddress

Type:
  • object
Properties:
Name Type Description
line1 string

line1 of address
city string

city
state string

state
country string

country
zipCode string

zip code
Source:

PaymentCreditCard

Type:
  • object
Properties:
Name Type Description
name string

name on card
cardNumber string

cc number
ccv string

security code
cardType string

cc card type
expirationMonth number

card exp month
expirationYear number

card exp year
saveCard boolean

save card on file?
address PaymentAddress

address on card
Source:

PaymentEcheck

Type:
  • object
Properties:
Name Type Description
accountHolderName string

name on account
routingNumber string

routing number
saveEcheck boolean

save eCheck on file?
Source:

PayoutMethod

Type:
  • object
Properties:
Name Type Description
id number

payout id
provider string

Venmo vs CashApp
externalId string

User identifier
externalIdType string

Type of identifier
isDefault boolean

whether or not it's the default payment
Source:

postEventAttendeeReturn

Type:
  • object
Properties:
Name Type Description
eventWatches Array.<EventAttendee>

list of users returned
listSummary postEventAttendeeSummary

list summary object
criteriaSummary object

list summary object (empty)
Source:

postEventAttendeeSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

PrivacySettings

Type:
  • object
Properties:
Name Type Description
showFollowees boolean

show followees?
showEventsAttending boolean

show events attending?
showEventsAttended boolean

show events previously attended?
showInUserSearch boolean

should user show in user search results?
showInSpeakerSearch boolean

should user show in speaker search results?
Source:

RefreshReturn

Type:
  • object
Properties:
Name Type Description
accessToken string

access token
refreshToken string

refresh token
expiresIn number

seconds until accessToken is expired
createdAt number

access token create timestamp
isAdmin string

whether or not user is admin
Source:

ResetPasswordConfirmReturn

Type:
  • object
Properties:
Name Type Description
accessToken string

access token
refreshToken string

refresh token
expiresIn number

seconds until accessToken is expired
createdAt number

when account was created
Source:

revokeEventTicketRefundBreakdown

Type:
  • object
Properties:
Name Type Attributes Description
kwivrrCredit number

how much refund went to kwivrr credit
totalRefund number

how much refund combined across credit and real payments
creditCard number <optional>

if payment used was credit card, this is how much went back to that source.
echeck number <optional>

if payment used was echeck, this is how much went back to that source.
Source:

revokeEventTicketReturn

Type:
  • object
Properties:
Name Type Attributes Description
refundBreakdown revokeEventTicketRefundBreakdown

how refund was allocated
creditCard creditCardRefundBreakdownItem <optional>

if refund is to credit card, this is the entity
echeck echeckRefundBreakdownItem <optional>

if refund is to echeck, this is the entity
Source:

searchEventsListSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

searchEventsReturn

get url from video embed code

Type:
  • object
Properties:
Name Type Description
entries Array.<Event>

list of speaker profile ids returned
listSummary searchEventsListSummary

list summary object
criteriaSummary object

criteria summary object (empty)
Source:

searchUsersCriteriaSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
term string

term searched for
Source:

searchUsersEntry

Type:
  • object
Properties:
Name Type Description
userId number

user id
firstName string

user's first name
lastName string

user's last name
tagLine string

user's tag line
avatarUrl string

users's avatar url
Source:

searchUsersListSummary

Type:
  • object
Properties:
Name Type Description
page number

page of results
perPage number

results per page
hasMore boolean

are more pages available?
Source:

searchUsersReturn

Type:
  • object
Properties:
Name Type Description
users Array.<searchUsersEntry>

list of users returned
listSummary searchUsersListSummary

list summary object
criteriaSummary searchUsersCriteriaSummary

criteria summary object
Source:

SpeakerProfile

Type:
  • object
Properties:
Name Type Description
id number

credit card id
name string

name of account holder
about string

last four digits of account
email string

is this the default payment method?
avatarUrl string

is this the default payment method?
Source:

SpeakerProfileOrUser

Type:
  • object
Properties:
Name Type Description
id number

entity id
firstName string

first name
lastName string

last name
email string

email
isKwivvrUser boolean

is "id" a kwivrr account id or a speaker profile id?
Source:

TicketingType

Type:
  • object
Properties:
Name Type Description
id number

ticketing type id
name string

ticketing type name
capacity number

number of ticketing types available
description string

more details on ticketing type
price number

ticketing type price
Source:

UserPreferences

Type:
  • object
Properties:
Name Type Description
registeredEventStart boolean

notify user when event starts?
registeredEvent1HourBefore boolean

notify user 1 hour before event starts?
registeredEvent24HoursBefore boolean

notify 24 hours before?
registeredEventIsLive boolean

notify right when event goes live?
Source:

VerifyEmailReturn

Type:
  • object
Properties:
Name Type Description
accessToken string

access token
refreshToken string

refresh token
expiresIn string

expires in
createdAt string

created at
Source: