@digital8/security-registers-backend-ts-sdk 0.0.201 → 0.0.203

package/src/apis/GeneralApi.ts

@@ -29,6 +29,10 @@ import type {
   LicencesUpdateRequest,
   LicencesVerifyRequest,
   LoginAuthRequest,
+  NotificationPreferenceResource,
+  NotificationPreferenceResourceArrayResponse,
+  NotificationPreferencesStoreRequest,
+  NotificationTypeResourceArrayResponse,
   PaginatedLicenceListResourceResponse,
   PaginatedRegisterGroupedByRosterResourceResponse,
   PaginatedRosterListResourceResponse,
@@ -110,6 +114,14 @@ import {
     LicencesVerifyRequestToJSON,
     LoginAuthRequestFromJSON,
     LoginAuthRequestToJSON,
+    NotificationPreferenceResourceFromJSON,
+    NotificationPreferenceResourceToJSON,
+    NotificationPreferenceResourceArrayResponseFromJSON,
+    NotificationPreferenceResourceArrayResponseToJSON,
+    NotificationPreferencesStoreRequestFromJSON,
+    NotificationPreferencesStoreRequestToJSON,
+    NotificationTypeResourceArrayResponseFromJSON,
+    NotificationTypeResourceArrayResponseToJSON,
     PaginatedLicenceListResourceResponseFromJSON,
     PaginatedLicenceListResourceResponseToJSON,
     PaginatedRegisterGroupedByRosterResourceResponseFromJSON,
@@ -263,6 +275,14 @@ export interface LoginAuthOperationRequest {
     loginAuthRequest?: LoginAuthRequest;
 }
 
+export interface NotificationPreferencesDeleteRequest {
+    notificationPreference: number;
+}
+
+export interface NotificationPreferencesStoreOperationRequest {
+    notificationPreferencesStoreRequest?: NotificationPreferencesStoreRequest;
+}
+
 export interface RegistersCreateOperationRequest {
     registersCreateRequest?: RegistersCreateRequest;
 }
@@ -1042,6 +1062,165 @@ export class GeneralApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Auto-generated: notificationPreferences.delete
+     */
+    async notificationPreferencesDeleteRaw(requestParameters: NotificationPreferencesDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
+        if (requestParameters['notificationPreference'] == null) {
+            throw new runtime.RequiredError(
+                'notificationPreference',
+                'Required parameter "notificationPreference" was null or undefined when calling notificationPreferencesDelete().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/notification-preferences/{notificationPreference}/delete`;
+        urlPath = urlPath.replace(`{${"notificationPreference"}}`, encodeURIComponent(String(requestParameters['notificationPreference'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: notificationPreferences.delete
+     */
+    async notificationPreferencesDelete(requestParameters: NotificationPreferencesDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
+        const response = await this.notificationPreferencesDeleteRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: notificationPreferences.list
+     */
+    async notificationPreferencesListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NotificationPreferenceResourceArrayResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/notification-preferences/list`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => NotificationPreferenceResourceArrayResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: notificationPreferences.list
+     */
+    async notificationPreferencesList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NotificationPreferenceResourceArrayResponse> {
+        const response = await this.notificationPreferencesListRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: notificationPreferences.store
+     */
+    async notificationPreferencesStoreRaw(requestParameters: NotificationPreferencesStoreOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NotificationPreferenceResource>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/notification-preferences`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: NotificationPreferencesStoreRequestToJSON(requestParameters['notificationPreferencesStoreRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => NotificationPreferenceResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: notificationPreferences.store
+     */
+    async notificationPreferencesStore(requestParameters: NotificationPreferencesStoreOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NotificationPreferenceResource> {
+        const response = await this.notificationPreferencesStoreRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: notificationTypes.list
+     */
+    async notificationTypesListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NotificationTypeResourceArrayResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/notification-types/list`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => NotificationTypeResourceArrayResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: notificationTypes.list
+     */
+    async notificationTypesList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NotificationTypeResourceArrayResponse> {
+        const response = await this.notificationTypesListRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Auto-generated: registers.create
      */

package/src/models/AddressResource.ts

@@ -36,7 +36,7 @@ export interface AddressResource {
      * @type {string}
      * @memberof AddressResource
      */
-    addressLine2?: string | null;
+    addressLine2: string;
     /**
      * 
      * @type {string}
@@ -80,6 +80,7 @@ export interface AddressResource {
  */
 export function instanceOfAddressResource(value: object): value is AddressResource {
     if (!('addressLine1' in value) || value['addressLine1'] === undefined) return false;
+    if (!('addressLine2' in value) || value['addressLine2'] === undefined) return false;
     if (!('suburb' in value) || value['suburb'] === undefined) return false;
     if (!('city' in value) || value['city'] === undefined) return false;
     if (!('state' in value) || value['state'] === undefined) return false;
@@ -101,7 +102,7 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
         
         'id': json['id'] == null ? undefined : json['id'],
         'addressLine1': json['addressLine1'],
-        'addressLine2': json['addressLine2'] == null ? undefined : json['addressLine2'],
+        'addressLine2': json['addressLine2'],
         'suburb': json['suburb'],
         'city': json['city'],
         'state': json['state'],

package/src/models/NotificationPreferenceResource.ts

@@ -0,0 +1,116 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { VenueLiteResource } from './VenueLiteResource';
+import {
+    VenueLiteResourceFromJSON,
+    VenueLiteResourceFromJSONTyped,
+    VenueLiteResourceToJSON,
+    VenueLiteResourceToJSONTyped,
+} from './VenueLiteResource';
+
+/**
+ * 
+ * @export
+ * @interface NotificationPreferenceResource
+ */
+export interface NotificationPreferenceResource {
+    /**
+     * 
+     * @type {number}
+     * @memberof NotificationPreferenceResource
+     */
+    id?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof NotificationPreferenceResource
+     */
+    notificationType: string;
+    /**
+     * 
+     * @type {VenueLiteResource}
+     * @memberof NotificationPreferenceResource
+     */
+    venue: VenueLiteResource | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof NotificationPreferenceResource
+     */
+    enabled: boolean;
+    /**
+     * 
+     * @type {Date}
+     * @memberof NotificationPreferenceResource
+     */
+    createdAt?: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof NotificationPreferenceResource
+     */
+    updatedAt?: Date | null;
+}
+
+/**
+ * Check if a given object implements the NotificationPreferenceResource interface.
+ */
+export function instanceOfNotificationPreferenceResource(value: object): value is NotificationPreferenceResource {
+    if (!('notificationType' in value) || value['notificationType'] === undefined) return false;
+    if (!('venue' in value) || value['venue'] === undefined) return false;
+    if (!('enabled' in value) || value['enabled'] === undefined) return false;
+    return true;
+}
+
+export function NotificationPreferenceResourceFromJSON(json: any): NotificationPreferenceResource {
+    return NotificationPreferenceResourceFromJSONTyped(json, false);
+}
+
+export function NotificationPreferenceResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationPreferenceResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'notificationType': json['notificationType'],
+        'venue': VenueLiteResourceFromJSON(json['venue']),
+        'enabled': json['enabled'],
+        'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
+        'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
+    };
+}
+
+export function NotificationPreferenceResourceToJSON(json: any): NotificationPreferenceResource {
+    return NotificationPreferenceResourceToJSONTyped(json, false);
+}
+
+export function NotificationPreferenceResourceToJSONTyped(value?: NotificationPreferenceResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'notificationType': value['notificationType'],
+        'venue': VenueLiteResourceToJSON(value['venue']),
+        'enabled': value['enabled'],
+        'createdAt': value['createdAt'] === null ? null : ((value['createdAt'] as any)?.toISOString()),
+        'updatedAt': value['updatedAt'] === null ? null : ((value['updatedAt'] as any)?.toISOString()),
+    };
+}
+

package/src/models/NotificationPreferenceResourceArrayResponse.ts

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { NotificationPreferenceResource } from './NotificationPreferenceResource';
+import {
+    NotificationPreferenceResourceFromJSON,
+    NotificationPreferenceResourceFromJSONTyped,
+    NotificationPreferenceResourceToJSON,
+    NotificationPreferenceResourceToJSONTyped,
+} from './NotificationPreferenceResource';
+
+/**
+ * 
+ * @export
+ * @interface NotificationPreferenceResourceArrayResponse
+ */
+export interface NotificationPreferenceResourceArrayResponse {
+    /**
+     * 
+     * @type {Array<NotificationPreferenceResource>}
+     * @memberof NotificationPreferenceResourceArrayResponse
+     */
+    data?: Array<NotificationPreferenceResource>;
+}
+
+/**
+ * Check if a given object implements the NotificationPreferenceResourceArrayResponse interface.
+ */
+export function instanceOfNotificationPreferenceResourceArrayResponse(value: object): value is NotificationPreferenceResourceArrayResponse {
+    return true;
+}
+
+export function NotificationPreferenceResourceArrayResponseFromJSON(json: any): NotificationPreferenceResourceArrayResponse {
+    return NotificationPreferenceResourceArrayResponseFromJSONTyped(json, false);
+}
+
+export function NotificationPreferenceResourceArrayResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationPreferenceResourceArrayResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(NotificationPreferenceResourceFromJSON)),
+    };
+}
+
+export function NotificationPreferenceResourceArrayResponseToJSON(json: any): NotificationPreferenceResourceArrayResponse {
+    return NotificationPreferenceResourceArrayResponseToJSONTyped(json, false);
+}
+
+export function NotificationPreferenceResourceArrayResponseToJSONTyped(value?: NotificationPreferenceResourceArrayResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(NotificationPreferenceResourceToJSON)),
+    };
+}
+

package/src/models/NotificationPreferencesStoreRequest.ts

@@ -0,0 +1,97 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface NotificationPreferencesStoreRequest
+ */
+export interface NotificationPreferencesStoreRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof NotificationPreferencesStoreRequest
+     */
+    notificationType: NotificationPreferencesStoreRequestNotificationTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof NotificationPreferencesStoreRequest
+     */
+    venueId?: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof NotificationPreferencesStoreRequest
+     */
+    enabled: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const NotificationPreferencesStoreRequestNotificationTypeEnum = {
+    IncidentAdded: 'incident_added',
+    NonSignOff: 'non_sign_off',
+    NonSignOn: 'non_sign_on',
+    SignOnRejected: 'sign_on_rejected',
+    LicenceUpdated: 'licence_updated'
+} as const;
+export type NotificationPreferencesStoreRequestNotificationTypeEnum = typeof NotificationPreferencesStoreRequestNotificationTypeEnum[keyof typeof NotificationPreferencesStoreRequestNotificationTypeEnum];
+
+
+/**
+ * Check if a given object implements the NotificationPreferencesStoreRequest interface.
+ */
+export function instanceOfNotificationPreferencesStoreRequest(value: object): value is NotificationPreferencesStoreRequest {
+    if (!('notificationType' in value) || value['notificationType'] === undefined) return false;
+    if (!('enabled' in value) || value['enabled'] === undefined) return false;
+    return true;
+}
+
+export function NotificationPreferencesStoreRequestFromJSON(json: any): NotificationPreferencesStoreRequest {
+    return NotificationPreferencesStoreRequestFromJSONTyped(json, false);
+}
+
+export function NotificationPreferencesStoreRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationPreferencesStoreRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'notificationType': json['notification_type'],
+        'venueId': json['venue_id'] == null ? undefined : json['venue_id'],
+        'enabled': json['enabled'],
+    };
+}
+
+export function NotificationPreferencesStoreRequestToJSON(json: any): NotificationPreferencesStoreRequest {
+    return NotificationPreferencesStoreRequestToJSONTyped(json, false);
+}
+
+export function NotificationPreferencesStoreRequestToJSONTyped(value?: NotificationPreferencesStoreRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'notification_type': value['notificationType'],
+        'venue_id': value['venueId'],
+        'enabled': value['enabled'],
+    };
+}
+

package/src/models/NotificationTypeResource.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface NotificationTypeResource
+ */
+export interface NotificationTypeResource {
+    /**
+     * 
+     * @type {string}
+     * @memberof NotificationTypeResource
+     */
+    value: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof NotificationTypeResource
+     */
+    label: string;
+}
+
+/**
+ * Check if a given object implements the NotificationTypeResource interface.
+ */
+export function instanceOfNotificationTypeResource(value: object): value is NotificationTypeResource {
+    if (!('value' in value) || value['value'] === undefined) return false;
+    if (!('label' in value) || value['label'] === undefined) return false;
+    return true;
+}
+
+export function NotificationTypeResourceFromJSON(json: any): NotificationTypeResource {
+    return NotificationTypeResourceFromJSONTyped(json, false);
+}
+
+export function NotificationTypeResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationTypeResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'value': json['value'],
+        'label': json['label'],
+    };
+}
+
+export function NotificationTypeResourceToJSON(json: any): NotificationTypeResource {
+    return NotificationTypeResourceToJSONTyped(json, false);
+}
+
+export function NotificationTypeResourceToJSONTyped(value?: NotificationTypeResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'value': value['value'],
+        'label': value['label'],
+    };
+}
+

package/src/models/NotificationTypeResourceArrayResponse.ts

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { NotificationTypeResource } from './NotificationTypeResource';
+import {
+    NotificationTypeResourceFromJSON,
+    NotificationTypeResourceFromJSONTyped,
+    NotificationTypeResourceToJSON,
+    NotificationTypeResourceToJSONTyped,
+} from './NotificationTypeResource';
+
+/**
+ * 
+ * @export
+ * @interface NotificationTypeResourceArrayResponse
+ */
+export interface NotificationTypeResourceArrayResponse {
+    /**
+     * 
+     * @type {Array<NotificationTypeResource>}
+     * @memberof NotificationTypeResourceArrayResponse
+     */
+    data?: Array<NotificationTypeResource>;
+}
+
+/**
+ * Check if a given object implements the NotificationTypeResourceArrayResponse interface.
+ */
+export function instanceOfNotificationTypeResourceArrayResponse(value: object): value is NotificationTypeResourceArrayResponse {
+    return true;
+}
+
+export function NotificationTypeResourceArrayResponseFromJSON(json: any): NotificationTypeResourceArrayResponse {
+    return NotificationTypeResourceArrayResponseFromJSONTyped(json, false);
+}
+
+export function NotificationTypeResourceArrayResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationTypeResourceArrayResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(NotificationTypeResourceFromJSON)),
+    };
+}
+
+export function NotificationTypeResourceArrayResponseToJSON(json: any): NotificationTypeResourceArrayResponse {
+    return NotificationTypeResourceArrayResponseToJSONTyped(json, false);
+}
+
+export function NotificationTypeResourceArrayResponseToJSONTyped(value?: NotificationTypeResourceArrayResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(NotificationTypeResourceToJSON)),
+    };
+}
+