@drttix/drt-sdk 0.1.2 → 0.2.1

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

@@ -0,0 +1,267 @@
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class OrderLookupService {
+    /**
+     * Get the landing page filters
+     * Retrieves the landing page order lookup filters
+     * @param xStudioId The ID of the studio
+     * @returns OrderFiltersResponseDto Order Lookup filters fetched successfully
+     * @throws ApiError
+     */
+    static getOrderFilters(xStudioId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/order-lookup',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Get the order actions
+     * Retrieves the order actions
+     * @param xStudioId The ID of the studio
+     * @param orderId The ID of the order
+     * @returns OrderActionsResponseDto Order actions fetched successfully
+     * @throws ApiError
+     */
+    static getOrderActions(xStudioId, orderId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/order-lookup/{orderId}/order-actions',
+            path: {
+                'orderId': orderId,
+            },
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Get the order details
+     * Retrieves the order details
+     * @param xStudioId The ID of the studio
+     * @param orderId The ID of the order
+     * @returns SingleOrderDetailResponseDto Order details fetched successfully
+     * @throws ApiError
+     */
+    static getOrderDetails(xStudioId, orderId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/order-lookup/{orderId}/order-details',
+            path: {
+                'orderId': orderId,
+            },
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Get the order ledger
+     * Retrieves the order ledger
+     * @param xStudioId The ID of the studio
+     * @param orderId The ID of the order
+     * @returns OrderLedgerDetailsResponseDto Order ledger fetched successfully
+     * @throws ApiError
+     */
+    static getOrderLedger(xStudioId, orderId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/order-lookup/{orderId}/order-ledger',
+            path: {
+                'orderId': orderId,
+            },
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Get the landing page order and ticket details
+     * Retrieves the landing page order details including tickets
+     * @param xStudioId The ID of the studio
+     * @param orderId The ID of the order
+     * @returns OrderTicketDetailResponseDto Order and ticket details fetched successfully
+     * @throws ApiError
+     */
+    static getOrderTicketDetails(xStudioId, orderId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/order-lookup/{orderId}/order-ticket-details',
+            path: {
+                'orderId': orderId,
+            },
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Get the order seat details
+     * Retrieves the details of the seat for the particular order
+     * @param xStudioId The ID of the studio
+     * @param orderId The ID of the order
+     * @returns OrderSeatDetailsResponseDto Order seat details fetched successfully
+     * @throws ApiError
+     */
+    static getOrderSeatDetails(xStudioId, orderId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/order-lookup/{orderId}/order-seats',
+            path: {
+                'orderId': orderId,
+            },
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Get the show details
+     * Retrieves the details of the shows
+     * @param xStudioId The ID of the studio
+     * @param orderId The ID of the order
+     * @returns ShowDetailsResponseDto Show details fetched successfully
+     * @throws ApiError
+     */
+    static getShowDetails(xStudioId, orderId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/order-lookup/{orderId}/shows-list',
+            path: {
+                'orderId': orderId,
+            },
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Get the exchange selected seats
+     * Retrieves the exchange selected seats
+     * @param shopperGuid Unique identifier for an shopper.
+     * @returns SelectedSeatExchangeResponseDto Ticket exchange selected seats fetched successfully
+     * @throws ApiError
+     */
+    static exchangeSelectedSeats(shopperGuid) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/order-lookup/ticket-exchange-selected-seats',
+            query: {
+                'shopperGuid': shopperGuid,
+            },
+        });
+    }
+    /**
+     * Get the order list details
+     * Retrieves the order list details
+     * @param xStudioId The ID of the studio
+     * @param requestBody
+     * @returns OrderListResponseDto Order list fetched successfully
+     * @throws ApiError
+     */
+    static getOrderListDetails(xStudioId, requestBody) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/order-lookup/order-list',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Change the type of the tier
+     * Toggle tier to another available type for the same seats
+     * @param requestBody
+     * @returns ToggleTierResponseDto Tier type changed successfully
+     * @throws ApiError
+     */
+    static toggleTier(requestBody) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/order-lookup/toggle-tier',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Get details of show and tier
+     * Fetch details of the show with tier details
+     * @param xStudioId The ID of the studio
+     * @param requestBody
+     * @returns ShowTierResponseDto Show and tier details fetched successfully
+     * @throws ApiError
+     */
+    static getShowAndTier(xStudioId, requestBody) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/order-lookup/show-tier',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Send email to buyers
+     * To send email to the buyers of the orders
+     * @param xStudioId The ID of the studio
+     * @param requestBody Email details
+     * @returns SuccessResponse Email sent successfully
+     * @throws ApiError
+     */
+    static emailBuyers(xStudioId, requestBody) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/order-lookup/email-buyers',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Save administrative note
+     * To save an administrative note for the orders
+     * @param xStudioId The ID of the studio
+     * @param requestBody Save administrative note payload
+     * @returns SuccessResponse Note saved successfully
+     * @throws ApiError
+     */
+    static saveNote(xStudioId, requestBody) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/order-lookup/save-note',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Reset primary video stream
+     * To reset the primary video stream for the orders
+     * @param orderId The ID of the order
+     * @param xStudioId The ID of the studio
+     * @returns SuccessResponse Primary video stream reseted successfully
+     * @throws ApiError
+     */
+    static resetPrimaryVideoStream(orderId, xStudioId) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/order-lookup/{orderId}/reset-primary-video-stream',
+            path: {
+                'orderId': orderId,
+            },
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+}

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

@@ -0,0 +1,193 @@
+import type { CheckoutAnswerOrderRequestDto } from '../models/CheckoutAnswerOrderRequestDto';
+import type { CheckoutAnswerOrderResponseDto } from '../models/CheckoutAnswerOrderResponseDto';
+import type { CheckoutAnswerQuestionResponseDto } from '../models/CheckoutAnswerQuestionResponseDto';
+import type { DonationFundsResponseDto } from '../models/DonationFundsResponseDto';
+import type { DonationReportResponseDto } from '../models/DonationReportResponseDto';
+import type { DonationRequestDto } from '../models/DonationRequestDto';
+import type { PatronManifestDetailResponseDto } from '../models/PatronManifestDetailResponseDto';
+import type { PerformerCreditOrderRequestDto } from '../models/PerformerCreditOrderRequestDto';
+import type { ProductSalesRequestDto } from '../models/ProductSalesRequestDto';
+import type { ReportProductSalesResponseDto } from '../models/ReportProductSalesResponseDto';
+import type { RevenueByShowRequestDto } from '../models/RevenueByShowRequestDto';
+import type { RevenueShowCalculationsResponseDto } from '../models/RevenueShowCalculationsResponseDto';
+import type { SalesByTierReponseDto } from '../models/SalesByTierReponseDto';
+import type { SalesProductResponseDto } from '../models/SalesProductResponseDto';
+import type { ScannedTicketOrderResponseDto } from '../models/ScannedTicketOrderResponseDto';
+import type { ShowReportListResponseDto } from '../models/ShowReportListResponseDto';
+import type { SoldTicketsResponseDto } from '../models/SoldTicketsResponseDto';
+import type { StudentCreditBuyerResponseDto } from '../models/StudentCreditBuyerResponseDto';
+import type { StudentCreditOrdersResponseDto } from '../models/StudentCreditOrdersResponseDto';
+import type { StudentCreditResponseDto } from '../models/StudentCreditResponseDto';
+import type { SuccessResponse } from '../models/SuccessResponse';
+import type { TaxByMonthRequestDto } from '../models/TaxByMonthRequestDto';
+import type { TaxByMonthResponseDto } from '../models/TaxByMonthResponseDto';
+import type { UnsoldTicketsResponseDto } from '../models/UnsoldTicketsResponseDto';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class ReportsService {
+    /**
+     * Fetch the patron manifest details
+     * Fetch the patron manifest details
+     * @param xStudioId The ID of the studio
+     * @returns ShowReportListResponseDto Patron manifest fetched successfully
+     * @throws ApiError
+     */
+    static getPatronManifestReport(xStudioId: string): CancelablePromise<Array<ShowReportListResponseDto>>;
+    /**
+     * Fetch the patron manifest by show details
+     * Fetch the patron manifest by show details
+     * @param xStudioId The ID of the studio
+     * @param showId The ID of the show
+     * @returns PatronManifestDetailResponseDto Patron manifest by show fetched successfully
+     * @throws ApiError
+     */
+    static getPatronManifestByShow(xStudioId: string, showId: string): CancelablePromise<Array<PatronManifestDetailResponseDto>>;
+    /**
+     * Fetch the ticket sales report details
+     * Fetch the ticket sales report details
+     * @param xStudioId The ID of the studio
+     * @returns ShowReportListResponseDto Ticket Sales fetched successfully
+     * @throws ApiError
+     */
+    static getTicketSalesReport(xStudioId: string): CancelablePromise<Array<ShowReportListResponseDto>>;
+    /**
+     * Fetch the sold seats details
+     * Fetch the sold seats details
+     * @param showId The ID of the show
+     * @param xStudioId The ID of the studio
+     * @returns SoldTicketsResponseDto Sold seats fetched successfully
+     * @throws ApiError
+     */
+    static getSoldSeatsByShow(showId: string, xStudioId: string): CancelablePromise<Array<SoldTicketsResponseDto>>;
+    /**
+     * Fetch the unsold seats details
+     * Fetch the unsold seats details
+     * @param showId The ID of the show
+     * @param xStudioId The ID of the studio
+     * @returns UnsoldTicketsResponseDto Unsold seats fetched successfully
+     * @throws ApiError
+     */
+    static getUnsoldSeatsByShow(showId: string, xStudioId: string): CancelablePromise<Array<UnsoldTicketsResponseDto>>;
+    /**
+     * Fetch the tier seating details
+     * Fetch the tier seating details
+     * @param xStudioId The ID of the studio
+     * @returns SalesByTierReponseDto Tier seating information fetched successfully
+     * @throws ApiError
+     */
+    static getSalesByTierReport(xStudioId: string): CancelablePromise<Array<SalesByTierReponseDto>>;
+    /**
+     * Fetch the show revenue details
+     * Fetch the Show revenue details
+     * @param xStudioId The ID of the studio
+     * @param requestBody Shows and date range for revenue report
+     * @returns RevenueShowCalculationsResponseDto Show revenue fetched successfully
+     * @throws ApiError
+     */
+    static getRevenueByShow(xStudioId: string, requestBody: RevenueByShowRequestDto): CancelablePromise<Array<RevenueShowCalculationsResponseDto>>;
+    /**
+     * Fetch the credited performer report
+     * Fetch the credited performer report
+     * @param xStudioId The ID of the studio
+     * @param showId The ID of the show
+     * @param orderId The ID of the order
+     * @returns StudentCreditResponseDto Credited performer details fetched successfully
+     * @throws ApiError
+     */
+    static getCreditedPerformerReport(xStudioId: string, showId?: string, orderId?: string): CancelablePromise<Array<StudentCreditResponseDto>>;
+    /**
+     * Fetch the credited performers orders details
+     * Fetch the credited performers orders details
+     * @param xStudioId The ID of the studio
+     * @param requestBody ShowId and/or performer name for credit orders
+     * @returns StudentCreditOrdersResponseDto Credited performers orders fetched successfully
+     * @throws ApiError
+     */
+    static getCreditedPerformerDetails(xStudioId: string, requestBody: PerformerCreditOrderRequestDto): CancelablePromise<StudentCreditOrdersResponseDto>;
+    /**
+     * Fetch the buyer details for credited performer
+     * Fetch the buyer details for credited performer
+     * @param xStudioId The ID of the studio
+     * @param orderId The ID of the order
+     * @returns StudentCreditBuyerResponseDto Buyer details for credited performer fetched successfully
+     * @throws ApiError
+     */
+    static getCreditedPerformerByOrder(xStudioId: string, orderId: string): CancelablePromise<StudentCreditBuyerResponseDto>;
+    /**
+     * Fetch the product sales details
+     * Fetch the product sales details
+     * @param xStudioId The ID of the studio
+     * @param requestBody Report for product sales
+     * @returns ReportProductSalesResponseDto Product sales fetched successfully
+     * @throws ApiError
+     */
+    static productSalesReport(xStudioId: string, requestBody: ProductSalesRequestDto): CancelablePromise<Array<ReportProductSalesResponseDto>>;
+    /**
+     * Fetch the donation sales report details
+     * Fetch the donation sales report details
+     * @param xStudioId The ID of the studio
+     * @param requestBody Donation report filters
+     * @returns DonationReportResponseDto Donation sales report fetched successfully
+     * @throws ApiError
+     */
+    static getDonationsReport(xStudioId: string, requestBody: DonationRequestDto): CancelablePromise<Array<DonationReportResponseDto>>;
+    /**
+     * Fetch the checkout response report details
+     * Fetch the checkout response report details
+     * @param xStudioId The ID of the studio
+     * @param requestBody Questions and/or the search query for the Checkout Questions
+     * @returns CheckoutAnswerOrderResponseDto Checkout Responses fetched successfully
+     * @throws ApiError
+     */
+    static getCheckoutResponsesReport(xStudioId: string, requestBody: CheckoutAnswerOrderRequestDto): CancelablePromise<Array<CheckoutAnswerOrderResponseDto>>;
+    /**
+     * Fetch the scanned ticket shows details
+     * Fetch the scanned ticket shows details
+     * @param xStudioId The ID of the studio
+     * @returns ScannedTicketOrderResponseDto Scanned ticket shows fetched successfully
+     * @throws ApiError
+     */
+    static getScannedTicketsReport(xStudioId: string): CancelablePromise<Array<ScannedTicketOrderResponseDto>>;
+    /**
+     * Fetch the tax report details
+     * Fetch the tax report details
+     * @param xStudioId The ID of the studio
+     * @param requestBody Date range for the tax report
+     * @returns TaxByMonthResponseDto Tax report fetched successfully
+     * @throws ApiError
+     */
+    static getTaxReport(xStudioId: string, requestBody: TaxByMonthRequestDto): CancelablePromise<Array<TaxByMonthResponseDto>>;
+    /**
+     * Fetch the checkout answer questions details
+     * Fetch the checkout answer questions details
+     * @param xStudioId The ID of the studio
+     * @param showId The ID of the show
+     * @returns CheckoutAnswerQuestionResponseDto Checkout answer questions fetched successfully
+     * @throws ApiError
+     */
+    static getCheckoutResponsesReport1(xStudioId: string, showId?: any): CancelablePromise<CheckoutAnswerQuestionResponseDto>;
+    /**
+     * Fetch the sales products details
+     * Fetch the sales products details
+     * @param xStudioId The ID of the studio
+     * @returns SalesProductResponseDto Sales products fetched successfully
+     * @throws ApiError
+     */
+    static getProductSalesReport(xStudioId: string): CancelablePromise<Array<SalesProductResponseDto>>;
+    /**
+     * Fetch the donation funds details
+     * Fetch the donation funds details
+     * @param xStudioId The ID of the studio
+     * @returns DonationFundsResponseDto Donation funds fetched successfully
+     * @throws ApiError
+     */
+    static getDonationsReport1(xStudioId: string): CancelablePromise<Array<DonationFundsResponseDto>>;
+    /**
+     * Reset the scanned tickets
+     * Reset the scanned tickets
+     * @param showId The ID of the show
+     * @param xStudioId The ID of the studio
+     * @returns SuccessResponse Scanned tickets reset successfully
+     * @throws ApiError
+     */
+    static getUnsoldSeatsByShow1(showId: string, xStudioId: string): CancelablePromise<SuccessResponse>;
+}