@drttix/drt-sdk 1.2.0 → 1.2.1

package/src/generated/shopper/services/OrderService.ts

@@ -1,359 +1,359 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { AssignNamesReturn } from '../models/AssignNamesReturn';
-import type { EmailUpdate } from '../models/EmailUpdate';
-import type { GuidReturn } from '../models/GuidReturn';
-import type { LinkWithSuccess } from '../models/LinkWithSuccess';
-import type { NameUpdate } from '../models/NameUpdate';
-import type { OrderRecalc } from '../models/OrderRecalc';
-import type { PickupReturn } from '../models/PickupReturn';
-import type { RecalcResponse } from '../models/RecalcResponse';
-import type { Receipt } from '../models/Receipt';
-import type { RefundRequest } from '../models/RefundRequest';
-import type { RefundRequestInfo } from '../models/RefundRequestInfo';
-import type { RegisterStreamRequest } from '../models/RegisterStreamRequest';
-import type { RegisterStreamResponse } from '../models/RegisterStreamResponse';
-import type { SuccessResponse } from '../models/SuccessResponse';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { OpenAPI } from '../core/OpenAPI';
-import { request as __request } from '../core/request';
-export class OrderService {
-    /**
-     * Get order receipt by guid
-     * Fetches the receipt for an order using its unique guid.
-     * @param guid Unique identifier for an order.
-     * @returns Receipt Returns the order receipt.
-     * @throws ApiError
-     */
-    public static getReceipt(
-        guid: string,
-    ): CancelablePromise<Receipt> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/order/receipt',
-            query: {
-                'guid': guid,
-            },
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Get Gwallet link by guid
-     * Fetches the Gwallet link for an order using its unique guid.
-     * @param guid Unique identifier for an order.
-     * @returns LinkWithSuccess Returns the Gwallet link.
-     * @throws ApiError
-     */
-    public static getGwalletLink(
-        guid: string,
-    ): CancelablePromise<LinkWithSuccess> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/order/gwallet',
-            query: {
-                'guid': guid,
-            },
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Get testing guid
-     * Fetches a testing guid for development purposes.
-     * @param guid Unique identifier for an order.
-     * @returns GuidReturn Returns a testing guid.
-     * @throws ApiError
-     */
-    public static getTestingGuid(
-        guid: string,
-    ): CancelablePromise<GuidReturn> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/order/testing',
-            query: {
-                'guid': guid,
-            },
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Get assign names by guid
-     * Fetches the assign names information for an order using its unique guid.
-     * @param guid Unique identifier for an order.
-     * @returns AssignNamesReturn Returns the assign names information.
-     * @throws ApiError
-     */
-    public static getAssignNames(
-        guid: string,
-    ): CancelablePromise<AssignNamesReturn> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/order/assign-names',
-            query: {
-                'guid': guid,
-            },
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Post assign names
-     * Assigns names to an order using its unique guid and the provided names.
-     * @param guid Unique identifier for an order.
-     * @param requestBody Names to be assigned to the order.
-     * @returns SuccessResponse Returns success status after assigning names.
-     * @throws ApiError
-     */
-    public static postAssignNames(
-        guid: string,
-        requestBody: NameUpdate,
-    ): CancelablePromise<SuccessResponse> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/order/assign-names',
-            query: {
-                'guid': guid,
-            },
-            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.`,
-            },
-        });
-    }
-    /**
-     * Post email tickets
-     * Sends email tickets for an order using its unique guid and the provided email update.
-     * @param guid Unique identifier for an order.
-     * @param requestBody Email update containing the email address to send tickets.
-     * @returns SuccessResponse Returns success status after sending email tickets.
-     * @throws ApiError
-     */
-    public static postEmailTickets(
-        guid: string,
-        requestBody: EmailUpdate,
-    ): CancelablePromise<SuccessResponse> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/order/email-tickets',
-            query: {
-                'guid': guid,
-            },
-            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.`,
-            },
-        });
-    }
-    /**
-     * Get ticket block by guid
-     * Fetches the ticket block for an order using its unique guid.
-     * @param guid Unique identifier for an order.
-     * @returns PickupReturn Returns the ticket block for the order.
-     * @throws ApiError
-     */
-    public static getTicketBlock(
-        guid: string,
-    ): CancelablePromise<PickupReturn> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/order/pickup',
-            query: {
-                'guid': guid,
-            },
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Post ticket block by guid
-     * Sends the ticket block for an order using its unique guid.
-     * @param guid Unique identifier for an order.
-     * @returns SuccessResponse Returns the ticket block for the order.
-     * @throws ApiError
-     */
-    public static postPickup(
-        guid: string,
-    ): CancelablePromise<SuccessResponse> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/order/pickup',
-            query: {
-                'guid': guid,
-            },
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Send order receipt via email
-     * Sends the order receipt to the shopper's email address for the specified order guid.
-     * @param guid Unique identifier for an order.
-     * @returns SuccessResponse Returns success status after emailing the receipt.
-     * @throws ApiError
-     */
-    public static postEmailReceipt(
-        guid: string,
-    ): CancelablePromise<SuccessResponse> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/order/email-receipt',
-            query: {
-                'guid': guid,
-            },
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Get refund request information
-     * Fetches the refund request information for an order using its unique guid.
-     * @param guid Unique identifier for an order.
-     * @returns RefundRequestInfo Returns the refund request information for the order.
-     * @throws ApiError
-     */
-    public static getRefundRequest(
-        guid: string,
-    ): CancelablePromise<RefundRequestInfo> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/order/refund-request',
-            query: {
-                'guid': guid,
-            },
-            errors: {
-                400: `Bad Request error with error details.`,
-                404: `Not found error with error details.`,
-                500: `Internal Server Error, please contact developers.`,
-            },
-        });
-    }
-    /**
-     * Submit a refund request
-     * Submits a refund request for an order using its unique guid and the provided refund details.
-     * @param guid Unique identifier for an order.
-     * @param requestBody Refund request details.
-     * @returns SuccessResponse Returns success status after submitting the refund request.
-     * @throws ApiError
-     */
-    public static postRefundRequest(
-        guid: string,
-        requestBody: RefundRequest,
-    ): CancelablePromise<SuccessResponse> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/order/refund-request',
-            query: {
-                'guid': guid,
-            },
-            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.`,
-            },
-        });
-    }
-    /**
-     * Recalculate order totals
-     * Recalculates the totals for an order using the provided recalculation data.
-     * @param guid Unique identifier for an order.
-     * @param requestBody Order recalculation data.
-     * @returns RecalcResponse Returns the recalculated order totals and success status.
-     * @throws ApiError
-     */
-    public static postRecalcOrder(
-        guid: string,
-        requestBody: OrderRecalc,
-    ): CancelablePromise<RecalcResponse> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/order/recalc',
-            query: {
-                'guid': guid,
-            },
-            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.`,
-            },
-        });
-    }
-    /**
-     * Register a stream for a shopper
-     * Registers a stream for the specified shopper and account using the provided stream registration details.
-     * @param requestBody Stream registration details.
-     * @returns RegisterStreamResponse Returns the stream registration response.
-     * @throws ApiError
-     */
-    public static postRegisterStream(
-        requestBody: RegisterStreamRequest,
-    ): CancelablePromise<RegisterStreamResponse> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/order/stream-register',
-            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.`,
-            },
-        });
-    }
-    /**
-     * Deregister a stream for a shopper
-     * Removes the stream registration for the specified shopper and account using the provided stream registration details.
-     * @param requestBody Stream registration details to be deregistered.
-     * @returns SuccessResponse Returns success status after deregistering the stream.
-     * @throws ApiError
-     */
-    public static deleteRegisteredStream(
-        requestBody: RegisterStreamRequest,
-    ): CancelablePromise<SuccessResponse> {
-        return __request(OpenAPI, {
-            method: 'DELETE',
-            url: '/order/stream-register',
-            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.`,
-            },
-        });
-    }
-}
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { AssignNamesReturn } from '../models/AssignNamesReturn';
+import type { EmailUpdate } from '../models/EmailUpdate';
+import type { GuidReturn } from '../models/GuidReturn';
+import type { LinkWithSuccess } from '../models/LinkWithSuccess';
+import type { NameUpdate } from '../models/NameUpdate';
+import type { OrderRecalc } from '../models/OrderRecalc';
+import type { PickupReturn } from '../models/PickupReturn';
+import type { RecalcResponse } from '../models/RecalcResponse';
+import type { Receipt } from '../models/Receipt';
+import type { RefundRequest } from '../models/RefundRequest';
+import type { RefundRequestInfo } from '../models/RefundRequestInfo';
+import type { RegisterStreamRequest } from '../models/RegisterStreamRequest';
+import type { RegisterStreamResponse } from '../models/RegisterStreamResponse';
+import type { SuccessResponse } from '../models/SuccessResponse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class OrderService {
+    /**
+     * Get order receipt by guid
+     * Fetches the receipt for an order using its unique guid.
+     * @param guid Unique identifier for an order.
+     * @returns Receipt Returns the order receipt.
+     * @throws ApiError
+     */
+    public static getReceipt(
+        guid: string,
+    ): CancelablePromise<Receipt> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/order/receipt',
+            query: {
+                'guid': guid,
+            },
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Get Gwallet link by guid
+     * Fetches the Gwallet link for an order using its unique guid.
+     * @param guid Unique identifier for an order.
+     * @returns LinkWithSuccess Returns the Gwallet link.
+     * @throws ApiError
+     */
+    public static getGwalletLink(
+        guid: string,
+    ): CancelablePromise<LinkWithSuccess> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/order/gwallet',
+            query: {
+                'guid': guid,
+            },
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Get testing guid
+     * Fetches a testing guid for development purposes.
+     * @param guid Unique identifier for an order.
+     * @returns GuidReturn Returns a testing guid.
+     * @throws ApiError
+     */
+    public static getTestingGuid(
+        guid: string,
+    ): CancelablePromise<GuidReturn> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/order/testing',
+            query: {
+                'guid': guid,
+            },
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Get assign names by guid
+     * Fetches the assign names information for an order using its unique guid.
+     * @param guid Unique identifier for an order.
+     * @returns AssignNamesReturn Returns the assign names information.
+     * @throws ApiError
+     */
+    public static getAssignNames(
+        guid: string,
+    ): CancelablePromise<AssignNamesReturn> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/order/assign-names',
+            query: {
+                'guid': guid,
+            },
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Post assign names
+     * Assigns names to an order using its unique guid and the provided names.
+     * @param guid Unique identifier for an order.
+     * @param requestBody Names to be assigned to the order.
+     * @returns SuccessResponse Returns success status after assigning names.
+     * @throws ApiError
+     */
+    public static postAssignNames(
+        guid: string,
+        requestBody: NameUpdate,
+    ): CancelablePromise<SuccessResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/order/assign-names',
+            query: {
+                'guid': guid,
+            },
+            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.`,
+            },
+        });
+    }
+    /**
+     * Post email tickets
+     * Sends email tickets for an order using its unique guid and the provided email update.
+     * @param guid Unique identifier for an order.
+     * @param requestBody Email update containing the email address to send tickets.
+     * @returns SuccessResponse Returns success status after sending email tickets.
+     * @throws ApiError
+     */
+    public static postEmailTickets(
+        guid: string,
+        requestBody: EmailUpdate,
+    ): CancelablePromise<SuccessResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/order/email-tickets',
+            query: {
+                'guid': guid,
+            },
+            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.`,
+            },
+        });
+    }
+    /**
+     * Get ticket block by guid
+     * Fetches the ticket block for an order using its unique guid.
+     * @param guid Unique identifier for an order.
+     * @returns PickupReturn Returns the ticket block for the order.
+     * @throws ApiError
+     */
+    public static getTicketBlock(
+        guid: string,
+    ): CancelablePromise<PickupReturn> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/order/pickup',
+            query: {
+                'guid': guid,
+            },
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Post ticket block by guid
+     * Sends the ticket block for an order using its unique guid.
+     * @param guid Unique identifier for an order.
+     * @returns SuccessResponse Returns the ticket block for the order.
+     * @throws ApiError
+     */
+    public static postPickup(
+        guid: string,
+    ): CancelablePromise<SuccessResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/order/pickup',
+            query: {
+                'guid': guid,
+            },
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Send order receipt via email
+     * Sends the order receipt to the shopper's email address for the specified order guid.
+     * @param guid Unique identifier for an order.
+     * @returns SuccessResponse Returns success status after emailing the receipt.
+     * @throws ApiError
+     */
+    public static postEmailReceipt(
+        guid: string,
+    ): CancelablePromise<SuccessResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/order/email-receipt',
+            query: {
+                'guid': guid,
+            },
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Get refund request information
+     * Fetches the refund request information for an order using its unique guid.
+     * @param guid Unique identifier for an order.
+     * @returns RefundRequestInfo Returns the refund request information for the order.
+     * @throws ApiError
+     */
+    public static getRefundRequest(
+        guid: string,
+    ): CancelablePromise<RefundRequestInfo> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/order/refund-request',
+            query: {
+                'guid': guid,
+            },
+            errors: {
+                400: `Bad Request error with error details.`,
+                404: `Not found error with error details.`,
+                500: `Internal Server Error, please contact developers.`,
+            },
+        });
+    }
+    /**
+     * Submit a refund request
+     * Submits a refund request for an order using its unique guid and the provided refund details.
+     * @param guid Unique identifier for an order.
+     * @param requestBody Refund request details.
+     * @returns SuccessResponse Returns success status after submitting the refund request.
+     * @throws ApiError
+     */
+    public static postRefundRequest(
+        guid: string,
+        requestBody: RefundRequest,
+    ): CancelablePromise<SuccessResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/order/refund-request',
+            query: {
+                'guid': guid,
+            },
+            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.`,
+            },
+        });
+    }
+    /**
+     * Recalculate order totals
+     * Recalculates the totals for an order using the provided recalculation data.
+     * @param guid Unique identifier for an order.
+     * @param requestBody Order recalculation data.
+     * @returns RecalcResponse Returns the recalculated order totals and success status.
+     * @throws ApiError
+     */
+    public static postRecalcOrder(
+        guid: string,
+        requestBody: OrderRecalc,
+    ): CancelablePromise<RecalcResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/order/recalc',
+            query: {
+                'guid': guid,
+            },
+            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.`,
+            },
+        });
+    }
+    /**
+     * Register a stream for a shopper
+     * Registers a stream for the specified shopper and account using the provided stream registration details.
+     * @param requestBody Stream registration details.
+     * @returns RegisterStreamResponse Returns the stream registration response.
+     * @throws ApiError
+     */
+    public static postRegisterStream(
+        requestBody: RegisterStreamRequest,
+    ): CancelablePromise<RegisterStreamResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/order/stream-register',
+            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.`,
+            },
+        });
+    }
+    /**
+     * Deregister a stream for a shopper
+     * Removes the stream registration for the specified shopper and account using the provided stream registration details.
+     * @param requestBody Stream registration details to be deregistered.
+     * @returns SuccessResponse Returns success status after deregistering the stream.
+     * @throws ApiError
+     */
+    public static deleteRegisteredStream(
+        requestBody: RegisterStreamRequest,
+    ): CancelablePromise<SuccessResponse> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/order/stream-register',
+            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.`,
+            },
+        });
+    }
+}