@drttix/drt-sdk 1.4.10 → 1.5.0

package/src/generated/portal/services/SuperUserLaunchReadinessService.ts

@@ -1,323 +1,323 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { CollabNotesResponseDto } from '../models/CollabNotesResponseDto';
-import type { ContactResponseDto } from '../models/ContactResponseDto';
-import type { FeatureNotificationResponseDto } from '../models/FeatureNotificationResponseDto';
-import type { InterviewSummaryResponseDto } from '../models/InterviewSummaryResponseDto';
-import type { LastEmailResponseDto } from '../models/LastEmailResponseDto';
-import type { LaunchReadinessInterviewDetailResponseDto } from '../models/LaunchReadinessInterviewDetailResponseDto';
-import type { LaunchReadinessTaskResponseDto } from '../models/LaunchReadinessTaskResponseDto';
-import type { LeadNoteResponseDto } from '../models/LeadNoteResponseDto';
-import type { RefundPolicyResponseDto } from '../models/RefundPolicyResponseDto';
-import type { SendEmailRequestDto } from '../models/SendEmailRequestDto';
-import type { SendTextRequestDto } from '../models/SendTextRequestDto';
-import type { SuccessResponse } from '../models/SuccessResponse';
-import type { ToggleCompletionRequestDto } from '../models/ToggleCompletionRequestDto';
-import type { UpdateNoteRequestDto } from '../models/UpdateNoteRequestDto';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { OpenAPI } from '../core/OpenAPI';
-import { request as __request } from '../core/request';
-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
-     */
-    public static getLaunchReadinessInterviews(
-        xStudioId: string,
-    ): CancelablePromise<Array<InterviewSummaryResponseDto>> {
-        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
-     */
-    public static getLaunchReadinessInterview(
-        xStudioId: string,
-        interviewId: number,
-    ): CancelablePromise<LaunchReadinessInterviewDetailResponseDto> {
-        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
-     */
-    public static getLaunchReadinessTasks(
-        xStudioId: string,
-        interviewId: number,
-    ): CancelablePromise<Array<LaunchReadinessTaskResponseDto>> {
-        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
-     */
-    public static getLaunchReadinessCollabNotes(
-        xStudioId: string,
-        interviewId: number,
-    ): CancelablePromise<CollabNotesResponseDto> {
-        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
-     */
-    public static getLaunchReadinessLastEmail(
-        xStudioId: string,
-    ): CancelablePromise<LastEmailResponseDto> {
-        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
-     */
-    public static getLaunchReadinessContacts(
-        xStudioId: string,
-    ): CancelablePromise<Array<ContactResponseDto>> {
-        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
-     */
-    public static getLaunchReadinessLeadNotes(
-        xStudioId: string,
-    ): CancelablePromise<Array<LeadNoteResponseDto>> {
-        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
-     */
-    public static getLaunchReadinessFeatureNotifications(
-        xStudioId: string,
-    ): CancelablePromise<Array<FeatureNotificationResponseDto>> {
-        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
-     */
-    public static getLaunchReadinessRefundPolicy(
-        xStudioId: string,
-    ): CancelablePromise<RefundPolicyResponseDto> {
-        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
-     */
-    public static toggleLaunchReadinessCompletion(
-        xStudioId: string,
-        requestBody: ToggleCompletionRequestDto,
-    ): CancelablePromise<SuccessResponse> {
-        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
-     */
-    public static updateLaunchReadinessInterviewNote(
-        xStudioId: string,
-        interviewId: number,
-        requestBody: UpdateNoteRequestDto,
-    ): CancelablePromise<SuccessResponse> {
-        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
-     */
-    public static updateLaunchReadinessTaskNote(
-        xStudioId: string,
-        interviewId: number,
-        taskId: number,
-        requestBody: UpdateNoteRequestDto,
-    ): CancelablePromise<SuccessResponse> {
-        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
-     */
-    public static sendLaunchReadinessEmail(
-        xStudioId: string,
-        requestBody: SendEmailRequestDto,
-    ): CancelablePromise<SuccessResponse> {
-        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
-     */
-    public static sendLaunchReadinessText(
-        xStudioId: string,
-        requestBody: SendTextRequestDto,
-    ): CancelablePromise<SuccessResponse> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/admin-portal/superuser/launch-readiness/send-text',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-        });
-    }
-}
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CollabNotesResponseDto } from '../models/CollabNotesResponseDto';
+import type { ContactResponseDto } from '../models/ContactResponseDto';
+import type { FeatureNotificationResponseDto } from '../models/FeatureNotificationResponseDto';
+import type { InterviewSummaryResponseDto } from '../models/InterviewSummaryResponseDto';
+import type { LastEmailResponseDto } from '../models/LastEmailResponseDto';
+import type { LaunchReadinessInterviewDetailResponseDto } from '../models/LaunchReadinessInterviewDetailResponseDto';
+import type { LaunchReadinessTaskResponseDto } from '../models/LaunchReadinessTaskResponseDto';
+import type { LeadNoteResponseDto } from '../models/LeadNoteResponseDto';
+import type { RefundPolicyResponseDto } from '../models/RefundPolicyResponseDto';
+import type { SendEmailRequestDto } from '../models/SendEmailRequestDto';
+import type { SendTextRequestDto } from '../models/SendTextRequestDto';
+import type { SuccessResponse } from '../models/SuccessResponse';
+import type { ToggleCompletionRequestDto } from '../models/ToggleCompletionRequestDto';
+import type { UpdateNoteRequestDto } from '../models/UpdateNoteRequestDto';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+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
+     */
+    public static getLaunchReadinessInterviews(
+        xStudioId: string,
+    ): CancelablePromise<Array<InterviewSummaryResponseDto>> {
+        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
+     */
+    public static getLaunchReadinessInterview(
+        xStudioId: string,
+        interviewId: number,
+    ): CancelablePromise<LaunchReadinessInterviewDetailResponseDto> {
+        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
+     */
+    public static getLaunchReadinessTasks(
+        xStudioId: string,
+        interviewId: number,
+    ): CancelablePromise<Array<LaunchReadinessTaskResponseDto>> {
+        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
+     */
+    public static getLaunchReadinessCollabNotes(
+        xStudioId: string,
+        interviewId: number,
+    ): CancelablePromise<CollabNotesResponseDto> {
+        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
+     */
+    public static getLaunchReadinessLastEmail(
+        xStudioId: string,
+    ): CancelablePromise<LastEmailResponseDto> {
+        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
+     */
+    public static getLaunchReadinessContacts(
+        xStudioId: string,
+    ): CancelablePromise<Array<ContactResponseDto>> {
+        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
+     */
+    public static getLaunchReadinessLeadNotes(
+        xStudioId: string,
+    ): CancelablePromise<Array<LeadNoteResponseDto>> {
+        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
+     */
+    public static getLaunchReadinessFeatureNotifications(
+        xStudioId: string,
+    ): CancelablePromise<Array<FeatureNotificationResponseDto>> {
+        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
+     */
+    public static getLaunchReadinessRefundPolicy(
+        xStudioId: string,
+    ): CancelablePromise<RefundPolicyResponseDto> {
+        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
+     */
+    public static toggleLaunchReadinessCompletion(
+        xStudioId: string,
+        requestBody: ToggleCompletionRequestDto,
+    ): CancelablePromise<SuccessResponse> {
+        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
+     */
+    public static updateLaunchReadinessInterviewNote(
+        xStudioId: string,
+        interviewId: number,
+        requestBody: UpdateNoteRequestDto,
+    ): CancelablePromise<SuccessResponse> {
+        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
+     */
+    public static updateLaunchReadinessTaskNote(
+        xStudioId: string,
+        interviewId: number,
+        taskId: number,
+        requestBody: UpdateNoteRequestDto,
+    ): CancelablePromise<SuccessResponse> {
+        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
+     */
+    public static sendLaunchReadinessEmail(
+        xStudioId: string,
+        requestBody: SendEmailRequestDto,
+    ): CancelablePromise<SuccessResponse> {
+        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
+     */
+    public static sendLaunchReadinessText(
+        xStudioId: string,
+        requestBody: SendTextRequestDto,
+    ): CancelablePromise<SuccessResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/admin-portal/superuser/launch-readiness/send-text',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}