? format=jsonld
type: ApiDocumentation
title: Mon Repondeur Pro API
entrypoint: /api
supported class: Error
supported class: ConstraintViolation
supported class: CallSessionGeneralStats
supported class: CallSessionTemporalStats
supported class: ApplicationToken
supported class: CallEvent
supported class: CallSession
supported class: Company
supported class: MediaObject
supported class: PhoneNumber
supported class: Settings
supported class: User
supported class: WelcomeMessage
supported class: Entrypoint
supported class: ConstraintViolationList

Error
type: Class
title: Error
supported property: SupportedProperty
  property: Error/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/title
  title: title
  required: false
  readable: true
  writeable: false
  description: A short, human-readable summary of the problem.
supported property: SupportedProperty
  property: Error/detail
  title: detail
  required: false
  readable: true
  writeable: false
  description: A human-readable explanation specific to this occurrence of the problem.
supported property: SupportedProperty
  property: Error/instance
  title: instance
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
supported property: SupportedProperty
  property: Error/type
  title: type
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the problem type
supported property: SupportedProperty
  property: Error/meta
  title: meta
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Error resource.
  method: GET
  returns: Error
  title: getError
description: A representation of common errors.
subclass of: Error

Error/id
type: Property
domain: Error
the hydra core vocabulary: id
range: string

Error/title
type: Property
domain: Error
the hydra core vocabulary: title
range: string

Error/detail
type: Property
domain: Error
the hydra core vocabulary: detail
range: string

Error/instance
type: Property
domain: Error
the hydra core vocabulary: instance
range: string

Error/type
type: Property
domain: Error
the hydra core vocabulary: type
range: string

Error/meta
type: Property
domain: Error
the hydra core vocabulary: meta

Error/source
type: Property
domain: Error
the hydra core vocabulary: source

Error/trace
type: Property
domain: Error
the hydra core vocabulary: trace

Error/message
type: Property
domain: Error
the hydra core vocabulary: message
range: string

Error/code
type: Property
domain: Error
the hydra core vocabulary: code
range: integer

Error/file
type: Property
domain: Error
the hydra core vocabulary: file
range: string

Error/line
type: Property
domain: Error
the hydra core vocabulary: line
range: integer

Error/description
type: Property
domain: Error
the hydra core vocabulary: description
range: string

ConstraintViolation
type: Class
title: ConstraintViolation
supported property: SupportedProperty
  property: ConstraintViolation/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/errorTitle
  title: errorTitle
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/violations
  title: violations
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/detail
  title: detail
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/instance
  title: instance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/statusCode
  title: statusCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/headers
  title: headers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/previous
  title: previous
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
description: Unprocessable entity
subclass of: Error

ConstraintViolation/status
type: Property
domain: ConstraintViolation
the hydra core vocabulary: status
range: integer

ConstraintViolation/errorTitle
type: Property
domain: ConstraintViolation
the hydra core vocabulary: errorTitle
range: string

ConstraintViolation/violations
type: Property
domain: ConstraintViolation
the hydra core vocabulary: violations
range: ConstraintViolationList

ConstraintViolation/detail
type: Property
domain: ConstraintViolation
the hydra core vocabulary: detail
range: string

ConstraintViolation/message
type: Property
domain: ConstraintViolation
the hydra core vocabulary: message
range: string

ConstraintViolation/code
type: Property
domain: ConstraintViolation
the hydra core vocabulary: code
range: string
range: integer

ConstraintViolation/file
type: Property
domain: ConstraintViolation
the hydra core vocabulary: file
range: string

ConstraintViolation/line
type: Property
domain: ConstraintViolation
the hydra core vocabulary: line
range: integer

ConstraintViolation/description
type: Property
domain: ConstraintViolation
the hydra core vocabulary: description
range: string

ConstraintViolation/type
type: Property
domain: ConstraintViolation
the hydra core vocabulary: type
range: string

ConstraintViolation/title
type: Property
domain: ConstraintViolation
the hydra core vocabulary: title
range: string

ConstraintViolation/instance
type: Property
domain: ConstraintViolation
the hydra core vocabulary: instance
range: string

ConstraintViolation/statusCode
type: Property
domain: ConstraintViolation
the hydra core vocabulary: statusCode
range: integer

ConstraintViolation/headers
type: Property
domain: ConstraintViolation
the hydra core vocabulary: headers

ConstraintViolation/trace
type: Property
domain: ConstraintViolation
the hydra core vocabulary: trace

ConstraintViolation/previous
type: Property
domain: ConstraintViolation
the hydra core vocabulary: previous

