musora-content-services 1.0.142 → 1.0.144

package/docs/module-Sanity-Services.html

@@ -29,7 +29,7 @@
 <nav >
     
     
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#~initializeService">initializeService</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllSongs">fetchAllSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCatalogMetadata">fetchCatalogMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchChallengeOverview">fetchChallengeOverview</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchChildren">fetchChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCourseOverview">fetchCourseOverview</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodNextLesson">fetchMethodNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethods">fetchMethods</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackChildren">fetchPackChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchParentByRailContentId">fetchParentByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedMethodLessons">fetchRelatedMethodLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongCount">fetchSongCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongFilterOptions">fetchSongFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchWorkouts">fetchWorkouts</a></li></ul></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#~initializeService">initializeService</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllSongs">fetchAllSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCatalogMetadata">fetchCatalogMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchChallengeOverview">fetchChallengeOverview</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchChildren">fetchChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCourseOverview">fetchCourseOverview</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodNextLesson">fetchMethodNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethods">fetchMethods</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackChildren">fetchPackChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchParentByRailContentId">fetchParentByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchParentForDownload">fetchParentForDownload</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedMethodLessons">fetchRelatedMethodLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongCount">fetchSongCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongFilterOptions">fetchSongFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchWorkouts">fetchWorkouts</a></li></ul></li></ul>
     
 </nav>
 
@@ -777,7 +777,7 @@
 
     
 
-    <h4 class="name" id=".fetchAllFilterOptions"><span class="type-signature type-signature-static">(static) </span>fetchAllFilterOptions<span class="signature">(brand, filters, style<span class="signature-attributes">opt</span>, artist<span class="signature-attributes">opt</span>, contentType, term<span class="signature-attributes">opt</span>, progressIds<span class="signature-attributes">opt</span>, coachId<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
+    <h4 class="name" id=".fetchAllFilterOptions"><span class="type-signature type-signature-static">(static) </span>fetchAllFilterOptions<span class="signature">(brand, filters, style<span class="signature-attributes">opt</span>, artist<span class="signature-attributes">opt</span>, contentType, term<span class="signature-attributes">opt</span>, progressIds<span class="signature-attributes">opt</span>, coachId<span class="signature-attributes">opt</span>, includeTabs<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
 
     
 
@@ -787,7 +787,7 @@
 <dl class="details">
     
     <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Fetches all available filter options based on various criteria such as brand, filters, style, artist, content type, and search term.
+    <dd class="tag-description"><ul class="dummy"><li>Fetches all available filter options based on brand, filters, and various optional criteria.
 
 This function constructs a query to retrieve the total number of results and filter options such as difficulty, instrument type, and genre.
 The filter options are dynamically generated based on the provided filters, style, artist, and content type.
@@ -844,13 +844,13 @@ If a coachId is provided, the content type must be 'coach-lessons'.</li></ul></d
 
     <h5 class="h5-examples">Examples</h5>
     
-    <pre class="prettyprint"><code>// Example usage:
-fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'song', 'Love')
+    <pre class="prettyprint"><code>// Fetch filter options for 'song' content type:
+fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'song', 'Love')
   .then(options => console.log(options))
   .catch(error => console.error(error));</code></pre>
 
-    <pre class="prettyprint"><code>// Example usage with coachId:
-fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'coach-lessons', 'Love', undefined, '123')
+    <pre class="prettyprint"><code>// Fetch filter options for a coach's lessons with coachId:
+fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love', undefined, '123')
   .then(options => console.log(options))
   .catch(error => console.error(error));</code></pre>
 
@@ -874,6 +874,8 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'coach-lessons', 'Love'
         
 
         
+        <th>Default</th>
+        
 
         <th class="last">Description</th>
     </tr>
@@ -908,8 +910,12 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'coach-lessons', 'Love'
             
 
             
+                <td class="default">
+                
+                </td>
+            
 
-            <td class="description last">The brand for which to fetch the filter options.</td>
+            <td class="description last">Brand to filter.</td>
         </tr>
 
     
@@ -940,8 +946,12 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'coach-lessons', 'Love'
             
 
             
+                <td class="default">
+                
+                </td>
+            
 
