@drttix/drt-sdk 1.5.0 → 1.5.1

package/src/generated/scanner/services/ScanningService.ts

@@ -1,369 +1,369 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { EventResponse } from '../models/EventResponse';
-import type { MobileReceiptResponse } from '../models/MobileReceiptResponse';
-import type { OrderDetails } from '../models/OrderDetails';
-import type { OrderScan } from '../models/OrderScan';
-import type { ProductQR } from '../models/ProductQR';
-import type { ProductScan } from '../models/ProductScan';
-import type { ReceiptResponse } from '../models/ReceiptResponse';
-import type { ResultMessage } from '../models/ResultMessage';
-import type { SeatQR } from '../models/SeatQR';
-import type { SeatResponse } from '../models/SeatResponse';
-import type { TicketScan } from '../models/TicketScan';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { OpenAPI } from '../core/OpenAPI';
-import { request as __request } from '../core/request';
-export class ScanningService {
-    /**
-     * Used to check if the server is healthy
-     * Checks if the server is healthy
-     * @returns any Healthy.
-     * @throws ApiError
-     */
-    public static appControllerHealth(): CancelablePromise<any> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/health',
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Used to reset scanned tickets for a show given a showCode
-     * Resets the shows scanned tickets. This will not reset the merch scans as those are not show specific
-     * @param c Show code
-     * @param lang Language for error messages to be returned in
-     * @returns ResultMessage Reset the scanned tickets for a show.
-     * @throws ApiError
-     */
-    public static appControllerResetEvent(
-        c: string,
-        lang?: string,
-    ): CancelablePromise<ResultMessage> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/reset',
-            query: {
-                'c': c,
-                'lang': lang,
-            },
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Used to scan merchandise
-     * Scans a merchandise and will return a ProductScan object with the details of the scan.
-     * @param c Show code
-     * @param devicename The name of the device issuing the request
-     * @param requestBody The ProductQR object containing the product data
-     * @param lang Language for error messages to be returned in
-     * @returns ProductScan Scans the merchandise and returns the scan information.
-     * @throws ApiError
-     */
-    public static appControllerScanProduct(
-        c: string,
-        devicename: string,
-        requestBody: ProductQR,
-        lang?: string,
-    ): CancelablePromise<ProductScan> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/merch',
-            query: {
-                'c': c,
-                'devicename': devicename,
-                'lang': lang,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Used to scan tickets using a barcode rather than a QR code
-     * Scans a ticket using a barcode and returns a TicketScan object with details about the scan
-     * @param c Show code
-     * @param devicename The name of the device issuing the request
-     * @param bc The barcode used to scan the ticket
-     * @param lang Language for error messages to be returned in
-     * @returns TicketScan Scans the ticket using a barcode and returns the scan information
-     * @throws ApiError
-     */
-    public static appControllerScanBarcode(
-        c: string,
-        devicename: string,
-        bc: string,
-        lang?: string,
-    ): CancelablePromise<TicketScan> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/ticket',
-            query: {
-                'c': c,
-                'devicename': devicename,
-                'bc': bc,
-                'lang': lang,
-            },
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Used to scan tickets using a QR code
-     * Scans a ticket and returns a TicketScan object with details about the scan
-     * @param c Show code
-     * @param devicename The name of the device issuing the request
-     * @param requestBody The SeatQR object containing the seat data
-     * @param lang Language for error messages to be returned in
-     * @returns TicketScan Scan tickets using a QR Code and returns scan information.
-     * @throws ApiError
-     */
-    public static appControllerScanTicketFromPost(
-        c: string,
-        devicename: string,
-        requestBody: SeatQR,
-        lang?: string,
-    ): CancelablePromise<TicketScan> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/ticket',
-            query: {
-                'c': c,
-                'devicename': devicename,
-                'lang': lang,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Used to get seat details by location
-     * Returns a SeatResponse object with details about the seat when provided section, row, or seat
-     * @param c Show code
-     * @param section The section to use to search
-     * @param row The row to use to search
-     * @param seat The seat number to use to search
-     * @param lang Language for error messages to be returned in
-     * @returns SeatResponse Seat information by section, row, and seat number.
-     * @throws ApiError
-     */
-    public static appControllerGetSeat(
-        c: string,
-        section: string,
-        row: string,
-        seat: number,
-        lang?: any,
-    ): CancelablePromise<SeatResponse> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/seat',
-            query: {
-                'c': c,
-                'section': section,
-                'row': row,
-                'seat': seat,
-                'lang': lang,
-            },
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Used to get a receipt by its GUID
-     * Returns a ReceiptResponse object with details about the receipt
-     * @param guid The unique guid associated with the receipt
-     * @param lang Language for error messages to be returned in
-     * @returns ReceiptResponse Get a receipt's details.
-     * @throws ApiError
-     */
-    public static appControllerGetReceipt(
-        guid: string,
-        lang?: any,
-    ): CancelablePromise<ReceiptResponse> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/receipt',
-            query: {
-                'guid': guid,
-                'lang': lang,
-            },
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Used to get a mobile receipt by its GUID
-     * Returns a MobileReceiptResponse object with details about the receipt
-     * @param guid The unique guid associated with the mobile receipt
-     * @param lang Language for error messages to be returned in
-     * @returns MobileReceiptResponse Get a mobile receipt's details.
-     * @throws ApiError
-     */
-    public static appControllerGetReceiptMobile(
-        guid: string,
-        lang?: any,
-    ): CancelablePromise<MobileReceiptResponse> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/receipt-mobile',
-            query: {
-                'guid': guid,
-                'lang': lang,
-            },
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Used to get an order by its orderId, showCode, and type
-     * Returns an OrderDetails object with details about the order
-     * @param c Show code
-     * @param oid The orderId associated with the order
-     * @param type The type of order to retrieve
-     * @param lang Language for error messages to be returned in
-     * @returns OrderDetails Returns order details given a receipt.
-     * @throws ApiError
-     */
-    public static appControllerGetOrder(
-        c: string,
-        oid: number,
-        type: 'seats' | 'merch',
-        lang?: any,
-    ): CancelablePromise<OrderDetails> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/order',
-            query: {
-                'c': c,
-                'oid': oid,
-                'type': type,
-                'lang': lang,
-            },
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Used to scan every remaining ticket in an order
-     * Scans all unscanned tickets in an order and returns an OrderScan object summarizing the results
-     * @param c Show code
-     * @param devicename The name of the device issuing the request
-     * @param requestBody The order to scan, identified by orderId
-     * @param lang Language for error messages to be returned in
-     * @returns OrderScan Scans the order and returns the scan information.
-     * @throws ApiError
-     */
-    public static appControllerScanEntireOrder(
-        c: string,
-        devicename: string,
-        requestBody: {
-            orderId?: {
-                oid?: number;
-            };
-        },
-        lang?: string,
-    ): CancelablePromise<OrderScan> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/order',
-            query: {
-                'c': c,
-                'devicename': devicename,
-                'lang': lang,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Used to get a show by its showCode
-     * Returns details for a single event.
-     * @param c Show code
-     * @param devicename The name of the device issuing the request
-     * @param lang Language for error messages to be returned in
-     * @returns EventResponse Returns an EventResponse object with details about the event
-     * @throws ApiError
-     */
-    public static appControllerGetShow(
-        c: string,
-        devicename: string,
-        lang?: any,
-    ): CancelablePromise<EventResponse> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/show',
-            query: {
-                'c': c,
-                'devicename': devicename,
-                'lang': lang,
-            },
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Used to get a JSON object of all the strings used in the app
-     * Returns a JSON object of all the strings needed to run the app
-     * @param lang Language for error messages to be returned in
-     * @returns any Returns a JSON object of all the strings needed to run the app
-     * @throws ApiError
-     */
-    public static appControllerGetStrings(
-        lang?: any,
-    ): CancelablePromise<any> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/strings',
-            query: {
-                'lang': lang,
-            },
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-}
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { EventResponse } from '../models/EventResponse';
+import type { MobileReceiptResponse } from '../models/MobileReceiptResponse';
+import type { OrderDetails } from '../models/OrderDetails';
+import type { OrderScan } from '../models/OrderScan';
+import type { ProductQR } from '../models/ProductQR';
+import type { ProductScan } from '../models/ProductScan';
+import type { ReceiptResponse } from '../models/ReceiptResponse';
+import type { ResultMessage } from '../models/ResultMessage';
+import type { SeatQR } from '../models/SeatQR';
+import type { SeatResponse } from '../models/SeatResponse';
+import type { TicketScan } from '../models/TicketScan';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class ScanningService {
+    /**
+     * Used to check if the server is healthy
+     * Checks if the server is healthy
+     * @returns any Healthy.
+     * @throws ApiError
+     */
+    public static appControllerHealth(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/health',
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Used to reset scanned tickets for a show given a showCode
+     * Resets the shows scanned tickets. This will not reset the merch scans as those are not show specific
+     * @param c Show code
+     * @param lang Language for error messages to be returned in
+     * @returns ResultMessage Reset the scanned tickets for a show.
+     * @throws ApiError
+     */
+    public static appControllerResetEvent(
+        c: string,
+        lang?: string,
+    ): CancelablePromise<ResultMessage> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/reset',
+            query: {
+                'c': c,
+                'lang': lang,
+            },
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Used to scan merchandise
+     * Scans a merchandise and will return a ProductScan object with the details of the scan.
+     * @param c Show code
+     * @param devicename The name of the device issuing the request
+     * @param requestBody The ProductQR object containing the product data
+     * @param lang Language for error messages to be returned in
+     * @returns ProductScan Scans the merchandise and returns the scan information.
+     * @throws ApiError
+     */
+    public static appControllerScanProduct(
+        c: string,
+        devicename: string,
+        requestBody: ProductQR,
+        lang?: string,
+    ): CancelablePromise<ProductScan> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/merch',
+            query: {
+                'c': c,
+                'devicename': devicename,
+                'lang': lang,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Used to scan tickets using a barcode rather than a QR code
+     * Scans a ticket using a barcode and returns a TicketScan object with details about the scan
+     * @param c Show code
+     * @param devicename The name of the device issuing the request
+     * @param bc The barcode used to scan the ticket
+     * @param lang Language for error messages to be returned in
+     * @returns TicketScan Scans the ticket using a barcode and returns the scan information
+     * @throws ApiError
+     */
+    public static appControllerScanBarcode(
+        c: string,
+        devicename: string,
+        bc: string,
+        lang?: string,
+    ): CancelablePromise<TicketScan> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/ticket',
+            query: {
+                'c': c,
+                'devicename': devicename,
+                'bc': bc,
+                'lang': lang,
+            },
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Used to scan tickets using a QR code
+     * Scans a ticket and returns a TicketScan object with details about the scan
+     * @param c Show code
+     * @param devicename The name of the device issuing the request
+     * @param requestBody The SeatQR object containing the seat data
+     * @param lang Language for error messages to be returned in
+     * @returns TicketScan Scan tickets using a QR Code and returns scan information.
+     * @throws ApiError
+     */
+    public static appControllerScanTicketFromPost(
+        c: string,
+        devicename: string,
+        requestBody: SeatQR,
+        lang?: string,
+    ): CancelablePromise<TicketScan> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/ticket',
+            query: {
+                'c': c,
+                'devicename': devicename,
+                'lang': lang,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Used to get seat details by location
+     * Returns a SeatResponse object with details about the seat when provided section, row, or seat
+     * @param c Show code
+     * @param section The section to use to search
+     * @param row The row to use to search
+     * @param seat The seat number to use to search
+     * @param lang Language for error messages to be returned in
+     * @returns SeatResponse Seat information by section, row, and seat number.
+     * @throws ApiError
+     */
+    public static appControllerGetSeat(
+        c: string,
+        section: string,
+        row: string,
+        seat: number,
+        lang?: any,
+    ): CancelablePromise<SeatResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/seat',
+            query: {
+                'c': c,
+                'section': section,
+                'row': row,
+                'seat': seat,
+                'lang': lang,
+            },
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Used to get a receipt by its GUID
+     * Returns a ReceiptResponse object with details about the receipt
+     * @param guid The unique guid associated with the receipt
+     * @param lang Language for error messages to be returned in
+     * @returns ReceiptResponse Get a receipt's details.
+     * @throws ApiError
+     */
+    public static appControllerGetReceipt(
+        guid: string,
+        lang?: any,
+    ): CancelablePromise<ReceiptResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/receipt',
+            query: {
+                'guid': guid,
+                'lang': lang,
+            },
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Used to get a mobile receipt by its GUID
+     * Returns a MobileReceiptResponse object with details about the receipt
+     * @param guid The unique guid associated with the mobile receipt
+     * @param lang Language for error messages to be returned in
+     * @returns MobileReceiptResponse Get a mobile receipt's details.
+     * @throws ApiError
+     */
+    public static appControllerGetReceiptMobile(
+        guid: string,
+        lang?: any,
+    ): CancelablePromise<MobileReceiptResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/receipt-mobile',
+            query: {
+                'guid': guid,
+                'lang': lang,
+            },
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Used to get an order by its orderId, showCode, and type
+     * Returns an OrderDetails object with details about the order
+     * @param c Show code
+     * @param oid The orderId associated with the order
+     * @param type The type of order to retrieve
+     * @param lang Language for error messages to be returned in
+     * @returns OrderDetails Returns order details given a receipt.
+     * @throws ApiError
+     */
+    public static appControllerGetOrder(
+        c: string,
+        oid: number,
+        type: 'seats' | 'merch',
+        lang?: any,
+    ): CancelablePromise<OrderDetails> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/order',
+            query: {
+                'c': c,
+                'oid': oid,
+                'type': type,
+                'lang': lang,
+            },
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Used to scan every remaining ticket in an order
+     * Scans all unscanned tickets in an order and returns an OrderScan object summarizing the results
+     * @param c Show code
+     * @param devicename The name of the device issuing the request
+     * @param requestBody The order to scan, identified by orderId
+     * @param lang Language for error messages to be returned in
+     * @returns OrderScan Scans the order and returns the scan information.
+     * @throws ApiError
+     */
+    public static appControllerScanEntireOrder(
+        c: string,
+        devicename: string,
+        requestBody: {
+            orderId?: {
+                oid?: number;
+            };
+        },
+        lang?: string,
+    ): CancelablePromise<OrderScan> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/order',
+            query: {
+                'c': c,
+                'devicename': devicename,
+                'lang': lang,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Used to get a show by its showCode
+     * Returns details for a single event.
+     * @param c Show code
+     * @param devicename The name of the device issuing the request
+     * @param lang Language for error messages to be returned in
+     * @returns EventResponse Returns an EventResponse object with details about the event
+     * @throws ApiError
+     */
+    public static appControllerGetShow(
+        c: string,
+        devicename: string,
+        lang?: any,
+    ): CancelablePromise<EventResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/show',
+            query: {
+                'c': c,
+                'devicename': devicename,
+                'lang': lang,
+            },
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Used to get a JSON object of all the strings used in the app
+     * Returns a JSON object of all the strings needed to run the app
+     * @param lang Language for error messages to be returned in
+     * @returns any Returns a JSON object of all the strings needed to run the app
+     * @throws ApiError
+     */
+    public static appControllerGetStrings(
+        lang?: any,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/strings',
+            query: {
+                'lang': lang,
+            },
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+}