CallSessionGeneralStats
type: Class
title: CallSessionGeneralStats
supported property: SupportedProperty
  property: CallSessionGeneralStats/totalUnreadMessages
  title: totalUnreadMessages
  required: false
  readable: true
  writeable: true
  description: Total number of unread messages
supported property: SupportedProperty
  property: CallSessionGeneralStats/totalMessages
  title: totalMessages
  required: false
  readable: true
  writeable: true
  description: Total number of messages
supported property: SupportedProperty
  property: CallSessionGeneralStats/monthlyMessages
  title: monthlyMessages
  required: false
  readable: true
  writeable: true
  description: Monthly messages statistics
supported property: SupportedProperty
  property: CallSessionGeneralStats/dailyMessages
  title: dailyMessages
  required: false
  readable: true
  writeable: true
  description: Daily messages statistics
supported operation: Operation
  type: FindAction
  description: Retrieves a CallSessionGeneralStats resource.
  method: GET
  returns: CallSessionGeneralStats
  title: getCallSessionGeneralStats

CallSessionGeneralStats/totalUnreadMessages
type: Property
domain: CallSessionGeneralStats
the hydra core vocabulary: totalUnreadMessages
range: integer

CallSessionGeneralStats/totalMessages
type: Property
domain: CallSessionGeneralStats
the hydra core vocabulary: totalMessages
range: integer

CallSessionGeneralStats/monthlyMessages
type: Property
domain: CallSessionGeneralStats
the hydra core vocabulary: monthlyMessages

CallSessionGeneralStats/dailyMessages
type: Property
domain: CallSessionGeneralStats
the hydra core vocabulary: dailyMessages

CallSessionTemporalStats
type: Class
title: CallSessionTemporalStats
supported property: SupportedProperty
  property: CallSessionTemporalStats/period
  title: period
  required: false
  readable: true
  writeable: true
  description: Period type used for grouping
supported property: SupportedProperty
  property: CallSessionTemporalStats/callsByPeriod
  title: callsByPeriod
  required: false
  readable: true
  writeable: true
  description: Calls grouped by period
supported property: SupportedProperty
  property: CallSessionTemporalStats/summary
  title: summary
  required: false
  readable: true
  writeable: true
  description: Summary statistics
supported operation: Operation
  type: FindAction
  description: Retrieves a CallSessionTemporalStats resource.
  method: GET
  returns: CallSessionTemporalStats
  title: getCallSessionTemporalStats

CallSessionTemporalStats/period
type: Property
domain: CallSessionTemporalStats
the hydra core vocabulary: period
range: string

CallSessionTemporalStats/callsByPeriod
type: Property
domain: CallSessionTemporalStats
the hydra core vocabulary: callsByPeriod

CallSessionTemporalStats/summary
type: Property
domain: CallSessionTemporalStats
the hydra core vocabulary: summary

ApplicationToken
type: Class
title: ApplicationToken
supported property: SupportedProperty
  property: ApplicationToken/name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ApplicationToken/token
  title: token
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ApplicationToken/description
  title: description
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ApplicationToken/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ApplicationToken/user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ApplicationToken/scopes
  title: scopes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ApplicationToken/expiresAt
  title: expiresAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ApplicationToken/lastUsedAt
  title: lastUsedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ApplicationToken/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ApplicationToken/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ApplicationToken resource.
  method: GET
  returns: ApplicationToken
  title: getApplicationToken
supported operation: Operation
  type: DeleteAction
  description: Deletes the ApplicationToken resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteApplicationToken

ApplicationToken/name
type: Property
domain: ApplicationToken
the hydra core vocabulary: name
range: string

ApplicationToken/token
type: Property
domain: ApplicationToken
the hydra core vocabulary: token
range: string

ApplicationToken/description
type: Property
domain: ApplicationToken
the hydra core vocabulary: description
range: string

ApplicationToken/active
type: Property
domain: ApplicationToken
the hydra core vocabulary: active
range: boolean

ApplicationToken/user
type: Property
domain: ApplicationToken
the hydra core vocabulary: user
max cardinality: 1
range: User

ApplicationToken/scopes
type: Property
domain: ApplicationToken
the hydra core vocabulary: scopes

ApplicationToken/expiresAt
type: Property
domain: ApplicationToken
the hydra core vocabulary: expiresAt
range: dateTime

ApplicationToken/lastUsedAt
type: Property
domain: ApplicationToken
the hydra core vocabulary: lastUsedAt
range: dateTime

