perspectapi-ts-sdk 3.3.0 → 3.5.0

package/dist/index.d.mts

@@ -2480,6 +2480,87 @@ declare class SiteUsersClient extends BaseClient {
         success: boolean;
         new_balance_cents: number;
     }>>;
+    /**
+     * List orders for a site (admin only)
+     * @param siteName - The site name
+     * @param params - Query params (limit, offset, status, fulfillment_status)
+     */
+    listOrders(siteName: string, params?: {
+        limit?: number;
+        offset?: number;
+        status?: string;
+        fulfillment_status?: string;
+    }): Promise<ApiResponse<{
+        orders: any[];
+    }>>;
+    /**
+     * Update order fulfillment status (admin only)
+     * @param siteName - The site name
+     * @param sessionId - Checkout session ID
+     * @param data - Fulfillment data
+     */
+    updateOrderFulfillment(siteName: string, sessionId: string, data: {
+        fulfillment_status: string;
+        tracking_number?: string;
+        notes?: string;
+    }): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
+    /**
+     * Get a user's orders (admin only)
+     * @param siteName - The site name
+     * @param userId - User ID
+     * @param params - Pagination params
+     */
+    getUserOrders(siteName: string, userId: string, params?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<ApiResponse<{
+        orders: SiteUserOrder[];
+    }>>;
+    /**
+     * Get a user's subscriptions (admin only)
+     * @param siteName - The site name
+     * @param userId - User ID
+     */
+    getUserSubscriptions(siteName: string, userId: string): Promise<ApiResponse<{
+        subscriptions: SiteUserSubscription[];
+    }>>;
+    /**
+     * Pause a user's subscription (admin only)
+     * @param siteName - The site name
+     * @param userId - User ID
+     * @param subscriptionId - Subscription ID
+     * @param resumesAt - Optional ISO date string when subscription should auto-resume
+     */
+    pauseUserSubscription(siteName: string, userId: string, subscriptionId: string, resumesAt?: string): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
+    /**
+     * Resume a user's paused subscription (admin only)
+     * @param siteName - The site name
+     * @param userId - User ID
+     * @param subscriptionId - Subscription ID
+     */
+    resumeUserSubscription(siteName: string, userId: string, subscriptionId: string): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
+    /**
+     * Cancel a user's subscription (admin only)
+     * @param siteName - The site name
+     * @param userId - User ID
+     * @param subscriptionId - Subscription ID
+     */
+    cancelUserSubscription(siteName: string, userId: string, subscriptionId: string): Promise<ApiResponse<{
+        success: boolean;
+        message: string;
+    }>>;
+    /**
+     * Get a user's credit balance (admin only)
+     * @param siteName - The site name
+     * @param userId - User ID
+     */
+    getUserCreditBalance(siteName: string, userId: string): Promise<ApiResponse<CreditBalance>>;
 }
 
 /**

package/dist/index.d.ts

@@ -2480,6 +2480,87 @@ declare class SiteUsersClient extends BaseClient {
         success: boolean;
         new_balance_cents: number;
     }>>;
+    /**
+     * List orders for a site (admin only)
+     * @param siteName - The site name
+     * @param params - Query params (limit, offset, status, fulfillment_status)
+     */
+    listOrders(siteName: string, params?: {
+        limit?: number;
+        offset?: number;
+        status?: string;
+        fulfillment_status?: string;
+    }): Promise<ApiResponse<{
+        orders: any[];
+    }>>;
+    /**
+     * Update order fulfillment status (admin only)
+     * @param siteName - The site name
+     * @param sessionId - Checkout session ID
+     * @param data - Fulfillment data
+     */
+    updateOrderFulfillment(siteName: string, sessionId: string, data: {
+        fulfillment_status: string;
+        tracking_number?: string;
+        notes?: string;
+    }): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
+    /**
+     * Get a user's orders (admin only)
+     * @param siteName - The site name
+     * @param userId - User ID
+     * @param params - Pagination params
+     */
+    getUserOrders(siteName: string, userId: string, params?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<ApiResponse<{
+        orders: SiteUserOrder[];
+    }>>;
+    /**
+     * Get a user's subscriptions (admin only)
+     * @param siteName - The site name
+     * @param userId - User ID
+     */
+    getUserSubscriptions(siteName: string, userId: string): Promise<ApiResponse<{
+        subscriptions: SiteUserSubscription[];
+    }>>;
+    /**
+     * Pause a user's subscription (admin only)
+     * @param siteName - The site name
+     * @param userId - User ID
+     * @param subscriptionId - Subscription ID
+     * @param resumesAt - Optional ISO date string when subscription should auto-resume
+     */
+    pauseUserSubscription(siteName: string, userId: string, subscriptionId: string, resumesAt?: string): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
+    /**
+     * Resume a user's paused subscription (admin only)
+     * @param siteName - The site name
+     * @param userId - User ID
+     * @param subscriptionId - Subscription ID
+     */
+    resumeUserSubscription(siteName: string, userId: string, subscriptionId: string): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
+    /**
+     * Cancel a user's subscription (admin only)
+     * @param siteName - The site name
+     * @param userId - User ID
+     * @param subscriptionId - Subscription ID
+     */
+    cancelUserSubscription(siteName: string, userId: string, subscriptionId: string): Promise<ApiResponse<{
+        success: boolean;
+        message: string;
+    }>>;
+    /**
+     * Get a user's credit balance (admin only)
+     * @param siteName - The site name
+     * @param userId - User ID
+     */
+    getUserCreditBalance(siteName: string, userId: string): Promise<ApiResponse<CreditBalance>>;
 }
 
 /**

package/dist/index.js

@@ -2614,6 +2614,106 @@ var SiteUsersClient = class extends BaseClient {
       csrfToken
     );
   }
+  /**
+   * List orders for a site (admin only)
+   * @param siteName - The site name
+   * @param params - Query params (limit, offset, status, fulfillment_status)
+   */
+  async listOrders(siteName, params) {
+    return this.http.get(
+      this.buildPath(this.siteUserEndpoint(siteName, "/users/orders")),
+      params
+    );
+  }
+  /**
+   * Update order fulfillment status (admin only)
+   * @param siteName - The site name
+   * @param sessionId - Checkout session ID
+   * @param data - Fulfillment data
+   */
+  async updateOrderFulfillment(siteName, sessionId, data) {
+    return this.patch(
+      this.siteUserEndpoint(siteName, `/users/orders/${encodeURIComponent(sessionId)}/fulfillment`),
+      data
+    );
+  }
+  // ============================================================================
+  // ADMIN USER-SCOPED ENDPOINTS (API key auth required)
+  // These mirror /me/* endpoints but target a specific user by ID.
+  // ============================================================================
+  /**
+   * Get a user's orders (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   * @param params - Pagination params
+   */
+  async getUserOrders(siteName, userId, params) {
+    return this.http.get(
+      this.buildPath(this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/orders`)),
+      params
+    );
+  }
+  /**
+   * Get a user's subscriptions (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   */
+  async getUserSubscriptions(siteName, userId) {
+    return this.getSingle(
+      this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/subscriptions`)
+    );
+  }
+  /**
+   * Pause a user's subscription (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   * @param subscriptionId - Subscription ID
+   * @param resumesAt - Optional ISO date string when subscription should auto-resume
+   */
+  async pauseUserSubscription(siteName, userId, subscriptionId, resumesAt) {
+    const body = {};
+    if (resumesAt) {
+      body.resumes_at = resumesAt;
+    }
+    return this.create(
+      this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/subscriptions/${encodeURIComponent(subscriptionId)}/pause`),
+      body
+    );
+  }
+  /**
+   * Resume a user's paused subscription (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   * @param subscriptionId - Subscription ID
+   */
+  async resumeUserSubscription(siteName, userId, subscriptionId) {
+    return this.create(
+      this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/subscriptions/${encodeURIComponent(subscriptionId)}/resume`),
+      {}
+    );
+  }
+  /**
+   * Cancel a user's subscription (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   * @param subscriptionId - Subscription ID
+   */
+  async cancelUserSubscription(siteName, userId, subscriptionId) {
+    return this.create(
+      this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/subscriptions/${encodeURIComponent(subscriptionId)}/cancel`),
+      {}
+    );
+  }
+  /**
+   * Get a user's credit balance (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   */
+  async getUserCreditBalance(siteName, userId) {
+    return this.getSingle(
+      this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/credits/balance`)
+    );
+  }
 };
 
 // src/client/bundles-client.ts

