@drttix/drt-sdk 1.4.5 → 1.4.7

package/dist/esm/src/generated/portal/services/SuperUserLaunchReadinessService.js

@@ -0,0 +1,265 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class SuperUserLaunchReadinessService {
+    /**
+     * List the studio interviews
+     * Returns the interviews the report can be viewed for. Empty when the studio has none yet.
+     * @param xStudioId The ID of the studio
+     * @returns InterviewSummaryResponseDto Interviews for this studio, newest first.
+     * @throws ApiError
+     */
+    static getLaunchReadinessInterviews(xStudioId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/superuser/launch-readiness/interviews',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Get one interview record
+     * Returns the interview detail shown on the Interview tab.
+     * @param xStudioId The ID of the studio
+     * @param interviewId
+     * @returns LaunchReadinessInterviewDetailResponseDto The full interview record, or null when it is missing.
+     * @throws ApiError
+     */
+    static getLaunchReadinessInterview(xStudioId, interviewId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/superuser/launch-readiness/interview',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            query: {
+                'interviewId': interviewId,
+            },
+        });
+    }
+    /**
+     * List the readiness tasks
+     * Returns each task with its completion state, client acknowledgement, note and summary.
+     * @param xStudioId The ID of the studio
+     * @param interviewId
+     * @returns LaunchReadinessTaskResponseDto Readiness tasks for the interview.
+     * @throws ApiError
+     */
+    static getLaunchReadinessTasks(xStudioId, interviewId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/superuser/launch-readiness/tasks',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            query: {
+                'interviewId': interviewId,
+            },
+        });
+    }
+    /**
+     * Get the interview collaboration note
+     * Returns the free-text note shared across the interview.
+     * @param xStudioId The ID of the studio
+     * @param interviewId
+     * @returns CollabNotesResponseDto The shared note for this interview.
+     * @throws ApiError
+     */
+    static getLaunchReadinessCollabNotes(xStudioId, interviewId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/superuser/launch-readiness/collab-notes',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            query: {
+                'interviewId': interviewId,
+            },
+        });
+    }
+    /**
+     * Get the last email sent
+     * Returns the most recent client email, or null when none exists.
+     * @param xStudioId The ID of the studio
+     * @returns LastEmailResponseDto The most recent email sent to this studio, if any.
+     * @throws ApiError
+     */
+    static getLaunchReadinessLastEmail(xStudioId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/superuser/launch-readiness/last-email',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * List the points of contact
+     * Returns the studio contacts, flagging the primary one.
+     * @param xStudioId The ID of the studio
+     * @returns ContactResponseDto Points of contact for this studio.
+     * @throws ApiError
+     */
+    static getLaunchReadinessContacts(xStudioId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/superuser/launch-readiness/contacts',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * List the lead notes
+     * Returns the pinned-notes feed shown beside the report.
+     * @param xStudioId The ID of the studio
+     * @returns LeadNoteResponseDto Notes recorded against this studio lead.
+     * @throws ApiError
+     */
+    static getLaunchReadinessLeadNotes(xStudioId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/superuser/launch-readiness/lead-notes',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * List the feature notifications
+     * Returns the alerts and feature notifications for this studio.
+     * @param xStudioId The ID of the studio
+     * @returns FeatureNotificationResponseDto Feature alerts raised for this studio.
+     * @throws ApiError
+     */
+    static getLaunchReadinessFeatureNotifications(xStudioId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/superuser/launch-readiness/feature-notifications',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Get the refund policy
+     * Returns the refund policy text and when it was last set.
+     * @param xStudioId The ID of the studio
+     * @returns RefundPolicyResponseDto The studio refund policy.
+     * @throws ApiError
+     */
+    static getLaunchReadinessRefundPolicy(xStudioId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/superuser/launch-readiness/refund-policy',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Toggle a task or the launch-ready flag
+     * Records completion, client acknowledgement, or the interview launch-ready flag. The acting admin user is taken from the session, not the request.
+     * @param xStudioId The ID of the studio
+     * @param requestBody
+     * @returns SuccessResponse Toggle saved.
+     * @throws ApiError
+     */
+    static toggleLaunchReadinessCompletion(xStudioId, requestBody) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/admin-portal/superuser/launch-readiness/toggle-completion',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Save the interview collaboration note
+     * Replaces the shared note attached to the interview.
+     * @param xStudioId The ID of the studio
+     * @param interviewId
+     * @param requestBody
+     * @returns SuccessResponse Note saved.
+     * @throws ApiError
+     */
+    static updateLaunchReadinessInterviewNote(xStudioId, interviewId, requestBody) {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/admin-portal/superuser/launch-readiness/note/{interviewId}',
+            path: {
+                'interviewId': interviewId,
+            },
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Save a task note
+     * Replaces the note attached to one readiness task.
+     * @param xStudioId The ID of the studio
+     * @param interviewId
+     * @param taskId
+     * @param requestBody
+     * @returns SuccessResponse Note saved.
+     * @throws ApiError
+     */
+    static updateLaunchReadinessTaskNote(xStudioId, interviewId, taskId, requestBody) {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/admin-portal/superuser/launch-readiness/note/{interviewId}/{taskId}',
+            path: {
+                'interviewId': interviewId,
+                'taskId': taskId,
+            },
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Email the primary contact
+     * Sends an email to the studio primary point of contact and logs a lead note. The recipient is resolved server-side and cannot be supplied by the caller.
+     * @param xStudioId The ID of the studio
+     * @param requestBody
+     * @returns SuccessResponse Email sent.
+     * @throws ApiError
+     */
+    static sendLaunchReadinessEmail(xStudioId, requestBody) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/admin-portal/superuser/launch-readiness/send-email',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Text the primary contact
+     * Sends an SMS to the studio primary point of contact and logs a lead note. The recipient is resolved server-side and cannot be supplied by the caller.
+     * @param xStudioId The ID of the studio
+     * @param requestBody
+     * @returns SuccessResponse Text sent.
+     * @throws ApiError
+     */
+    static sendLaunchReadinessText(xStudioId, requestBody) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/admin-portal/superuser/launch-readiness/send-text',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}

package/dist/esm/src/generated/portal/services/SuperUserManageImageFilesService.d.ts

@@ -0,0 +1,64 @@
+import type { CreateImageFileRequestDto } from '../models/CreateImageFileRequestDto';
+import type { CreateImageFileResponseDto } from '../models/CreateImageFileResponseDto';
+import type { DeleteImageFilesRequestDto } from '../models/DeleteImageFilesRequestDto';
+import type { ImageCategoryResponseDto } from '../models/ImageCategoryResponseDto';
+import type { ManageImageFileResponseDto } from '../models/ManageImageFileResponseDto';
+import type { RenameImageFileRequestDto } from '../models/RenameImageFileRequestDto';
+import type { StartImageUploadRequestDto } from '../models/StartImageUploadRequestDto';
+import type { StartImageUploadResponseDto } from '../models/StartImageUploadResponseDto';
+import type { SuccessResponse } from '../models/SuccessResponse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class SuperUserManageImageFilesService {
+    /**
+     * Fetch the studio image files
+     * Fetch the uploaded, non-deleted image files for a studio
+     * @param xStudioId The ID of the studio
+     * @returns ManageImageFileResponseDto Image files fetched successfully
+     * @throws ApiError
+     */
+    static getImageFiles(xStudioId: string): CancelablePromise<Array<ManageImageFileResponseDto>>;
+    /**
+     * Save an uploaded image file
+     * Record an image file already uploaded to the presigned URL
+     * @param xStudioId The ID of the studio
+     * @param requestBody Payload describing the uploaded image file
+     * @returns CreateImageFileResponseDto Image file saved successfully
+     * @throws ApiError
+     */
+    static createImageFile(xStudioId: string, requestBody: CreateImageFileRequestDto): CancelablePromise<CreateImageFileResponseDto>;
+    /**
+     * Delete image files
+     * Soft delete the list of image files for a studio
+     * @param xStudioId The ID of the studio
+     * @param requestBody List of image file IDs to delete
+     * @returns SuccessResponse Image files deleted successfully
+     * @throws ApiError
+     */
+    static deleteImageFiles(xStudioId: string, requestBody: DeleteImageFilesRequestDto): CancelablePromise<SuccessResponse>;
+    /**
+     * Fetch the image categories
+     * Fetch the available image_category rows, used for the upload Type dropdown
+     * @returns ImageCategoryResponseDto Image categories fetched successfully
+     * @throws ApiError
+     */
+    static getImageCategories(): CancelablePromise<Array<ImageCategoryResponseDto>>;
+    /**
+     * Start image upload
+     * Get a presigned URL the client can upload an image file to directly
+     * @param xStudioId The ID of the studio
+     * @param requestBody Payload to start image upload
+     * @returns StartImageUploadResponseDto Image upload started successfully
+     * @throws ApiError
+     */
+    static startImageFileUpload(xStudioId: string, requestBody: StartImageUploadRequestDto): CancelablePromise<StartImageUploadResponseDto>;
+    /**
+     * Rename an image file
+     * Rename an image file by id
+     * @param xStudioId The ID of the studio
+     * @param imageId The ID of the image file
+     * @param requestBody Payload to rename the image file
+     * @returns SuccessResponse Image file renamed successfully
+     * @throws ApiError
+     */
+    static renameImageFile(xStudioId: string, imageId: string, requestBody: RenameImageFileRequestDto): CancelablePromise<SuccessResponse>;
+}

package/dist/esm/src/generated/portal/services/SuperUserManageImageFilesService.js

@@ -0,0 +1,112 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class SuperUserManageImageFilesService {
+    /**
+     * Fetch the studio image files
+     * Fetch the uploaded, non-deleted image files for a studio
+     * @param xStudioId The ID of the studio
+     * @returns ManageImageFileResponseDto Image files fetched successfully
+     * @throws ApiError
+     */
+    static getImageFiles(xStudioId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/superuser/manage-image-files/images',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Save an uploaded image file
+     * Record an image file already uploaded to the presigned URL
+     * @param xStudioId The ID of the studio
+     * @param requestBody Payload describing the uploaded image file
+     * @returns CreateImageFileResponseDto Image file saved successfully
+     * @throws ApiError
+     */
+    static createImageFile(xStudioId, requestBody) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/admin-portal/superuser/manage-image-files/images',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Delete image files
+     * Soft delete the list of image files for a studio
+     * @param xStudioId The ID of the studio
+     * @param requestBody List of image file IDs to delete
+     * @returns SuccessResponse Image files deleted successfully
+     * @throws ApiError
+     */
+    static deleteImageFiles(xStudioId, requestBody) {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/admin-portal/superuser/manage-image-files/images',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Fetch the image categories
+     * Fetch the available image_category rows, used for the upload Type dropdown
+     * @returns ImageCategoryResponseDto Image categories fetched successfully
+     * @throws ApiError
+     */
+    static getImageCategories() {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/superuser/manage-image-files/categories',
+        });
+    }
+    /**
+     * Start image upload
+     * Get a presigned URL the client can upload an image file to directly
+     * @param xStudioId The ID of the studio
+     * @param requestBody Payload to start image upload
+     * @returns StartImageUploadResponseDto Image upload started successfully
+     * @throws ApiError
+     */
+    static startImageFileUpload(xStudioId, requestBody) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/admin-portal/superuser/manage-image-files/start-image-upload',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Rename an image file
+     * Rename an image file by id
+     * @param xStudioId The ID of the studio
+     * @param imageId The ID of the image file
+     * @param requestBody Payload to rename the image file
+     * @returns SuccessResponse Image file renamed successfully
+     * @throws ApiError
+     */
+    static renameImageFile(xStudioId, imageId, requestBody) {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/admin-portal/superuser/manage-image-files/images/{imageId}',
+            path: {
+                'imageId': imageId,
+            },
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}