ApplicationToken/createdAt
type: Property
domain: ApplicationToken
the hydra core vocabulary: createdAt
range: dateTime

ApplicationToken/updatedAt
type: Property
domain: ApplicationToken
the hydra core vocabulary: updatedAt
range: dateTime

CallEvent
type: Class
title: CallEvent
supported property: SupportedProperty
  property: CallEvent/eventType
  title: eventType
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallEvent/channelId
  title: channelId
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallEvent/callerId
  title: callerId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallEvent/destinationNumber
  title: destinationNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallEvent/eventData
  title: eventData
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallEvent/status
  title: status
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallEvent/duration
  title: duration
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallEvent/callSession
  title: callSession
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallEvent/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallEvent/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a CallEvent resource.
  method: GET
  returns: CallEvent
  title: getCallEvent

CallEvent/eventType
type: Property
domain: CallEvent
the hydra core vocabulary: eventType
range: string

CallEvent/channelId
type: Property
domain: CallEvent
the hydra core vocabulary: channelId
range: string

CallEvent/callerId
type: Property
domain: CallEvent
the hydra core vocabulary: callerId
range: string

CallEvent/destinationNumber
type: Property
domain: CallEvent
the hydra core vocabulary: destinationNumber
range: string

CallEvent/eventData
type: Property
domain: CallEvent
the hydra core vocabulary: eventData

CallEvent/status
type: Property
domain: CallEvent
the hydra core vocabulary: status
range: string

CallEvent/duration
type: Property
domain: CallEvent
the hydra core vocabulary: duration
range: integer

CallEvent/callSession
type: Link
domain: CallEvent
the hydra core vocabulary: callSession
max cardinality: 1
range: CallSession

CallEvent/createdAt
type: Property
domain: CallEvent
the hydra core vocabulary: createdAt
range: dateTime

CallEvent/updatedAt
type: Property
domain: CallEvent
the hydra core vocabulary: updatedAt
range: dateTime

CallSession
type: Class
title: CallSession
supported property: SupportedProperty
  property: CallSession/channelId
  title: channelId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/callerId
  title: callerId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/destinationNumber
  title: destinationNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/startTime
  title: startTime
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/endTime
  title: endTime
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/duration
  title: duration
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/isRead
  title: isRead
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: CallSession/isArchived
  title: isArchived
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: CallSession/transcription
  title: transcription
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/transcriptionData
  title: transcriptionData
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/transcriptionStatus
  title: transcriptionStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/transcriptionMetadata
  title: transcriptionMetadata
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/events
  title: events
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/recordings
  title: recordings
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/limited
  title: limited
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/countedInQuota
  title: countedInQuota
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/countedForUser
  title: countedForUser
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CallSession/company
  title: company
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: CallSession/recordings
  title: recordings
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: CallSession/isRead
  title: isRead
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: CallSession/isArchived
  title: isArchived
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: CallSession/transcription
  title: transcription
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: CallSession/transcriptionData
  title: transcriptionData
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: CallSession/beenCountedForUser
  title: beenCountedForUser
  required: false
  readable: false
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a CallSession resource.
  method: GET
  returns: CallSession
  title: getCallSession
supported operation: Operation
  description: Updates the CallSession resource.
  expects: CallSession
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/json
  method: PATCH
  returns: CallSession
  title: patchCallSession
supported operation: Operation
  type: DeleteAction
  description: Deletes the CallSession resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteCallSession

CallSession/channelId
type: Property
domain: CallSession
the hydra core vocabulary: channelId
range: string

CallSession/callerId
type: Property
domain: CallSession
the hydra core vocabulary: callerId
range: string

CallSession/destinationNumber
type: Property
domain: CallSession
the hydra core vocabulary: destinationNumber
range: string

CallSession/startTime
type: Property
domain: CallSession
the hydra core vocabulary: startTime
range: dateTime

CallSession/endTime
type: Property
domain: CallSession
the hydra core vocabulary: endTime
range: dateTime

CallSession/duration
type: Property
domain: CallSession
the hydra core vocabulary: duration
range: integer

CallSession/status
type: Property
domain: CallSession
the hydra core vocabulary: status
range: string

CallSession/isRead
type: Property
domain: CallSession
the hydra core vocabulary: isRead
range: boolean

CallSession/isArchived
type: Property
domain: CallSession
the hydra core vocabulary: isArchived
range: boolean

CallSession/transcription
type: Property
domain: CallSession
the hydra core vocabulary: transcription
range: string

