@drttix/drt-sdk 1.5.0 → 1.5.1

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

@@ -1,333 +1,333 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { GetOrderBySeatResponseDto } from '../models/GetOrderBySeatResponseDto';
-import type { GetOrderNotesResponseDto } from '../models/GetOrderNotesResponseDto';
-import type { GetOrderSeatsResponseDto } from '../models/GetOrderSeatsResponseDto';
-import type { GetOrdersResponseDto } from '../models/GetOrdersResponseDto';
-import type { GetReservedShowsResponseDto } from '../models/GetReservedShowsResponseDto';
-import type { GetSettingsResponseDto } from '../models/GetSettingsResponseDto';
-import type { GetShowsResponseDto } from '../models/GetShowsResponseDto';
-import type { GetShowTiersResponseDto } from '../models/GetShowTiersResponseDto';
-import type { GetSourceShowResponseDto } from '../models/GetSourceShowResponseDto';
-import type { OperationResultResponseDto } from '../models/OperationResultResponseDto';
-import type { SdReadyRequestDto } from '../models/SdReadyRequestDto';
-import type { SdReadyResponseDto } from '../models/SdReadyResponseDto';
-import type { SetTiersRequestDto } from '../models/SetTiersRequestDto';
-import type { SuccessResponse } from '../models/SuccessResponse';
-import type { TransferRequestDto } from '../models/TransferRequestDto';
-import type { UpdateSettingsRequestDto } from '../models/UpdateSettingsRequestDto';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { OpenAPI } from '../core/OpenAPI';
-import { request as __request } from '../core/request';
-export class ClientToolsSeatAssignmentToolService {
-    /**
-     * Fetch the seat assignment settings
-     * Fetch the seat assignment settings
-     * @param xStudioId The ID of the studio
-     * @returns GetSettingsResponseDto Seat assignment settings fetched successfully
-     * @throws ApiError
-     */
-    public static getSeatAssignmentSettings(
-        xStudioId: string,
-    ): CancelablePromise<GetSettingsResponseDto> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/admin-portal/client-tools/seat-assignment-tool/settings',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-        });
-    }
-    /**
-     * Update the seat assignment settings
-     * Update the studio settings that control emails, approval, and the extra order column for the seat assignment tool
-     * @param xStudioId The ID of the studio
-     * @param requestBody
-     * @returns SuccessResponse Seat assignment settings updated successfully
-     * @throws ApiError
-     */
-    public static updateSeatAssignmentSettings(
-        xStudioId: string,
-        requestBody: UpdateSettingsRequestDto,
-    ): CancelablePromise<SuccessResponse> {
-        return __request(OpenAPI, {
-            method: 'PUT',
-            url: '/admin-portal/client-tools/seat-assignment-tool/settings',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-        });
-    }
-    /**
-     * List the shows configured for seat assignment
-     * Lists the general admission shows configured for general-to-reserved seat assignment
-     * @param xStudioId The ID of the studio
-     * @returns GetShowsResponseDto Shows configured for seat assignment
-     * @throws ApiError
-     */
-    public static getSeatAssignmentShows(
-        xStudioId: string,
-    ): CancelablePromise<GetShowsResponseDto> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/admin-portal/client-tools/seat-assignment-tool/shows',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-        });
-    }
-    /**
-     * Fetch a source show with its resolved target show
-     * Fetches the general admission source show along with the reserved seating target show resolved for it
-     * @param xStudioId The ID of the studio
-     * @param showId The ID of the show
-     * @returns GetSourceShowResponseDto Source show and its resolved target show
-     * @throws ApiError
-     */
-    public static getSeatAssignmentSourceShow(
-        xStudioId: string,
-        showId: string,
-    ): CancelablePromise<GetSourceShowResponseDto> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/admin-portal/client-tools/seat-assignment-tool/shows/{showId}',
-            path: {
-                'showId': showId,
-            },
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-        });
-    }
-    /**
-     * List the pricing tiers for a show
-     * Lists the pricing tiers for a show, used to filter orders by ticket type
-     * @param xStudioId The ID of the studio
-     * @param showId The ID of the show
-     * @returns GetShowTiersResponseDto Pricing tiers for the show
-     * @throws ApiError
-     */
-    public static getSeatAssignmentShowTiers(
-        xStudioId: string,
-        showId: string,
-    ): CancelablePromise<GetShowTiersResponseDto> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/admin-portal/client-tools/seat-assignment-tool/shows/{showId}/tiers',
-            path: {
-                'showId': showId,
-            },
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-        });
-    }
-    /**
-     * Set or toggle whether a show is ready for ticket download
-     * Sets whether the target show is ready, allowing ticket download before the 24 hours prior cutoff. Toggles when no status is provided.
-     * @param xStudioId The ID of the studio
-     * @param showId The ID of the show
-     * @param requestBody
-     * @returns SdReadyResponseDto Show ready status updated
-     * @throws ApiError
-     */
-    public static setSeatAssignmentShowReady(
-        xStudioId: string,
-        showId: string,
-        requestBody: SdReadyRequestDto,
-    ): CancelablePromise<SdReadyResponseDto> {
-        return __request(OpenAPI, {
-            method: 'PUT',
-            url: '/admin-portal/client-tools/seat-assignment-tool/shows/{showId}/sd-ready',
-            path: {
-                'showId': showId,
-            },
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-        });
-    }
-    /**
-     * List the reserved seating shows
-     * Lists every reserved seating show for the studio, used by superusers to override the target show
-     * @param xStudioId The ID of the studio
-     * @returns GetReservedShowsResponseDto Reserved seating shows for the studio
-     * @throws ApiError
-     */
-    public static getSeatAssignmentReservedShows(
-        xStudioId: string,
-    ): CancelablePromise<GetReservedShowsResponseDto> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/admin-portal/client-tools/seat-assignment-tool/reserved-shows',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-        });
-    }
-    /**
-     * List the orders to assign seats for
-     * Lists every order holding seats in the general admission source show or its reserved seating target show
-     * @param xStudioId The ID of the studio
-     * @param showId The ID of the show
-     * @param tierId
-     * @param sort
-     * @returns GetOrdersResponseDto Orders with seats in the source or target show
-     * @throws ApiError
-     */
-    public static getSeatAssignmentOrders(
-        xStudioId: string,
-        showId?: string,
-        tierId?: string,
-        sort?: string,
-    ): CancelablePromise<GetOrdersResponseDto> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/admin-portal/client-tools/seat-assignment-tool/orders',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-            query: {
-                'showId': showId,
-                'tierId': tierId,
-                'sort': sort,
-            },
-        });
-    }
-    /**
-     * Find the order occupying a seat
-     * Finds the order occupying a seat in the target show and returns all of that order's seats in the show
-     * @param xStudioId The ID of the studio
-     * @param section Value of the section
-     * @param row Value of the row
-     * @param seat
-     * @param showId The ID of the show
-     * @returns GetOrderBySeatResponseDto The order occupying the seat, with all its seats
-     * @throws ApiError
-     */
-    public static getSeatAssignmentOrderBySeat(
-        xStudioId: string,
-        section: string,
-        row: string,
-        seat: string,
-        showId?: string,
-    ): CancelablePromise<GetOrderBySeatResponseDto> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/admin-portal/client-tools/seat-assignment-tool/order-by-seat',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-            query: {
-                'showId': showId,
-                'section': section,
-                'row': row,
-                'seat': seat,
-            },
-        });
-    }
-    /**
-     * Fetch the administrative note for an order
-     * Fetch the administrative note for an order
-     * @param xStudioId The ID of the studio
-     * @param orderId The ID of the order
-     * @returns GetOrderNotesResponseDto The administrative note on the order
-     * @throws ApiError
-     */
-    public static getSeatAssignmentOrderNotes(
-        xStudioId: string,
-        orderId: string,
-    ): CancelablePromise<GetOrderNotesResponseDto> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/admin-portal/client-tools/seat-assignment-tool/orders/{orderId}/notes',
-            path: {
-                'orderId': orderId,
-            },
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-        });
-    }
-    /**
-     * List the seats on an order
-     * Lists the section/row/seat locations on an order, optionally filtered to a show and pricing tier
-     * @param xStudioId The ID of the studio
-     * @param orderId The ID of the order
-     * @param showId The ID of the show
-     * @param tierId
-     * @returns GetOrderSeatsResponseDto The seats on the order
-     * @throws ApiError
-     */
-    public static getSeatAssignmentOrderSeats(
-        xStudioId: string,
-        orderId: string,
-        showId?: string,
-        tierId?: string,
-    ): CancelablePromise<GetOrderSeatsResponseDto> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/admin-portal/client-tools/seat-assignment-tool/orders/{orderId}/seats',
-            path: {
-                'orderId': orderId,
-            },
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-            query: {
-                'showId': showId,
-                'tierId': tierId,
-            },
-        });
-    }
-    /**
-     * Match pricing tiers on the held seats to the order
-     * Attempts to update the pricing tiers on the seats held in the cart to match the pricing points of the seats in the selected order
-     * @param xStudioId The ID of the studio
-     * @param requestBody
-     * @returns OperationResultResponseDto Tier assignment result. success=false with message "PARTIAL" means at least one seat in the cart could not be matched with a tier.
-     * @throws ApiError
-     */
-    public static setSeatAssignmentTiers(
-        xStudioId: string,
-        requestBody: SetTiersRequestDto,
-    ): CancelablePromise<OperationResultResponseDto> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/admin-portal/client-tools/seat-assignment-tool/set-tiers',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-        });
-    }
-    /**
-     * Transfer an order from the source show to the held seats
-     * Removes the order's seats from the general admission source show and assigns the seats held in the cart in the reserved target show
-     * @param xStudioId The ID of the studio
-     * @param requestBody
-     * @returns OperationResultResponseDto Transfer result
-     * @throws ApiError
-     */
-    public static executeSeatAssignmentTransfer(
-        xStudioId: string,
-        requestBody: TransferRequestDto,
-    ): CancelablePromise<OperationResultResponseDto> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/admin-portal/client-tools/seat-assignment-tool/transfer',
-            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 { GetOrderBySeatResponseDto } from '../models/GetOrderBySeatResponseDto';
+import type { GetOrderNotesResponseDto } from '../models/GetOrderNotesResponseDto';
+import type { GetOrderSeatsResponseDto } from '../models/GetOrderSeatsResponseDto';
+import type { GetOrdersResponseDto } from '../models/GetOrdersResponseDto';
+import type { GetReservedShowsResponseDto } from '../models/GetReservedShowsResponseDto';
+import type { GetSettingsResponseDto } from '../models/GetSettingsResponseDto';
+import type { GetShowsResponseDto } from '../models/GetShowsResponseDto';
+import type { GetShowTiersResponseDto } from '../models/GetShowTiersResponseDto';
+import type { GetSourceShowResponseDto } from '../models/GetSourceShowResponseDto';
+import type { OperationResultResponseDto } from '../models/OperationResultResponseDto';
+import type { SdReadyRequestDto } from '../models/SdReadyRequestDto';
+import type { SdReadyResponseDto } from '../models/SdReadyResponseDto';
+import type { SetTiersRequestDto } from '../models/SetTiersRequestDto';
+import type { SuccessResponse } from '../models/SuccessResponse';
+import type { TransferRequestDto } from '../models/TransferRequestDto';
+import type { UpdateSettingsRequestDto } from '../models/UpdateSettingsRequestDto';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class ClientToolsSeatAssignmentToolService {
+    /**
+     * Fetch the seat assignment settings
+     * Fetch the seat assignment settings
+     * @param xStudioId The ID of the studio
+     * @returns GetSettingsResponseDto Seat assignment settings fetched successfully
+     * @throws ApiError
+     */
+    public static getSeatAssignmentSettings(
+        xStudioId: string,
+    ): CancelablePromise<GetSettingsResponseDto> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/client-tools/seat-assignment-tool/settings',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Update the seat assignment settings
+     * Update the studio settings that control emails, approval, and the extra order column for the seat assignment tool
+     * @param xStudioId The ID of the studio
+     * @param requestBody
+     * @returns SuccessResponse Seat assignment settings updated successfully
+     * @throws ApiError
+     */
+    public static updateSeatAssignmentSettings(
+        xStudioId: string,
+        requestBody: UpdateSettingsRequestDto,
+    ): CancelablePromise<SuccessResponse> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/admin-portal/client-tools/seat-assignment-tool/settings',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * List the shows configured for seat assignment
+     * Lists the general admission shows configured for general-to-reserved seat assignment
+     * @param xStudioId The ID of the studio
+     * @returns GetShowsResponseDto Shows configured for seat assignment
+     * @throws ApiError
+     */
+    public static getSeatAssignmentShows(
+        xStudioId: string,
+    ): CancelablePromise<GetShowsResponseDto> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/client-tools/seat-assignment-tool/shows',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Fetch a source show with its resolved target show
+     * Fetches the general admission source show along with the reserved seating target show resolved for it
+     * @param xStudioId The ID of the studio
+     * @param showId The ID of the show
+     * @returns GetSourceShowResponseDto Source show and its resolved target show
+     * @throws ApiError
+     */
+    public static getSeatAssignmentSourceShow(
+        xStudioId: string,
+        showId: string,
+    ): CancelablePromise<GetSourceShowResponseDto> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/client-tools/seat-assignment-tool/shows/{showId}',
+            path: {
+                'showId': showId,
+            },
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * List the pricing tiers for a show
+     * Lists the pricing tiers for a show, used to filter orders by ticket type
+     * @param xStudioId The ID of the studio
+     * @param showId The ID of the show
+     * @returns GetShowTiersResponseDto Pricing tiers for the show
+     * @throws ApiError
+     */
+    public static getSeatAssignmentShowTiers(
+        xStudioId: string,
+        showId: string,
+    ): CancelablePromise<GetShowTiersResponseDto> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/client-tools/seat-assignment-tool/shows/{showId}/tiers',
+            path: {
+                'showId': showId,
+            },
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Set or toggle whether a show is ready for ticket download
+     * Sets whether the target show is ready, allowing ticket download before the 24 hours prior cutoff. Toggles when no status is provided.
+     * @param xStudioId The ID of the studio
+     * @param showId The ID of the show
+     * @param requestBody
+     * @returns SdReadyResponseDto Show ready status updated
+     * @throws ApiError
+     */
+    public static setSeatAssignmentShowReady(
+        xStudioId: string,
+        showId: string,
+        requestBody: SdReadyRequestDto,
+    ): CancelablePromise<SdReadyResponseDto> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/admin-portal/client-tools/seat-assignment-tool/shows/{showId}/sd-ready',
+            path: {
+                'showId': showId,
+            },
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * List the reserved seating shows
+     * Lists every reserved seating show for the studio, used by superusers to override the target show
+     * @param xStudioId The ID of the studio
+     * @returns GetReservedShowsResponseDto Reserved seating shows for the studio
+     * @throws ApiError
+     */
+    public static getSeatAssignmentReservedShows(
+        xStudioId: string,
+    ): CancelablePromise<GetReservedShowsResponseDto> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/client-tools/seat-assignment-tool/reserved-shows',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * List the orders to assign seats for
+     * Lists every order holding seats in the general admission source show or its reserved seating target show
+     * @param xStudioId The ID of the studio
+     * @param showId The ID of the show
+     * @param tierId
+     * @param sort
+     * @returns GetOrdersResponseDto Orders with seats in the source or target show
+     * @throws ApiError
+     */
+    public static getSeatAssignmentOrders(
+        xStudioId: string,
+        showId?: string,
+        tierId?: string,
+        sort?: string,
+    ): CancelablePromise<GetOrdersResponseDto> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/client-tools/seat-assignment-tool/orders',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            query: {
+                'showId': showId,
+                'tierId': tierId,
+                'sort': sort,
+            },
+        });
+    }
+    /**
+     * Find the order occupying a seat
+     * Finds the order occupying a seat in the target show and returns all of that order's seats in the show
+     * @param xStudioId The ID of the studio
+     * @param section Value of the section
+     * @param row Value of the row
+     * @param seat
+     * @param showId The ID of the show
+     * @returns GetOrderBySeatResponseDto The order occupying the seat, with all its seats
+     * @throws ApiError
+     */
+    public static getSeatAssignmentOrderBySeat(
+        xStudioId: string,
+        section: string,
+        row: string,
+        seat: string,
+        showId?: string,
+    ): CancelablePromise<GetOrderBySeatResponseDto> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/client-tools/seat-assignment-tool/order-by-seat',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            query: {
+                'showId': showId,
+                'section': section,
+                'row': row,
+                'seat': seat,
+            },
+        });
+    }
+    /**
+     * Fetch the administrative note for an order
+     * Fetch the administrative note for an order
+     * @param xStudioId The ID of the studio
+     * @param orderId The ID of the order
+     * @returns GetOrderNotesResponseDto The administrative note on the order
+     * @throws ApiError
+     */
+    public static getSeatAssignmentOrderNotes(
+        xStudioId: string,
+        orderId: string,
+    ): CancelablePromise<GetOrderNotesResponseDto> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/client-tools/seat-assignment-tool/orders/{orderId}/notes',
+            path: {
+                'orderId': orderId,
+            },
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * List the seats on an order
+     * Lists the section/row/seat locations on an order, optionally filtered to a show and pricing tier
+     * @param xStudioId The ID of the studio
+     * @param orderId The ID of the order
+     * @param showId The ID of the show
+     * @param tierId
+     * @returns GetOrderSeatsResponseDto The seats on the order
+     * @throws ApiError
+     */
+    public static getSeatAssignmentOrderSeats(
+        xStudioId: string,
+        orderId: string,
+        showId?: string,
+        tierId?: string,
+    ): CancelablePromise<GetOrderSeatsResponseDto> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/admin-portal/client-tools/seat-assignment-tool/orders/{orderId}/seats',
+            path: {
+                'orderId': orderId,
+            },
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            query: {
+                'showId': showId,
+                'tierId': tierId,
+            },
+        });
+    }
+    /**
+     * Match pricing tiers on the held seats to the order
+     * Attempts to update the pricing tiers on the seats held in the cart to match the pricing points of the seats in the selected order
+     * @param xStudioId The ID of the studio
+     * @param requestBody
+     * @returns OperationResultResponseDto Tier assignment result. success=false with message "PARTIAL" means at least one seat in the cart could not be matched with a tier.
+     * @throws ApiError
+     */
+    public static setSeatAssignmentTiers(
+        xStudioId: string,
+        requestBody: SetTiersRequestDto,
+    ): CancelablePromise<OperationResultResponseDto> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/admin-portal/client-tools/seat-assignment-tool/set-tiers',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Transfer an order from the source show to the held seats
+     * Removes the order's seats from the general admission source show and assigns the seats held in the cart in the reserved target show
+     * @param xStudioId The ID of the studio
+     * @param requestBody
+     * @returns OperationResultResponseDto Transfer result
+     * @throws ApiError
+     */
+    public static executeSeatAssignmentTransfer(
+        xStudioId: string,
+        requestBody: TransferRequestDto,
+    ): CancelablePromise<OperationResultResponseDto> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/admin-portal/client-tools/seat-assignment-tool/transfer',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}