musora-content-services 2.70.0 → 2.70.2

package/src/services/user/onboarding.ts

@@ -14,6 +14,12 @@ export interface OnboardingSteps {
   goals?: string[]
   practice_frequency?: string
   enable_notifications?: boolean
+  recommendation?:
+    | {
+        accepted: true
+        content_id: number
+      }
+    | { accepted: false }
 }
 
 export interface StartOnboardingParams {
@@ -109,3 +115,48 @@ export async function userOnboardingForBrand(brand: string): Promise<Onboarding>
     `/api/user-management-system/v1/users/${globalConfig.sessionConfig.userId}/onboardings/brand/${encodeURIComponent(brand)}`
   )
 }
+
+export interface OnboardingRecommendedContent {
+  id: number
+  title: string
+  difficulty: string
+  lesson_count: number
+  skill_count: number
+  badge: string
+  description: string
+  video: {
+    external_id: string
+    hlsManifestUrl: string
+    type: string
+  }
+}
+
+/**
+ * Fetches recommended content for onboarding based on the specified brand.
+ *
+ * @param {string} brand - The brand identifier.
+ * @returns {Promise<OnboardingRecommendedContent>} - A promise that resolves with the recommended content.
+ * @throws {HttpError} - If the HTTP request fails.
+ */
+export async function getOnboardingRecommendedContent(
+  brand: string
+): Promise<OnboardingRecommendedContent> {
+  // TODO: Replace with real API call when available
+  return {
+    id: 412405,
+    title: 'Getting Started On The Piano',
+    difficulty: 'Beginner',
+    lesson_count: 4,
+    skill_count: 3,
+    badge:
+      'https://cdn.sanity.io/files/4032r8py/staging/9470587f03479b7c1f8019c3cbcbdfe12aa267f3.png',
+    description:
+      'The goal of this course is to introduce you to the keys, and get you playing a song as fast as possible. ',
+    video: {
+      external_id: '1001267395',
+      hlsManifestUrl:
+        'https://player.vimeo.com/external/1001267395.m3u8?s=8f8d8a8a762f688058e6e6fd6704c402baf1b797&oauth2_token_id=1284792283',
+      type: 'vimeo-video',
+    },
+  }
+}

package/src/services/user/payments.ts

@@ -13,13 +13,62 @@ interface CustomerOrder {
   status_url: string
 }
 
+interface PaginationMeta {
+  hasNextPage: boolean
+  hasPreviousPage: boolean
+  startCursor: string | null
+  endCursor: string | null
+}
+
+interface CustomerOrdersResponse {
+  data: CustomerOrder[]
+  meta: {
+    pagination: PaginationMeta
+  }
+}
+
+interface FetchCustomerPaymentsOptions {
+  perPage?: number
+  cursor?: string | null
+}
+
 /**
  * Fetches a list of orders (from Shopify) for the authenticated user (customer).
  *
- * @returns {Promise<CustomerOrder[]>} - A promise that resolves to an array of customer order objects.
+ * @param {FetchCustomerPaymentsOptions} options - Pagination options
+ * @param {number} options.perPage - Number of orders per page (1-100, default: 40)
+ * @param {string|null} options.cursor - Cursor for pagination
+ * @returns {Promise<CustomerOrdersResponse>} - A promise that resolves to customer orders with pagination metadata
  * @throws {HttpError} - Throws HttpError if the request fails.
+ *
+ * @example
+ * // Fetch first page with default page size (40)
+ * const response = await fetchCustomerPayments()
+ *
+ * @example
+ * // Fetch first page with custom page size
+ * const response = await fetchCustomerPayments({ perPage: 20 })
+ *
+ * @example
+ * // Fetch next page using cursor from previous response
+ * const response = await fetchCustomerPayments({
+ *   perPage: 20,
+ *   cursor: previousResponse.meta.pagination.endCursor
+ * })
  */
-export async function fetchCustomerPayments(): Promise<CustomerOrder[]> {
+export async function fetchCustomerPayments(
+  options: FetchCustomerPaymentsOptions = {}
+): Promise<CustomerOrdersResponse> {
   const client = new HttpClient(globalConfig.baseUrl, globalConfig.sessionConfig.authToken)
-  return await client.get<CustomerOrder[]>('/api/customer/orders/v1')
+  const params = new URLSearchParams()
+  if (options.perPage) {
+    params.append('per_page', options.perPage.toString())
+  }
+  if (options.cursor) {
+    params.append('cursor', options.cursor)
+  }
+  const queryString = params.toString()
+  const url = queryString ? `/api/customer/orders/v1?${queryString}` : '/api/customer/orders/v1'
+
+  return await client.get<CustomerOrdersResponse>(url)
 }