CallSession/transcriptionData
type: Property
domain: CallSession
the hydra core vocabulary: transcriptionData

CallSession/transcriptionStatus
type: Property
domain: CallSession
the hydra core vocabulary: transcriptionStatus
range: string

CallSession/transcriptionMetadata
type: Property
domain: CallSession
the hydra core vocabulary: transcriptionMetadata

CallSession/phoneNumber
type: Link
domain: CallSession
the hydra core vocabulary: phoneNumber
max cardinality: 1
range: PhoneNumber

CallSession/events
type: Link
domain: CallSession
the hydra core vocabulary: events
range: CallEvent

CallSession/recordings
type: Link
domain: CallSession
the hydra core vocabulary: recordings
range: MediaObject
type: Property

CallSession/limited
type: Property
domain: CallSession
the hydra core vocabulary: limited
range: boolean

CallSession/countedInQuota
type: Property
domain: CallSession
the hydra core vocabulary: countedInQuota
range: boolean

CallSession/countedForUser
type: Link
domain: CallSession
the hydra core vocabulary: countedForUser
max cardinality: 1
range: User

CallSession/createdAt
type: Property
domain: CallSession
the hydra core vocabulary: createdAt
range: dateTime

CallSession/updatedAt
type: Property
domain: CallSession
the hydra core vocabulary: updatedAt
range: dateTime

CallSession/deletedAt
type: Property
domain: CallSession
the hydra core vocabulary: deletedAt
range: dateTime

CallSession/company
type: Link
domain: CallSession
the hydra core vocabulary: company
max cardinality: 1
range: Company

CallSession/beenCountedForUser
type: Property
domain: CallSession
the hydra core vocabulary: beenCountedForUser

Company
type: Class
title: Company
supported property: SupportedProperty
  property: Company/name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/domain
  title: domain
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/phone
  title: phone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/address
  title: address
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/logo
  title: logo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/settings
  title: settings
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/isActive
  title: isActive
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: Company/users
  title: users
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/phoneNumbers
  title: phoneNumbers
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/welcomeMessages
  title: welcomeMessages
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/notificationSettings
  title: notificationSettings
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Company/notificationChannelEnabled
  title: notificationChannelEnabled
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Company/notificationChannel
  title: notificationChannel
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: Company/active
  title: active
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Company resource.
  method: GET
  returns: Company
  title: getCompany
supported operation: Operation
  description: Updates the Company resource.
  expects: Company
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/json
  method: PATCH
  returns: Company
  title: patchCompany
supported operation: Operation
  type: DeleteAction
  description: Deletes the Company resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteCompany
supported operation: Operation
  type: FindAction
  description: Retrieves a Company resource.
  method: GET
  returns: Company
  title: getCompany

Company/name
type: Property
domain: Company
the hydra core vocabulary: name
range: string

Company/domain
type: Property
domain: Company
the hydra core vocabulary: domain
range: string

Company/description
type: Property
domain: Company
the hydra core vocabulary: description
range: string

Company/email
type: Property
domain: Company
the hydra core vocabulary: email
range: string

Company/phone
type: Property
domain: Company
the hydra core vocabulary: phone
range: string

Company/address
type: Property
domain: Company
the hydra core vocabulary: address
range: string

Company/logo
type: Link
domain: Company
the hydra core vocabulary: logo
max cardinality: 1
range: MediaObject

Company/settings
type: Property
domain: Company
the hydra core vocabulary: settings

Company/isActive
type: Property
domain: Company
the hydra core vocabulary: isActive
range: boolean

Company/users
type: Link
domain: Company
the hydra core vocabulary: users
range: User

Company/phoneNumbers
type: Link
domain: Company
the hydra core vocabulary: phoneNumbers
range: PhoneNumber

Company/welcomeMessages
type: Link
domain: Company
the hydra core vocabulary: welcomeMessages
range: WelcomeMessage

Company/createdAt
type: Property
domain: Company
the hydra core vocabulary: createdAt
range: dateTime

Company/updatedAt
type: Property
domain: Company
the hydra core vocabulary: updatedAt
range: dateTime

Company/notificationSettings
type: Property
domain: Company
the hydra core vocabulary: notificationSettings

Company/notificationChannelEnabled
type: Property
domain: Company
the hydra core vocabulary: notificationChannelEnabled

Company/notificationChannel
type: Property
domain: Company
the hydra core vocabulary: notificationChannel
range: string

Company/active
type: Property
domain: Company
the hydra core vocabulary: active
range: boolean