package/dist/index.mjs

@@ -2551,6 +2551,106 @@ var SiteUsersClient = class extends BaseClient {
       csrfToken
     );
   }
+  /**
+   * List orders for a site (admin only)
+   * @param siteName - The site name
+   * @param params - Query params (limit, offset, status, fulfillment_status)
+   */
+  async listOrders(siteName, params) {
+    return this.http.get(
+      this.buildPath(this.siteUserEndpoint(siteName, "/users/orders")),
+      params
+    );
+  }
+  /**
+   * Update order fulfillment status (admin only)
+   * @param siteName - The site name
+   * @param sessionId - Checkout session ID
+   * @param data - Fulfillment data
+   */
+  async updateOrderFulfillment(siteName, sessionId, data) {
+    return this.patch(
+      this.siteUserEndpoint(siteName, `/users/orders/${encodeURIComponent(sessionId)}/fulfillment`),
+      data
+    );
+  }
+  // ============================================================================
+  // ADMIN USER-SCOPED ENDPOINTS (API key auth required)
+  // These mirror /me/* endpoints but target a specific user by ID.
+  // ============================================================================
+  /**
+   * Get a user's orders (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   * @param params - Pagination params
+   */
+  async getUserOrders(siteName, userId, params) {
+    return this.http.get(
+      this.buildPath(this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/orders`)),
+      params
+    );
+  }
+  /**
+   * Get a user's subscriptions (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   */
+  async getUserSubscriptions(siteName, userId) {
+    return this.getSingle(
+      this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/subscriptions`)
+    );
+  }
+  /**
+   * Pause a user's subscription (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   * @param subscriptionId - Subscription ID
+   * @param resumesAt - Optional ISO date string when subscription should auto-resume
+   */
+  async pauseUserSubscription(siteName, userId, subscriptionId, resumesAt) {
+    const body = {};
+    if (resumesAt) {
+      body.resumes_at = resumesAt;
+    }
+    return this.create(
+      this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/subscriptions/${encodeURIComponent(subscriptionId)}/pause`),
+      body
+    );
+  }
+  /**
+   * Resume a user's paused subscription (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   * @param subscriptionId - Subscription ID
+   */
+  async resumeUserSubscription(siteName, userId, subscriptionId) {
+    return this.create(
+      this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/subscriptions/${encodeURIComponent(subscriptionId)}/resume`),
+      {}
+    );
+  }
+  /**
+   * Cancel a user's subscription (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   * @param subscriptionId - Subscription ID
+   */
+  async cancelUserSubscription(siteName, userId, subscriptionId) {
+    return this.create(
+      this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/subscriptions/${encodeURIComponent(subscriptionId)}/cancel`),
+      {}
+    );
+  }
+  /**
+   * Get a user's credit balance (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   */
+  async getUserCreditBalance(siteName, userId) {
+    return this.getSingle(
+      this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/credits/balance`)
+    );
+  }
 };
 
 // src/client/bundles-client.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "perspectapi-ts-sdk",