-            <td class="description last">Additional filters to apply to the query in the format of a key,value array. eg. ['difficulty,Intermediate', 'genre,rock']</td>
+            <td class="description last">Key-value pairs to filter the query.</td>
         </tr>
 
     
@@ -974,8 +984,12 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'coach-lessons', 'Love'
             
 
             
+                <td class="default">
+                
+                </td>
+            
 
-            <td class="description last">Optional style or genre to filter the results. If provided, the query will check if the style exists in the genre array.</td>
+            <td class="description last">Optional style/genre filter.</td>
         </tr>
 
     
@@ -1008,8 +1022,12 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'coach-lessons', 'Love'
             
 
             
+                <td class="default">
+                
+                </td>
+            
 
-            <td class="description last">Optional artist name to filter the results. If provided, the query will check if the artist's name matches.</td>
+            <td class="description last">Optional artist name filter.</td>
         </tr>
 
     
@@ -1040,8 +1058,12 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'coach-lessons', 'Love'
             
 
             
+                <td class="default">
+                
+                </td>
+            
 
-            <td class="description last">The content type to fetch (e.g., 'song', 'lesson').</td>
+            <td class="description last">Content type (e.g., 'song', 'lesson').</td>
         </tr>
 
     
@@ -1074,8 +1096,12 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'coach-lessons', 'Love'
             
 
             
+                <td class="default">
+                
+                </td>
+            
 
-            <td class="description last">Optional search term to match against various fields such as title, album, artist name, and genre.</td>
+            <td class="description last">Optional search term for title, album, artist, or genre.</td>
         </tr>
 
     
@@ -1108,8 +1134,12 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'coach-lessons', 'Love'
             
 
             
+                <td class="default">
+                
+                </td>
+            
 
-            <td class="description last">An array of railcontent IDs to filter the results by. Used for filtering by progress.</td>
+            <td class="description last">Optional array of progress IDs to filter by.</td>
         </tr>
 
     
@@ -1142,8 +1172,52 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'coach-lessons', 'Love'
             
 
             
+                <td class="default">
+                
+                </td>
+            
 
-            <td class="description last">Optional coach ID to filter the results by a specific coach. If provided, contentType must be 'coach-lessons'.</td>
+            <td class="description last">Optional coach ID (only valid if contentType is 'coach-lessons').</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>includeTabs</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">boolean</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+                <td class="default">
+                
+                    <code>false</code>
+                
+                </td>
+            
+
+            <td class="description last">Whether to include tabs in the returned metadata.</td>
         </tr>
 
     
@@ -1170,7 +1244,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'coach-lessons', 'Love'
 <dl>
     <dt>
         <div class="param-desc usertext">
-        Will throw an error if coachId is provided but contentType is not 'coach-lessons'.
+        If coachId is provided but contentType isn't 'coach-lessons'.
         </div>
     </dt>
     <dd></dd>
@@ -1199,7 +1273,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'coach-lessons', 'Love'
 
         
 <div class="param-desc">
-    - A promise that resolves to an object containing the total results and filter options, or null if the query fails.
+    - The filter options and metadata.
 </div>
 
 
@@ -1210,7 +1284,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'coach-lessons', 'Love'
     </dt>
     <dd>
         
-<span class="param-type">Promise.&lt;(Object|null)></span>
+<span class="param-type">Promise.&lt;Object></span>
 
 
 
@@ -1242,7 +1316,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'coach-lessons', 'Love'
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1028">line 1028</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1012">line 1012</a>
     </li></ul></dd>
     
 
@@ -2042,7 +2116,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'coach-lessons', 'Love'
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1271">line 1271</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1277">line 1277</a>
     </li></ul></dd>
     
 