MediaObject
type: Class
title: MediaObject
supported property: SupportedProperty
  property: MediaObject/contentUrl
  title: contentUrl
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: MediaObject/file
  title: file
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: MediaObject/filePath
  title: filePath
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: MediaObject/originalName
  title: originalName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: MediaObject/mimeType
  title: mimeType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: MediaObject/extension
  title: extension
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: MediaObject/size
  title: size
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: MediaObject/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: MediaObject/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a MediaObject resource.
  method: GET
  returns: MediaObject
  title: getMediaObject
supported operation: Operation
  type: FindAction
  description: Retrieves a MediaObject resource.
  method: GET
  returns: MediaObject
  title: getMediaObject
supported operation: Operation
  type: DeleteAction
  description: Deletes the MediaObject resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteMediaObject

MediaObject/contentUrl
type: Property
domain: MediaObject
the hydra core vocabulary: contentUrl
range: string

MediaObject/file
type: Property
domain: MediaObject
the hydra core vocabulary: file

MediaObject/filePath
type: Property
domain: MediaObject
the hydra core vocabulary: filePath
range: string

MediaObject/originalName
type: Property
domain: MediaObject
the hydra core vocabulary: originalName
range: string

MediaObject/mimeType
type: Property
domain: MediaObject
the hydra core vocabulary: mimeType
range: string

MediaObject/extension
type: Property
domain: MediaObject
the hydra core vocabulary: extension
range: string

MediaObject/size
type: Property
domain: MediaObject
the hydra core vocabulary: size
range: integer

MediaObject/createdAt
type: Property
domain: MediaObject
the hydra core vocabulary: createdAt
range: dateTime

MediaObject/updatedAt
type: Property
domain: MediaObject
the hydra core vocabulary: updatedAt
range: dateTime

PhoneNumber
type: Class
title: PhoneNumber
supported property: SupportedProperty
  property: PhoneNumber/phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneNumber/company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneNumber/activeWelcomeMessage
  title: activeWelcomeMessage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneNumber/active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneNumber/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneNumber/callSessions
  title: callSessions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneNumber/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneNumber/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PhoneNumber/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a PhoneNumber resource.
  method: GET
  returns: PhoneNumber
  title: getPhoneNumber
supported operation: Operation
  description: Updates the PhoneNumber resource.
  expects: PhoneNumber
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/json
  method: PATCH
  returns: PhoneNumber
  title: patchPhoneNumber
supported operation: Operation
  type: DeleteAction
  description: Deletes the PhoneNumber resource.
  method: DELETE
  returns: owl:Nothing
  title: deletePhoneNumber

PhoneNumber/phoneNumber
type: Property
domain: PhoneNumber
the hydra core vocabulary: phoneNumber
range: string

PhoneNumber/company
type: Link
domain: PhoneNumber
the hydra core vocabulary: company
max cardinality: 1
range: Company

PhoneNumber/activeWelcomeMessage
type: Link
domain: PhoneNumber
the hydra core vocabulary: activeWelcomeMessage
max cardinality: 1
range: WelcomeMessage

PhoneNumber/active
type: Property
domain: PhoneNumber
the hydra core vocabulary: active
range: boolean

PhoneNumber/description
type: Property
domain: PhoneNumber
the hydra core vocabulary: description
range: string

PhoneNumber/callSessions
type: Link
domain: PhoneNumber
the hydra core vocabulary: callSessions
range: CallSession

PhoneNumber/createdAt
type: Property
domain: PhoneNumber
the hydra core vocabulary: createdAt
range: dateTime

PhoneNumber/updatedAt
type: Property
domain: PhoneNumber
the hydra core vocabulary: updatedAt
range: dateTime

PhoneNumber/deletedAt
type: Property
domain: PhoneNumber
the hydra core vocabulary: deletedAt
range: dateTime

Settings
type: Class
title: Settings
supported property: SupportedProperty
  property: Settings/settingKey
  title: settingKey
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Settings/settingValue
  title: settingValue
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Settings/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Settings/settingType
  title: settingType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Settings/category
  title: category
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Settings/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Settings/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Settings resource.
  method: GET
  returns: Settings
  title: getSettings
supported operation: Operation
  description: Updates the Settings resource.
  expects: Settings
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/json
  method: PATCH
  returns: Settings
  title: patchSettings

Settings/settingKey
type: Property
domain: Settings
the hydra core vocabulary: settingKey
range: string

Settings/settingValue
type: Property
domain: Settings
the hydra core vocabulary: settingValue
range: string

Settings/description
type: Property
domain: Settings
the hydra core vocabulary: description
range: string

