Ume Schemas

Offers database definitions, schemas and models:

• contacts
• events
• givebacks
• products
• merchandises
• music
• umes
• useraccesschanges
• users
• videos

Setup

To open connection to MongoDB, you need to call db.open and pass connection string.

General

• db: db object
• ObjectId: Mongoose.Types.ObjectId

##users Following objects are available for the users collection:

• user.schema: Mongoonse schema for the users collection
• user.Model: Mongoose model for the users collection
• user.definition: Schema definition for the users collection
• user.statuses: Various statuses for a user as an array

db = require '@connectonume/ume-module-schemas'
{user} = db
{schema, Model, definition, statuses} = user

doc = new Model()

##events Following objects are available for the events collection:

• event.schema: Mongoose schema for the events collection
• event.Model: Mongoose model for the events collection
• event.definition: Schema definition for the events collection
• event.statuses: Available statuses for event.status field
• event.ageRestrictions: Available values for event.ageRestriction field

##contacts Following objects are available for the contacts collection:

• contact.schema: Mongoose schema for the contacts collection.
• contact.Model : Mongoose model for the contacts collection.
• contact.definition: Schema definition for the contacts collection.

db = require '@connectonume/ume-module-schemas'
{event} = db
{schema, Model, definition, statuses} = event

doc = new Model()

##umes Following objects are available for the umes collection:

• ume.Model: Mongoose model for the umes collection.
• ume.definition: Schema definition for the umes collection.
• ume.schema: Mongoose schema for the umes collection.
• ume.statuses: Available statuses for ume.status field.
• ume.types: Available types for ume.type field.
• ume.inquiryFormFields: Available types for ume.bookingInquiryForm.fields field.

db = require '@connectonume/ume-module-schemas'
{ume} = db
{schema, Model, definition, statuses, types, inquiryFormFields} = ume

doc = new Model()

##videos Following objects are available for the videos collection:

• video.Model: Mongoose model for the videos collection.
• video.definition: Schema definition for the videos collection.
• video.schema: Mongoose Schema for the videos collection.
• video.sources: Available statuses for video.source field.

##products Following objects are available for the products collection:

• product.Model: Mongoose model for the products collection.
• product.definition: Schema definition for the products collection.
• product.schema: Mongoose Schema for the products collection.
• product.statuses: Available statuses for product.status field.

db = require '@connectonume/ume-module-schemas'
{product} = db
{schema, Model, definition, statuses} = product

doc = new Model()

##merchandises Following objects are avaialble for the merchandises collection:

• merchandise.Model: Mongoose model for the merchandise collection.
• merchandise.definition: Schema definition for the merchandise collection.
• merchandise.schema: Mongoose Schema for the merchandise collection.
• merchandise.taxTypes: Available tax types for tax.type field.

##music Following objects are avaialble for the music collection:

• music.Model: Mongoose model
• music.definition: Schema definition
• music.schema: Mongoose Schema
• music.types: available values for type field
• music.statuses: available values for status field
• music.trackDefinition: tracks field item definition
• music.trackPlaybackTypes: available values for tracks[].playback field

Usage example:

db = require '@connectonume/ume-module-schemas'
{music} = db
{ schema, Model, definition, statuses, types,
  trackDefinition, trackPlaybackTypes } = music

doc = new Model()

##useraccesschanges Following objects are avaialble for the useraccesschanges collection:

• userAccessChange.schema: Mongoose schema for the useraccesschanges collection.

• userAccessChange.Model : Mongoose model for the useraccesschanges collection.

• userAccessChange.definition: Schema definition for the useraccesschanges collection.

##givebacks Following objects are avaialble for the givebacks collection:

• giveback.schema: Mongoose schema for the givebacks collection.

• giveback.Model: Mongoose model for the givebacks collection.

• giveback.definition: Schema definition for the givebacks collection.

• giveback.notifyTypes: Available types for notify field.

##media Following objects are avaialble for the media collection:

• media.schema: Mongoose schema for the media collection.
• media.Model : Mongoose model for the media collection.
• media.definition: Schema definition for the media collection.
• media.getMedia(umeId, mediaId, path, cb): Helper to get specified media that belongs to specified ume.
• media.getMedias(umeId, collection, collectionPath, mediaIdPath, cb): Helper to get specified multiple medias that belong to specified ume.

##timezone Following objects are avaialble for the timezones collection:

• timezone.schema: Mongoose schema for the timezones collection.

• timezone.Model : Mongoose model for the timezones collection.

• timezone.definition: Schema definition for the timezones collection.

##donationsettings Following objects are avaialble for the donationsettings collection:

• donationSettings.schema: Mongoose schema for the donationsettings collection.

• donationSettings.Model : Mongoose model for the donationsettings collection.

• donationSettings.definition: Schema definition for the donationsettings collection.

##idempotency Following objects are avaialble for the idempotency collection:

• idempotency.schema: Mongoose schema for the idempotency collection.

• idempotency.Model : Mongoose model for the idempotency collection.

• idempotency.definition: Schema definition for the idempotency collection.

##fan Following objects are avaialble for the fans collection:

• fan.Model: Mongoose model for fans collection.
• fan.definition: Schema definition for fans collection.
• fan.schema: Mongoose schema for fans collection.
• fan.statuses: available values for status field of fans collection.