@drttix/drt-sdk 0.8.4 → 0.9.0

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

@@ -1,377 +1,377 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { AdminUserLevelResponseDto } from '../models/AdminUserLevelResponseDto';
-import type { AdminUserResponseDto } from '../models/AdminUserResponseDto';
-import type { BugReportRequestDto } from '../models/BugReportRequestDto';
-import type { CreateUpdateAdminUserRequestDto } from '../models/CreateUpdateAdminUserRequestDto';
-import type { MessageSettingResponseDto } from '../models/MessageSettingResponseDto';
-import type { NotificationSettingRequestDto } from '../models/NotificationSettingRequestDto';
-import type { NotificationSettingsResponseDto } from '../models/NotificationSettingsResponseDto';
-import type { PolicyRequestDto } from '../models/PolicyRequestDto';
-import type { PolicyResponseDto } from '../models/PolicyResponseDto';
-import type { PosSettingsRequestDto } from '../models/PosSettingsRequestDto';
-import type { PosSettingsResponseDto } from '../models/PosSettingsResponseDto';
-import type { SettingsDetailsResponseDto } from '../models/SettingsDetailsResponseDto';
-import type { SuccessResponse } from '../models/SuccessResponse';
-import type { UpdateMessageRequestDto } from '../models/UpdateMessageRequestDto';
-import type { UpdateStudioSettingsRequestDto } from '../models/UpdateStudioSettingsRequestDto';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { OpenAPI } from '../core/OpenAPI';
-import { request as __request } from '../core/request';
-export class SettingsService {
-    /**
-     * Fetch the studio settings
-     * To fetch the studio settings and details
-     * @param xStudioId The ID of the studio
-     * @returns SettingsDetailsResponseDto Studio settings fetched successfully
-     * @throws ApiError
-     */
-    public static getStudioSettings(
-        xStudioId: string,
-    ): CancelablePromise<SettingsDetailsResponseDto> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/settings',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-        });
-    }
-    /**
-     * Fetch the notification settings
-     * To fetch the notification settings and details
-     * @param xStudioId The ID of the studio
-     * @returns NotificationSettingsResponseDto Notification settings fetched successfully
-     * @throws ApiError
-     */
-    public static getNotificationSettings(
-        xStudioId: string,
-    ): CancelablePromise<Array<NotificationSettingsResponseDto>> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/settings/notifications',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-        });
-    }
-    /**
-     * Fetch the POS settings
-     * To fetch the POS settings and details
-     * @param xStudioId The ID of the studio
-     * @returns PosSettingsResponseDto POS settings fetched successfully
-     * @throws ApiError
-     */
-    public static getPosSettings(
-        xStudioId: string,
-    ): CancelablePromise<Array<PosSettingsResponseDto>> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/settings/pos-settings',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-        });
-    }
-    /**
-     * Fetch the Policies
-     * To fetch the Policies and details
-     * @param xStudioId The ID of the studio
-     * @returns PolicyResponseDto Policies fetched successfully
-     * @throws ApiError
-     */
-    public static getPolicies(
-        xStudioId: string,
-    ): CancelablePromise<Array<PolicyResponseDto>> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/settings/policies',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-        });
-    }
-    /**
-     * Fetch the Messages
-     * To fetch the Messages and details
-     * @param xStudioId The ID of the studio
-     * @returns MessageSettingResponseDto Messages fetched successfully
-     * @throws ApiError
-     */
-    public static getMessages(
-        xStudioId: string,
-    ): CancelablePromise<MessageSettingResponseDto> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/settings/messages',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-        });
-    }
-    /**
-     * Fetch the Users
-     * To fetch the Users and details
-     * @param xStudioId The ID of the studio
-     * @returns AdminUserResponseDto Users fetched successfully
-     * @throws ApiError
-     */
-    public static getUsers(
-        xStudioId: string,
-    ): CancelablePromise<Array<AdminUserResponseDto>> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/settings/users',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-        });
-    }
-    /**
-     * Fetch the Users login level
-     * To fetch the Users login level details
-     * @param xStudioId The ID of the studio
-     * @returns AdminUserLevelResponseDto Users fetched successfully
-     * @throws ApiError
-     */
-    public static getUsersLoginLevels(
-        xStudioId: string,
-    ): CancelablePromise<Array<AdminUserLevelResponseDto>> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/settings/login-levels',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-        });
-    }
-    /**
-     * Fetch the Users login level
-     * To fetch the Users login level details
-     * @param xStudioId The ID of the studio
-     * @param loginId The value of the login ID
-     * @returns AdminUserLevelResponseDto Users fetched successfully
-     * @throws ApiError
-     */
-    public static getUsersLoginDetails(
-        xStudioId: string,
-        loginId: string,
-    ): CancelablePromise<AdminUserLevelResponseDto> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/settings/{loginId}/login-details',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-            query: {
-                'loginId': loginId,
-            },
-        });
-    }
-    /**
-     * Create the Users login
-     * To create a new Users login
-     * @param xStudioId The ID of the studio
-     * @param requestBody User login details to be created
-     * @returns SuccessResponse User login created successfully
-     * @throws ApiError
-     */
-    public static createUserLogin(
-        xStudioId: string,
-        requestBody: CreateUpdateAdminUserRequestDto,
-    ): CancelablePromise<SuccessResponse> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/settings/user-login',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-        });
-    }
-    /**
-     * Update the logged in user's studio settings
-     * Updates the studio setting for the logged in user
-     * @param xStudioId The ID of the studio
-     * @param requestBody Studio settings to be updated
-     * @returns SuccessResponse Studio settings Updated successfully
-     * @throws ApiError
-     */
-    public static updateStudioSettings(
-        xStudioId: string,
-        requestBody: UpdateStudioSettingsRequestDto,
-    ): CancelablePromise<SuccessResponse> {
-        return __request(OpenAPI, {
-            method: 'PUT',
-            url: '/settings/update-studio-settings',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-        });
-    }
-    /**
-     * Update the notification settings
-     * Updates the notification settings for the logged in user
-     * @param xStudioId The ID of the studio
-     * @param requestBody Notification settings to be updated
-     * @returns SuccessResponse Notification Settings Updated successfully
-     * @throws ApiError
-     */
-    public static updateNotificationSettings(
-        xStudioId: string,
-        requestBody: Array<NotificationSettingRequestDto>,
-    ): CancelablePromise<SuccessResponse> {
-        return __request(OpenAPI, {
-            method: 'PUT',
-            url: '/settings/update-notification-settings',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-        });
-    }
-    /**
-     * Update the POS settings
-     * Updates the POS settings for the logged in user
-     * @param xStudioId The ID of the studio
-     * @param requestBody POS settings to be updated
-     * @returns SuccessResponse POS Settings Updated successfully
-     * @throws ApiError
-     */
-    public static updatePosSettings(
-        xStudioId: string,
-        requestBody: Array<PosSettingsRequestDto>,
-    ): CancelablePromise<SuccessResponse> {
-        return __request(OpenAPI, {
-            method: 'PUT',
-            url: '/settings/update-pos-settings',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-        });
-    }
-    /**
-     * Update the Policy settings
-     * Updates the Policy settings for the logged in user
-     * @param xStudioId The ID of the studio
-     * @param requestBody Policy settings to be updated
-     * @returns SuccessResponse Policy Settings Updated successfully
-     * @throws ApiError
-     */
-    public static updatePolicySettings(
-        xStudioId: string,
-        requestBody: PolicyRequestDto,
-    ): CancelablePromise<SuccessResponse> {
-        return __request(OpenAPI, {
-            method: 'PUT',
-            url: '/settings/update-policy-settings',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-        });
-    }
-    /**
-     * Update the Message settings
-     * Updates the Message settings for the logged in user
-     * @param xStudioId The ID of the studio
-     * @param requestBody Message to be updated
-     * @returns SuccessResponse Message updated successfully
-     * @throws ApiError
-     */
-    public static updateMessageSettings(
-        xStudioId: string,
-        requestBody: UpdateMessageRequestDto,
-    ): CancelablePromise<SuccessResponse> {
-        return __request(OpenAPI, {
-            method: 'PUT',
-            url: '/settings/update-message',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-        });
-    }
-    /**
-     * Update the Users login
-     * To update a Users login
-     * @param xStudioId The ID of the studio
-     * @param loginId The value of the login ID
-     * @param requestBody User login details to be updated
-     * @returns SuccessResponse User login updated successfully
-     * @throws ApiError
-     */
-    public static updateUserLogin(
-        xStudioId: string,
-        loginId: string,
-        requestBody: CreateUpdateAdminUserRequestDto,
-    ): CancelablePromise<SuccessResponse> {
-        return __request(OpenAPI, {
-            method: 'PUT',
-            url: '/settings/{loginId}/user-login',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-            query: {
-                'loginId': loginId,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-        });
-    }
-    /**
-     * Delete the Users login
-     * To delete a Users login
-     * @param xStudioId The ID of the studio
-     * @param loginId The value of the login ID
-     * @returns SuccessResponse User login deleted successfully
-     * @throws ApiError
-     */
-    public static deleteUserLogin(
-        xStudioId: string,
-        loginId: string,
-    ): CancelablePromise<SuccessResponse> {
-        return __request(OpenAPI, {
-            method: 'DELETE',
-            url: '/settings/{loginId}',
-            headers: {
-                'x-studio-id': xStudioId,
-            },
-            query: {
-                'loginId': loginId,
-            },
-        });
-    }
-    /**
-     * Create a bug report
-     * To create a new bug report for an admin tool
-     * @param xStudioId The ID of the studio
-     * @param requestBody Bug report details to be created
-     * @returns SuccessResponse Bug report created successfully
-     * @throws ApiError
-     */
-    public static createBugReport(
-        xStudioId: string,
-        requestBody: BugReportRequestDto,
-    ): CancelablePromise<SuccessResponse> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/settings/bug-report',
-            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 { AdminUserLevelResponseDto } from '../models/AdminUserLevelResponseDto';
+import type { AdminUserResponseDto } from '../models/AdminUserResponseDto';
+import type { BugReportRequestDto } from '../models/BugReportRequestDto';
+import type { CreateUpdateAdminUserRequestDto } from '../models/CreateUpdateAdminUserRequestDto';
+import type { MessageSettingResponseDto } from '../models/MessageSettingResponseDto';
+import type { NotificationSettingRequestDto } from '../models/NotificationSettingRequestDto';
+import type { NotificationSettingsResponseDto } from '../models/NotificationSettingsResponseDto';
+import type { PolicyRequestDto } from '../models/PolicyRequestDto';
+import type { PolicyResponseDto } from '../models/PolicyResponseDto';
+import type { PosSettingsRequestDto } from '../models/PosSettingsRequestDto';
+import type { PosSettingsResponseDto } from '../models/PosSettingsResponseDto';
+import type { SettingsDetailsResponseDto } from '../models/SettingsDetailsResponseDto';
+import type { SuccessResponse } from '../models/SuccessResponse';
+import type { UpdateMessageRequestDto } from '../models/UpdateMessageRequestDto';
+import type { UpdateStudioSettingsRequestDto } from '../models/UpdateStudioSettingsRequestDto';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class SettingsService {
+    /**
+     * Fetch the studio settings
+     * To fetch the studio settings and details
+     * @param xStudioId The ID of the studio
+     * @returns SettingsDetailsResponseDto Studio settings fetched successfully
+     * @throws ApiError
+     */
+    public static getStudioSettings(
+        xStudioId: string,
+    ): CancelablePromise<SettingsDetailsResponseDto> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/settings',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Fetch the notification settings
+     * To fetch the notification settings and details
+     * @param xStudioId The ID of the studio
+     * @returns NotificationSettingsResponseDto Notification settings fetched successfully
+     * @throws ApiError
+     */
+    public static getNotificationSettings(
+        xStudioId: string,
+    ): CancelablePromise<Array<NotificationSettingsResponseDto>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/settings/notifications',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Fetch the POS settings
+     * To fetch the POS settings and details
+     * @param xStudioId The ID of the studio
+     * @returns PosSettingsResponseDto POS settings fetched successfully
+     * @throws ApiError
+     */
+    public static getPosSettings(
+        xStudioId: string,
+    ): CancelablePromise<Array<PosSettingsResponseDto>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/settings/pos-settings',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Fetch the Policies
+     * To fetch the Policies and details
+     * @param xStudioId The ID of the studio
+     * @returns PolicyResponseDto Policies fetched successfully
+     * @throws ApiError
+     */
+    public static getPolicies(
+        xStudioId: string,
+    ): CancelablePromise<Array<PolicyResponseDto>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/settings/policies',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Fetch the Messages
+     * To fetch the Messages and details
+     * @param xStudioId The ID of the studio
+     * @returns MessageSettingResponseDto Messages fetched successfully
+     * @throws ApiError
+     */
+    public static getMessages(
+        xStudioId: string,
+    ): CancelablePromise<MessageSettingResponseDto> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/settings/messages',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Fetch the Users
+     * To fetch the Users and details
+     * @param xStudioId The ID of the studio
+     * @returns AdminUserResponseDto Users fetched successfully
+     * @throws ApiError
+     */
+    public static getUsers(
+        xStudioId: string,
+    ): CancelablePromise<Array<AdminUserResponseDto>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/settings/users',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Fetch the Users login level
+     * To fetch the Users login level details
+     * @param xStudioId The ID of the studio
+     * @returns AdminUserLevelResponseDto Users fetched successfully
+     * @throws ApiError
+     */
+    public static getUsersLoginLevels(
+        xStudioId: string,
+    ): CancelablePromise<Array<AdminUserLevelResponseDto>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/settings/login-levels',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+        });
+    }
+    /**
+     * Fetch the Users login level
+     * To fetch the Users login level details
+     * @param xStudioId The ID of the studio
+     * @param loginId The value of the login ID
+     * @returns AdminUserLevelResponseDto Users fetched successfully
+     * @throws ApiError
+     */
+    public static getUsersLoginDetails(
+        xStudioId: string,
+        loginId: string,
+    ): CancelablePromise<AdminUserLevelResponseDto> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/settings/{loginId}/login-details',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            query: {
+                'loginId': loginId,
+            },
+        });
+    }
+    /**
+     * Create the Users login
+     * To create a new Users login
+     * @param xStudioId The ID of the studio
+     * @param requestBody User login details to be created
+     * @returns SuccessResponse User login created successfully
+     * @throws ApiError
+     */
+    public static createUserLogin(
+        xStudioId: string,
+        requestBody: CreateUpdateAdminUserRequestDto,
+    ): CancelablePromise<SuccessResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/settings/user-login',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Update the logged in user's studio settings
+     * Updates the studio setting for the logged in user
+     * @param xStudioId The ID of the studio
+     * @param requestBody Studio settings to be updated
+     * @returns SuccessResponse Studio settings Updated successfully
+     * @throws ApiError
+     */
+    public static updateStudioSettings(
+        xStudioId: string,
+        requestBody: UpdateStudioSettingsRequestDto,
+    ): CancelablePromise<SuccessResponse> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/settings/update-studio-settings',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Update the notification settings
+     * Updates the notification settings for the logged in user
+     * @param xStudioId The ID of the studio
+     * @param requestBody Notification settings to be updated
+     * @returns SuccessResponse Notification Settings Updated successfully
+     * @throws ApiError
+     */
+    public static updateNotificationSettings(
+        xStudioId: string,
+        requestBody: Array<NotificationSettingRequestDto>,
+    ): CancelablePromise<SuccessResponse> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/settings/update-notification-settings',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Update the POS settings
+     * Updates the POS settings for the logged in user
+     * @param xStudioId The ID of the studio
+     * @param requestBody POS settings to be updated
+     * @returns SuccessResponse POS Settings Updated successfully
+     * @throws ApiError
+     */
+    public static updatePosSettings(
+        xStudioId: string,
+        requestBody: Array<PosSettingsRequestDto>,
+    ): CancelablePromise<SuccessResponse> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/settings/update-pos-settings',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Update the Policy settings
+     * Updates the Policy settings for the logged in user
+     * @param xStudioId The ID of the studio
+     * @param requestBody Policy settings to be updated
+     * @returns SuccessResponse Policy Settings Updated successfully
+     * @throws ApiError
+     */
+    public static updatePolicySettings(
+        xStudioId: string,
+        requestBody: PolicyRequestDto,
+    ): CancelablePromise<SuccessResponse> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/settings/update-policy-settings',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Update the Message settings
+     * Updates the Message settings for the logged in user
+     * @param xStudioId The ID of the studio
+     * @param requestBody Message to be updated
+     * @returns SuccessResponse Message updated successfully
+     * @throws ApiError
+     */
+    public static updateMessageSettings(
+        xStudioId: string,
+        requestBody: UpdateMessageRequestDto,
+    ): CancelablePromise<SuccessResponse> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/settings/update-message',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Update the Users login
+     * To update a Users login
+     * @param xStudioId The ID of the studio
+     * @param loginId The value of the login ID
+     * @param requestBody User login details to be updated
+     * @returns SuccessResponse User login updated successfully
+     * @throws ApiError
+     */
+    public static updateUserLogin(
+        xStudioId: string,
+        loginId: string,
+        requestBody: CreateUpdateAdminUserRequestDto,
+    ): CancelablePromise<SuccessResponse> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/settings/{loginId}/user-login',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            query: {
+                'loginId': loginId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Delete the Users login
+     * To delete a Users login
+     * @param xStudioId The ID of the studio
+     * @param loginId The value of the login ID
+     * @returns SuccessResponse User login deleted successfully
+     * @throws ApiError
+     */
+    public static deleteUserLogin(
+        xStudioId: string,
+        loginId: string,
+    ): CancelablePromise<SuccessResponse> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/settings/{loginId}',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            query: {
+                'loginId': loginId,
+            },
+        });
+    }
+    /**
+     * Create a bug report
+     * To create a new bug report for an admin tool
+     * @param xStudioId The ID of the studio
+     * @param requestBody Bug report details to be created
+     * @returns SuccessResponse Bug report created successfully
+     * @throws ApiError
+     */
+    public static createBugReport(
+        xStudioId: string,
+        requestBody: BugReportRequestDto,
+    ): CancelablePromise<SuccessResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/settings/bug-report',
+            headers: {
+                'x-studio-id': xStudioId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}