Settings/settingType
type: Property
domain: Settings
the hydra core vocabulary: settingType
range: string

Settings/category
type: Property
domain: Settings
the hydra core vocabulary: category
range: string

Settings/createdAt
type: Property
domain: Settings
the hydra core vocabulary: createdAt
range: dateTime

Settings/updatedAt
type: Property
domain: Settings
the hydra core vocabulary: updatedAt
range: dateTime

User
type: Class
title: User
supported property: SupportedProperty
  property: User/email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/password
  title: password
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/firstname
  title: firstname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/lastname
  title: lastname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/confirmationToken
  title: confirmationToken
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/tokenExpiration
  title: tokenExpiration
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/passwordChangeDate
  title: passwordChangeDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/googleId
  title: googleId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/avatarUrl
  title: avatarUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/authProvider
  title: authProvider
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/hasUnlockedMessages
  title: hasUnlockedMessages
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: User/unlockedMessagesAt
  title: unlockedMessagesAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/stripeCustomerId
  title: stripeCustomerId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/stripeSubscriptionId
  title: stripeSubscriptionId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/subscriptionStatus
  title: subscriptionStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/subscriptionStartedAt
  title: subscriptionStartedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/subscriptionEndedAt
  title: subscriptionEndedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/subscriptionCurrentPeriodEnd
  title: subscriptionCurrentPeriodEnd
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/subscriptionRecurrency
  title: subscriptionRecurrency
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/subscriptionTier
  title: subscriptionTier
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/monthlyMessageCount
  title: monthlyMessageCount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/monthlyQuotaResetAt
  title: monthlyQuotaResetAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: User/userIdentifier
  title: userIdentifier
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: User/accessToCompany
  title: accessToCompany
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: User/companyAdmin
  title: companyAdmin
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: User/superAdmin
  title: superAdmin
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: User/admin
  title: admin
  required: false
  readable: true
  writeable: false
supported operation: Operation

User/email
type: Property
domain: User
the hydra core vocabulary: email
range: string

User/roles
type: Property
domain: User
the hydra core vocabulary: roles

User/password
type: Property
domain: User
the hydra core vocabulary: password
range: string

User/firstname
type: Property
domain: User
the hydra core vocabulary: firstname
range: string

User/lastname
type: Property
domain: User
the hydra core vocabulary: lastname
range: string

User/enabled
type: Property
domain: User
the hydra core vocabulary: enabled
range: boolean

User/confirmationToken
type: Property
domain: User
the hydra core vocabulary: confirmationToken
range: string

User/tokenExpiration
type: Property
domain: User
the hydra core vocabulary: tokenExpiration
range: dateTime

User/passwordChangeDate
type: Property
domain: User
the hydra core vocabulary: passwordChangeDate
range: dateTime

User/googleId
type: Property
domain: User
the hydra core vocabulary: googleId
range: string

User/avatarUrl
type: Property
domain: User
the hydra core vocabulary: avatarUrl
range: string

User/authProvider
type: Property
domain: User
the hydra core vocabulary: authProvider
range: string

User/company
type: Link
domain: User
the hydra core vocabulary: company
max cardinality: 1
range: Company

User/hasUnlockedMessages
type: Property
domain: User
the hydra core vocabulary: hasUnlockedMessages
range: boolean

User/unlockedMessagesAt
type: Property
domain: User
the hydra core vocabulary: unlockedMessagesAt
range: dateTime

User/stripeCustomerId
type: Property
domain: User
the hydra core vocabulary: stripeCustomerId
range: string

User/stripeSubscriptionId
type: Property
domain: User
the hydra core vocabulary: stripeSubscriptionId
range: string

User/subscriptionStatus
type: Property
domain: User
the hydra core vocabulary: subscriptionStatus
range: string

User/subscriptionStartedAt
type: Property
domain: User
the hydra core vocabulary: subscriptionStartedAt
range: dateTime

User/subscriptionEndedAt
type: Property
domain: User
the hydra core vocabulary: subscriptionEndedAt
range: dateTime

User/subscriptionCurrentPeriodEnd
type: Property
domain: User
the hydra core vocabulary: subscriptionCurrentPeriodEnd
range: dateTime

User/subscriptionRecurrency
type: Property
domain: User
the hydra core vocabulary: subscriptionRecurrency

User/subscriptionTier
type: Property
domain: User
the hydra core vocabulary: subscriptionTier

User/monthlyMessageCount
type: Property
domain: User
the hydra core vocabulary: monthlyMessageCount
range: integer

