Global

Methods

createTestUser(props)

Source:
Properties:
Name Type Attributes Description
productId number <optional>
 The product ID to associate with the test user.
createdAt Date <optional>
 The creation date for the test user.
Parameters:
Name Type Description
props CreateTestUserProps The parameters for creating a test user.

Type Definitions

AddItemToPlaylistDTO

Source:
Properties:
Name Type Description
content_id number The ID of the content to add to the playlist(s).
playlist_id Array.<number> An array of playlist IDs where the content should be added.
skip_duplicates Array.<number> An array of playlist IDs to skip duplicated content
position number Optional playlist position requirement
import_high_routine boolean Flag to include high routine content.
import_low_routine boolean Flag to include low routine content.

AuthKeyResponse

Source:
Properties:
Name Type Description
user_id number
auth_key string
Type:
  • Object

AuthResponse

Source:
Properties:
Name Type Description
token string
user User
Type:
  • Object

AwardCallbackFunction(award) → {void}

Source:
Parameters:
Name Type Description
award AwardCallbackPayload Award data when an award is earned
Returns:
Type
void

AwardCallbackPayload

Source:
Properties:
Name Type Description
awardId string Unique Sanity award ID
name string Display name of the award
badge string URL to badge image
contentType string Content type ('guided-course' or 'learning-path-v2')
completed_at string ISO timestamp of completion
completion_data AwardCompletionData Practice statistics
Type:
  • Object

AwardCompletionData

Source:
Properties:
Name Type Description
completed_at string ISO timestamp of completion
days_user_practiced number Number of days the user practiced
practice_minutes number Total practice time in minutes
content_title string Title of the completed content
message string Congratulations message for display
Type:
  • Object

AwardDefinition