-  "version": "3.3.0",
+  "version": "3.5.0",
   "description": "TypeScript SDK for PerspectAPI - Cloudflare Workers compatible",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/client/site-users-client.ts

@@ -464,4 +464,143 @@ export class SiteUsersClient extends BaseClient {
       csrfToken
     );
   }
+
+  /**
+   * List orders for a site (admin only)
+   * @param siteName - The site name
+   * @param params - Query params (limit, offset, status, fulfillment_status)
+   */
+  async listOrders(
+    siteName: string,
+    params?: { limit?: number; offset?: number; status?: string; fulfillment_status?: string }
+  ): Promise<ApiResponse<{ orders: any[] }>> {
+    return this.http.get<{ orders: any[] }>(
+      this.buildPath(this.siteUserEndpoint(siteName, '/users/orders')),
+      params
+    );
+  }
+
+  /**
+   * Update order fulfillment status (admin only)
+   * @param siteName - The site name
+   * @param sessionId - Checkout session ID
+   * @param data - Fulfillment data
+   */
+  async updateOrderFulfillment(
+    siteName: string,
+    sessionId: string,
+    data: { fulfillment_status: string; tracking_number?: string; notes?: string }
+  ): Promise<ApiResponse<{ success: boolean }>> {
+    return this.patch<typeof data, { success: boolean }>(
+      this.siteUserEndpoint(siteName, `/users/orders/${encodeURIComponent(sessionId)}/fulfillment`),
+      data
+    );
+  }
+
+  // ============================================================================
+  // ADMIN USER-SCOPED ENDPOINTS (API key auth required)
+  // These mirror /me/* endpoints but target a specific user by ID.
+  // ============================================================================
+
+  /**
+   * Get a user's orders (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   * @param params - Pagination params
+   */
+  async getUserOrders(
+    siteName: string,
+    userId: string,
+    params?: { limit?: number; offset?: number }
+  ): Promise<ApiResponse<{ orders: SiteUserOrder[] }>> {
+    return this.http.get<{ orders: SiteUserOrder[] }>(
+      this.buildPath(this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/orders`)),
+      params
+    );
+  }
+
+  /**
+   * Get a user's subscriptions (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   */
+  async getUserSubscriptions(
+    siteName: string,
+    userId: string
+  ): Promise<ApiResponse<{ subscriptions: SiteUserSubscription[] }>> {
+    return this.getSingle<{ subscriptions: SiteUserSubscription[] }>(
+      this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/subscriptions`)
+    );
+  }
+
+  /**
+   * Pause a user's subscription (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   * @param subscriptionId - Subscription ID
+   * @param resumesAt - Optional ISO date string when subscription should auto-resume
+   */
+  async pauseUserSubscription(
+    siteName: string,
+    userId: string,
+    subscriptionId: string,
+    resumesAt?: string
+  ): Promise<ApiResponse<{ success: boolean }>> {
+    const body: Record<string, string> = {};
+    if (resumesAt) {
+      body.resumes_at = resumesAt;
+    }
+    return this.create<Record<string, string>, { success: boolean }>(
+      this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/subscriptions/${encodeURIComponent(subscriptionId)}/pause`),
+      body
+    );
+  }
+
+  /**
+   * Resume a user's paused subscription (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   * @param subscriptionId - Subscription ID
+   */
+  async resumeUserSubscription(
+    siteName: string,
+    userId: string,
+    subscriptionId: string
+  ): Promise<ApiResponse<{ success: boolean }>> {
+    return this.create<Record<string, never>, { success: boolean }>(
+      this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/subscriptions/${encodeURIComponent(subscriptionId)}/resume`),
+      {}
+    );
+  }
+
+  /**
+   * Cancel a user's subscription (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   * @param subscriptionId - Subscription ID
+   */
+  async cancelUserSubscription(
+    siteName: string,
+    userId: string,
+    subscriptionId: string
+  ): Promise<ApiResponse<{ success: boolean; message: string }>> {
+    return this.create<Record<string, never>, { success: boolean; message: string }>(
+      this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/subscriptions/${encodeURIComponent(subscriptionId)}/cancel`),
+      {}
+    );
+  }
+
+  /**
+   * Get a user's credit balance (admin only)
+   * @param siteName - The site name
+   * @param userId - User ID
+   */
+  async getUserCreditBalance(
+    siteName: string,
+    userId: string
+  ): Promise<ApiResponse<CreditBalance>> {
+    return this.getSingle<CreditBalance>(
+      this.siteUserEndpoint(siteName, `/users/${encodeURIComponent(userId)}/credits/balance`)
+    );
+  }
 }