User/monthlyQuotaResetAt
type: Property
domain: User
the hydra core vocabulary: monthlyQuotaResetAt
range: dateTime

User/createdAt
type: Property
domain: User
the hydra core vocabulary: createdAt
range: dateTime

User/updatedAt
type: Property
domain: User
the hydra core vocabulary: updatedAt
range: dateTime

User/deletedAt
type: Property
domain: User
the hydra core vocabulary: deletedAt
range: dateTime

User/userIdentifier
type: Property
domain: User
the hydra core vocabulary: userIdentifier
range: string

User/accessToCompany
type: Property
domain: User
the hydra core vocabulary: accessToCompany

User/companyAdmin
type: Property
domain: User
the hydra core vocabulary: companyAdmin

User/superAdmin
type: Property
domain: User
the hydra core vocabulary: superAdmin
range: boolean

User/admin
type: Property
domain: User
the hydra core vocabulary: admin
range: boolean

User/unlockedMessages
type: Property
domain: User
the hydra core vocabulary: unlockedMessages
range: boolean

User/activeSubscription
type: Property
domain: User
the hydra core vocabulary: activeSubscription
range: boolean

User/premiumAccess
type: Property
domain: User
the hydra core vocabulary: premiumAccess
range: boolean

WelcomeMessage
type: Class
title: WelcomeMessage
supported property: SupportedProperty
  property: WelcomeMessage/name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WelcomeMessage/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WelcomeMessage/audioFile
  title: audioFile
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WelcomeMessage/company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WelcomeMessage/assignedPhoneNumbers
  title: assignedPhoneNumbers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: WelcomeMessage/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: WelcomeMessage/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a WelcomeMessage resource.
  method: GET
  returns: WelcomeMessage
  title: getWelcomeMessage
supported operation: Operation
  description: Updates the WelcomeMessage resource.
  expects: WelcomeMessage
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/json
  method: PATCH
  returns: WelcomeMessage
  title: patchWelcomeMessage
supported operation: Operation
  description: Updates the WelcomeMessage resource.
  expects: WelcomeMessage
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/json
  method: PATCH
  returns: WelcomeMessage
  title: patchWelcomeMessage
supported operation: Operation
  type: DeleteAction
  description: Deletes the WelcomeMessage resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteWelcomeMessage

WelcomeMessage/name
type: Property
domain: WelcomeMessage
the hydra core vocabulary: name
range: string

WelcomeMessage/description
type: Property
domain: WelcomeMessage
the hydra core vocabulary: description
range: string

WelcomeMessage/audioFile
type: Link
domain: WelcomeMessage
the hydra core vocabulary: audioFile
max cardinality: 1
range: MediaObject

WelcomeMessage/company
type: Link
domain: WelcomeMessage
the hydra core vocabulary: company
max cardinality: 1
range: Company

WelcomeMessage/assignedPhoneNumbers
type: Link
domain: WelcomeMessage
the hydra core vocabulary: assignedPhoneNumbers
range: PhoneNumber

WelcomeMessage/createdAt
type: Property
domain: WelcomeMessage
the hydra core vocabulary: createdAt
range: dateTime

WelcomeMessage/updatedAt
type: Property
domain: WelcomeMessage
the hydra core vocabulary: updatedAt
range: dateTime

Entrypoint
type: Class
title: Entrypoint
supported property: SupportedProperty
  property: Entrypoint/applicationToken
  title: getApplicationTokenCollection
  description: The collection of ApplicationToken resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/callEvent
  title: getCallEventCollection
  description: The collection of CallEvent resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/callSession
  title: getCallSessionCollection
  description: The collection of CallSession resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/company
  title: getCompanyCollection
  description: The collection of Company resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/mediaObject
  title: getMediaObjectCollection
  description: The collection of MediaObject resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/phoneNumber
  title: getPhoneNumberCollection
  description: The collection of PhoneNumber resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/settings
  title: getSettingsCollection
  description: The collection of Settings resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/user
  title: getUserCollection
  description: The collection of User resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/welcomeMessage
  title: getWelcomeMessageCollection
  description: The collection of WelcomeMessage resources
  readable: true
  writeable: false
supported operation: Operation
  method: GET
  title: index
  description: The API Entrypoint.
  returns: Entrypoint

Entrypoint/applicationToken
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ApplicationToken
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of ApplicationToken resources.
  method: GET
  returns: Collection
  title: getApplicationTokenCollection
supported operation: Operation
  type: CreateAction
  description: Creates a ApplicationToken resource.
  expects: ApplicationToken
  method: POST
  returns: ApplicationToken
  title: postApplicationToken