Source:
Properties:
Name Type Description
_id string Unique Sanity award ID
is_active boolean Whether the award is active
name string Display name of the award
logo string | null URL to logo image
{string|null badge - URL to badge image
badge_rear string | null URL to badge rear image
award string URL to award image
content_id number Railcontent ID of the parent content (e.g., the learning path ID)
content_type string Type of parent content ('learning-path-v2', 'guided-course', etc.). Used with content_id to determine collection context for award evaluation.
type string Sanity document type
brand string Brand (drumeo, pianote, guitareo, singeo)
content_title string Title of the associated content
award_custom_text string | null Custom text for the award
instructor_name string | null Name of the instructor
child_ids Array.<number> Array of child content IDs (lessons) that must be completed to earn this award
Type:
  • Object

AwardInfo

Source:
Properties:
Name Type Description
awardId string Unique Sanity award ID
awardTitle string Display name of the award
awardType string Type of the award
hasCertificate boolean flag to indicate if the award includes a downloadable certificate
badge string | null URL to badge image
badge_rear string | null URL to badge rear image
badge_logo string | null URL to logo image
badge_template string | null URL to badge front template image
badge_template_rear string | null URL to badge rear template image
award string URL to award image
brand string Brand (drumeo, pianote, guitareo, singeo, playbass)
instructorName string | null Name of the instructor
progressPercentage number Completion percentage (0-100). Progress is tracked per collection context for learning paths.
isCompleted boolean Whether the award is fully completed
completedAt string | null ISO timestamp of completion, or null if not completed
completionData AwardCompletionData | null Practice statistics, or null if not started
Type:
  • Object

AwardPaginationOptions

Source:
Properties:
Name Type Attributes Description
limit number <optional>
 Maximum number of results to return
offset number <optional>
 Number of results to skip for pagination
Type:
  • Object

AwardStatistics

Source:
Properties:
Name Type Description
totalAvailable number Total number of awards available
completed number Number of completed awards
inProgress number Number of awards in progress
notStarted number Number of awards not yet started
completionPercentage number Overall completion percentage (0-100)
Type:
  • Object

BlockedUsersDTO

Source:
Properties:
Name Type Description
id number
display_name string
profile_picture_url string | null
Type:
  • Object

BrandMethodLevels

Source:
Properties:
Name Type Description
drumeo string
pianote string
guitareo string
singeo string
Type:
  • object

BrandTimePracticed

Source:
Properties:
Name Type Description
drumeo number
pianote number
guitareo number
singeo number
Type:
  • object

BrandTotalXp

Source:
Properties:
Name Type Description
drumeo string
pianote string
guitareo string
singeo string
Type:
  • object

CompletionData

Source:
Properties:
Name Type Description
content_title string Title of the completed content
completed_at string ISO timestamp of completion
days_user_practiced number Number of days the user practiced
practice_minutes number Total practice time in minutes
Type:
  • Object

ContentAwardsResponse

Source:
Properties:
Name Type Description
hasAwards boolean Whether the content has any associated awards
awards Array.<AwardInfo> Array of award objects with progress information. For learning paths, progress is scoped to the specific learning path context.
Type:
  • Object

CreatePlaylistDTO

Source:
Properties:
Name Type Description
name string The name of the new playlist. (required, max 255 characters)
description string A description of the playlist. (optional, max 1000 characters)
category string The category of the playlist.
thumbnail_url string The URL of the playlist thumbnail. (optional, must be a valid URL)
private boolean Whether the playlist is private. (optional, defaults to false)
brand string Brand identifier for the playlist.

DuplicatePlaylistDTO

Source:
Properties:
Name Type Description
name string The name of the new playlist. (required, max 255 characters)
description string A description of the playlist. (optional, max 1000 characters)
category string The category of the playlist.
thumbnail_url string The URL of the playlist thumbnail. (optional, must be a valid URL)
private boolean Whether the playlist is private. (optional, defaults to false)
brand string Brand identifier for the playlist.
items array Ids of playlist items to duplicate (in order)

OtherStatsDTO

Source:
Properties:
Name Type Description
longest_day_streak StreakDTO
longest_week_streak StreakDTO
total_practice_time number
comment_likes number
forum_post_likes number
experience_points number
Type:
  • Object
Source:
Properties:
Name Type Description
first string URL of the first page
last string URL of the last page
next string URL of the next page
prev string URL of the previous page
Type:
  • Object

PaginatedMeta

Source:
Properties:
Name Type Description
current_page number Total number of items
from number First index of returned data
to number Last index of returned data
per_page number Total number of items per page
last_page number Last page accessed
total number Total number of items
path string Url of the current page
Type:
  • Object

PaginatedResponse

Source:
Properties:
Name Type Description
meta PaginatedMeta Meta information
links PaginatedLinks Links information
data Array.<T> Data
Type:
  • Object.<T>

Playlist

Source:
Properties:
Name Type Description
id number
brand string
name string
description string
duplicated_count number
duration_formated string
first_4_items_thumbnail_url Array.<string>
total_items number
likes number
pinned boolean
is_my_playlist boolean
user User

ProgressCallbackFunction(progress) → {void}

Source:
Parameters:
Name Type Description
progress ProgressCallbackPayload Progress data when award progress changes
Returns:
Type
void

ProgressCallbackPayload

Source:
Properties:
Name Type Description
awardId string Unique Sanity award ID
progressPercentage number Completion percentage (0-100)
Type:
  • Object

SetUserSignatureParams

Source:
Properties:
Name Type Description
signature string The signature text to set for the user.
Type:
  • Object

StreakDTO

Source:
Properties:
Name Type Description
type string week or day
length number
start_date Date | null
end_date Date | null
Type:
  • Object

UnregisterFunction() → {void}

Source:
Returns:
Type
void

UpdatePlaylistDTO

Source:
Properties:
Name Type Description
name string The name of the new playlist. (required, max 255 characters)
description string A description of the playlist. (optional, max 1000 characters)
category string The category of the playlist. (optional, max 255 characters)
is_private boolean Whether the playlist is private. (optional, defaults to false)
deleted_items Array.<number> List of playlist items to be deleted. (optional)
item_order Array.<number> List of all remaining playlist item ids (not content_ids) provided in the new order. (optional)

User

Source:
Properties:
Name Type Description
id number
email string
display_name string
first_name string
last_name string
gender string | null
country string
region string | null
city string | null
birthday string
phone_number string | null
profile_picture_url string
timezone string
permission_level string
last_used_brand string
membership_level string
membership_start_date string | null
membership_expiration_date string
is_lifetime_member number
revenuecat_origin_app_user_id string | null
is_drumeo_lifetime_member number
access_level string
brand_method_levels BrandMethodLevels
brand_minutes_practiced BrandTimePracticed
brand_seconds_practiced BrandTimePracticed
guitar_playing_since_year number | null
drumeo_onboarding_skip_setup number
pianote_onboarding_skip_setup number
guitareo_onboarding_skip_setup number
singeo_onboarding_skip_setup number
drumeo_trial_section_hide number
pianote_trial_section_hide number
guitareo_trial_section_hide number
singeo_trial_section_hide number
notify_on_lesson_comment_like number
notifications_summary_frequency_minutes number | null
notify_on_forum_post_reply number
notify_on_forum_followed_thread_reply number
notify_on_forum_post_like number
notify_weekly_update number
notify_on_lesson_comment_reply number
challenges_enrollment_notifications number | null
challenges_community_notifications number | null
challenges_solo_notifications number | null
send_mobile_app_push_notifications number
send_email_notifications number
use_legacy_video_player number
use_student_view boolean
show_admin_toggle boolean
drumeo_ship_magazine number
magazine_shipping_address_id string | null
ios_latest_review_display_date string | null
ios_count_review_display number
google_latest_review_display_date string | null
google_count_review_display number
biography string | null
support_note string | null
created_at string
updated_at string
is_pack_owner number
has_recharge_subscription number
recharge_interval string | null
has_apple_subscription number
has_google_subscription number
requires_password_update number
cio_synced_workspaces number
recharge_renewal_date string | null
trial_expiration_date string | null
is_trial number
legacy_expiration_date string | null
needs_logout boolean
primary_brand string
first_access_at string
is_challenge_owner number
login_as_users boolean
Type:
  • Object

UserPermissions

Source:
Properties:
Name Type Description
permissions Array.<string>
isAdmin boolean
isABasicMember boolean
Type:
  • Object