@@ -3110,7 +3184,7 @@ fetchAllFilterOptions('myBrand', '', 'Rock', 'John Doe', 'coach-lessons', 'Love'
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1225">line 1225</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1231">line 1231</a>
     </li></ul></dd>
     
 
@@ -3276,7 +3350,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1480">line 1480</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1486">line 1486</a>
     </li></ul></dd>
     
 
@@ -3441,7 +3515,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1146">line 1146</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1130">line 1130</a>
     </li></ul></dd>
     
 
@@ -3606,7 +3680,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line690">line 690</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line673">line 673</a>
     </li></ul></dd>
     
 
@@ -3808,7 +3882,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1171">line 1171</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1155">line 1155</a>
     </li></ul></dd>
     
 
@@ -4251,7 +4325,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1210">line 1210</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1194">line 1194</a>
     </li></ul></dd>
     
 
@@ -4416,7 +4490,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line736">line 736</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line719">line 719</a>
     </li></ul></dd>
     
 
@@ -4574,7 +4648,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1323">line 1323</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1329">line 1329</a>
     </li></ul></dd>
     
 
@@ -5055,7 +5129,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line921">line 921</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line904">line 904</a>
     </li></ul></dd>
     
 
@@ -5220,7 +5294,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1530">line 1530</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1536">line 1536</a>
     </li></ul></dd>
     
 
@@ -5405,7 +5479,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line756">line 756</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line739">line 739</a>
     </li></ul></dd>
     
 
@@ -5587,7 +5661,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line795">line 795</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line778">line 778</a>
     </li></ul></dd>
     
 
@@ -5745,7 +5819,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line849">line 849</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line832">line 832</a>
     </li></ul></dd>
     
 
@@ -5903,7 +5977,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line816">line 816</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line799">line 799</a>
     </li></ul></dd>
     
 
@@ -6085,7 +6159,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line833">line 833</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line816">line 816</a>
     </li></ul></dd>
     
 
@@ -6274,7 +6348,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line724">line 724</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line707">line 707</a>
     </li></ul></dd>
     
 
@@ -6590,7 +6664,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line887">line 887</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line870">line 870</a>
     </li></ul></dd>
     
 
@@ -6748,7 +6822,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1055">line 1055</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1039">line 1039</a>
     </li></ul></dd>
     
 
@@ -6906,7 +6980,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1115">line 1115</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1099">line 1099</a>
     </li></ul></dd>
     
 
@@ -7071,7 +7145,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1129">line 1129</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1113">line 1113</a>
     </li></ul></dd>
     
 
@@ -7233,7 +7307,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line707">line 707</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line690">line 690</a>
     </li></ul></dd>
     
 
@@ -7369,6 +7443,171 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
 
     
 
+    <h4 class="name" id=".fetchParentForDownload"><span class="type-signature type-signature-static">(static) </span>fetchParentForDownload<span class="signature">(id)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
+
+    
+
+
+
+
+<dl class="details">
+    
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li>Fetch the data needed for the Course Overview screen.</li></ul></dd>
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1208">line 1208</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+    <h5 class="h5-examples">Example</h5>
+    
+    <pre class="prettyprint"><code>fetchParentForDownload('course123')
+  .then(course => console.log(course))
+  .catch(error => console.error(error));</code></pre>
+
+
+
+
+    <h5 class="h5-parameters">Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>id</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The Railcontent ID of the course</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5 class="h5-returns">Returns:</h5>
+
+        
+<div class="param-desc">
+    - The course information and lessons or null if not found.
+</div>
+
+
+
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;(Object|null)></span>
+
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+        
+            
+
+    
+
     <h4 class="name" id=".fetchRelatedLessons"><span class="type-signature type-signature-static">(static) </span>fetchRelatedLessons<span class="signature">(railContentId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;(Array.&lt;Object>|null)>}</span></h4>
 
     
@@ -7385,7 +7624,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line982">line 982</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line966">line 966</a>
     </li></ul></dd>
     
 
@@ -7567,7 +7806,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1001">line 1001</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line985">line 985</a>
     </li></ul></dd>
     
 
@@ -7935,7 +8174,7 @@ It's an ongoing discussion (Aug 2024), but it's been included here if necessary<
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1371">line 1371</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1377">line 1377</a>
     </li></ul></dd>
     
 
@@ -8401,7 +8640,7 @@ fetchSanity(query, true)
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1505">line 1505</a>
+        <a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1511">line 1511</a>
     </li></ul></dd>
     
 
@@ -9537,7 +9776,7 @@ It also includes completion status and progress percentage for each workout by f
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Wed Oct 16 2024 19:36:10 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Oct 24 2024 18:49:53 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>