Entrypoint/callEvent
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CallEvent
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of CallEvent resources.
  method: GET
  returns: Collection
  title: getCallEventCollection
supported operation: Operation
  type: CreateAction
  description: Creates a CallEvent resource.
  expects: CallEvent
  method: POST
  returns: CallEvent
  title: postCallEvent
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of CallEvent resources.
  method: GET
  returns: Collection
  title: getCallEventCollection

Entrypoint/callSession
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CallSession
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of CallSession resources.
  method: GET
  returns: Collection
  title: getCallSessionCollection

Entrypoint/company
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Company
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Company resources.
  method: GET
  returns: Collection
  title: getCompanyCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Company resource.
  expects: Company
  method: POST
  returns: Company
  title: postCompany

Entrypoint/mediaObject
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: MediaObject
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of MediaObject resources.
  method: GET
  returns: Collection
  title: getMediaObjectCollection
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of MediaObject resources.
  method: GET
  returns: Collection
  title: getMediaObjectCollection
supported operation: Operation
  type: CreateAction
  description: Creates a MediaObject resource.
  expects: MediaObject
  method: POST
  returns: MediaObject
  title: postMediaObject

Entrypoint/phoneNumber
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: PhoneNumber
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of PhoneNumber resources.
  method: GET
  returns: Collection
  title: getPhoneNumberCollection
supported operation: Operation
  type: CreateAction
  description: Creates a PhoneNumber resource.
  expects: PhoneNumber
  method: POST
  returns: PhoneNumber
  title: postPhoneNumber

Entrypoint/settings
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Settings
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Settings resources.
  method: GET
  returns: Collection
  title: getSettingsCollection

Entrypoint/user
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of User resources.
  method: GET
  returns: Collection
  title: getUserCollection
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of User resources.
  method: GET
  returns: Collection
  title: getUserCollection
supported operation: Operation
  type: CreateAction
  description: Creates a User resource.
  expects: User
  method: POST
  returns: User
  title: postUser
supported operation: Operation
  type: CreateAction
  description: Creates a User resource.
  expects: User
  method: POST
  returns: User
  title: postUser
supported operation: Operation
  type: CreateAction
  description: Creates a User resource.
  expects: User
  method: POST
  returns: User
  title: postUser
supported operation: Operation
  type: CreateAction
  description: Creates a User resource.
  expects: User
  method: POST
  returns: User
  title: postUser
supported operation: Operation
  type: CreateAction
  description: Creates a User resource.
  expects: User
  method: POST
  returns: User
  title: postUser
supported operation: Operation
  type: CreateAction
  description: Creates a User resource.
  expects: User
  method: POST
  returns: User
  title: postUser
supported operation: Operation
  type: CreateAction
  description: Creates a User resource.
  expects: User
  method: POST
  returns: User
  title: postUser
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of User resources.
  method: GET
  returns: Collection
  title: getUserCollection

Entrypoint/welcomeMessage
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: WelcomeMessage
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of WelcomeMessage resources.
  method: GET
  returns: Collection
  title: getWelcomeMessageCollection
supported operation: Operation
  type: CreateAction
  description: Creates a WelcomeMessage resource.
  expects: WelcomeMessage
  method: POST
  returns: WelcomeMessage
  title: postWelcomeMessage

ConstraintViolationList
type: Class
title: ConstraintViolationList
description: A constraint violation List.
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolationList
range: string

message
type: Property
domain: ConstraintViolationList
range: string

SupportedProperty
property: User/unlockedMessages
title: unlockedMessages
required: false
readable: true
writeable: false

SupportedProperty
property: User/activeSubscription
title: activeSubscription
required: false
readable: true
writeable: false

SupportedProperty
property: User/premiumAccess
title: premiumAccess
required: false
readable: true
writeable: false

Operation
type: FindAction
description: Retrieves a User resource.
method: GET
returns: User
title: getUser

Operation
type: FindAction
description: Retrieves a User resource.
method: GET
returns: User
title: getUser

Operation
description: Updates the User resource.
expects: User
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
  possible value: application/json
method: PATCH
returns: User
title: patchUser

Operation
type: ReplaceAction
description: Replaces the User resource.
expects: User
method: PUT
returns: User
title: putUser

Operation
type: DeleteAction
description: Deletes the User resource.
method: DELETE
returns: owl:Nothing
title: deleteUser

Operation
type: FindAction
description: Retrieves a User resource.
method: GET
returns: User
title: getUser