@digital8/security-registers-backend-ts-sdk 0.0.143 → 0.0.145

package/src/models/RosterWithRegistersResource.ts

@@ -0,0 +1,167 @@
+/* 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';
+import type { SecurityCompanyLiteResource } from './SecurityCompanyLiteResource';
+import {
+    SecurityCompanyLiteResourceFromJSON,
+    SecurityCompanyLiteResourceFromJSONTyped,
+    SecurityCompanyLiteResourceToJSON,
+    SecurityCompanyLiteResourceToJSONTyped,
+} from './SecurityCompanyLiteResource';
+import type { RegisterListResource } from './RegisterListResource';
+import {
+    RegisterListResourceFromJSON,
+    RegisterListResourceFromJSONTyped,
+    RegisterListResourceToJSON,
+    RegisterListResourceToJSONTyped,
+} from './RegisterListResource';
+
+/**
+ * 
+ * @export
+ * @interface RosterWithRegistersResource
+ */
+export interface RosterWithRegistersResource {
+    /**
+     * 
+     * @type {number}
+     * @memberof RosterWithRegistersResource
+     */
+    id?: number | null;
+    /**
+     * 
+     * @type {VenueLiteResource}
+     * @memberof RosterWithRegistersResource
+     */
+    venue: VenueLiteResource | null;
+    /**
+     * 
+     * @type {object}
+     * @memberof RosterWithRegistersResource
+     */
+    state: object;
+    /**
+     * 
+     * @type {SecurityCompanyLiteResource}
+     * @memberof RosterWithRegistersResource
+     */
+    securityCompany: SecurityCompanyLiteResource | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof RosterWithRegistersResource
+     */
+    startDateTime: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof RosterWithRegistersResource
+     */
+    finishDateTime?: Date | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof RosterWithRegistersResource
+     */
+    isCompliant: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof RosterWithRegistersResource
+     */
+    isComplete: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof RosterWithRegistersResource
+     */
+    signOffStatus: number;
+    /**
+     * 
+     * @type {Array<RegisterListResource>}
+     * @memberof RosterWithRegistersResource
+     */
+    registers: Array<RegisterListResource> | null;
+}
+
+/**
+ * Check if a given object implements the RosterWithRegistersResource interface.
+ */
+export function instanceOfRosterWithRegistersResource(value: object): value is RosterWithRegistersResource {
+    if (!('venue' in value) || value['venue'] === undefined) return false;
+    if (!('state' in value) || value['state'] === undefined) return false;
+    if (!('securityCompany' in value) || value['securityCompany'] === undefined) return false;
+    if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
+    if (!('isCompliant' in value) || value['isCompliant'] === undefined) return false;
+    if (!('isComplete' in value) || value['isComplete'] === undefined) return false;
+    if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
+    if (!('registers' in value) || value['registers'] === undefined) return false;
+    return true;
+}
+
+export function RosterWithRegistersResourceFromJSON(json: any): RosterWithRegistersResource {
+    return RosterWithRegistersResourceFromJSONTyped(json, false);
+}
+
+export function RosterWithRegistersResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): RosterWithRegistersResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'venue': VenueLiteResourceFromJSON(json['venue']),
+        'state': json['state'],
+        'securityCompany': SecurityCompanyLiteResourceFromJSON(json['securityCompany']),
+        'startDateTime': (new Date(json['startDateTime'])),
+        'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
+        'isCompliant': json['isCompliant'],
+        'isComplete': json['isComplete'],
+        'signOffStatus': json['signOffStatus'],
+        'registers': (json['registers'] == null ? null : (json['registers'] as Array<any>).map(RegisterListResourceFromJSON)),
+    };
+}
+
+export function RosterWithRegistersResourceToJSON(json: any): RosterWithRegistersResource {
+    return RosterWithRegistersResourceToJSONTyped(json, false);
+}
+
+export function RosterWithRegistersResourceToJSONTyped(value?: RosterWithRegistersResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'venue': VenueLiteResourceToJSON(value['venue']),
+        'state': value['state'],
+        'securityCompany': SecurityCompanyLiteResourceToJSON(value['securityCompany']),
+        'startDateTime': ((value['startDateTime']).toISOString()),
+        'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
+        'isCompliant': value['isCompliant'],
+        'isComplete': value['isComplete'],
+        'signOffStatus': value['signOffStatus'],
+        'registers': (value['registers'] == null ? null : (value['registers'] as Array<any>).map(RegisterListResourceToJSON)),
+    };
+}
+

package/src/models/RosterWithRegistersResourceArrayResponse.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 { RosterWithRegistersResource } from './RosterWithRegistersResource';
+import {
+    RosterWithRegistersResourceFromJSON,
+    RosterWithRegistersResourceFromJSONTyped,
+    RosterWithRegistersResourceToJSON,
+    RosterWithRegistersResourceToJSONTyped,
+} from './RosterWithRegistersResource';
+
+/**
+ * 
+ * @export
+ * @interface RosterWithRegistersResourceArrayResponse
+ */
+export interface RosterWithRegistersResourceArrayResponse {
+    /**
+     * 
+     * @type {Array<RosterWithRegistersResource>}
+     * @memberof RosterWithRegistersResourceArrayResponse
+     */
+    data?: Array<RosterWithRegistersResource>;
+}
+
+/**
+ * Check if a given object implements the RosterWithRegistersResourceArrayResponse interface.
+ */
+export function instanceOfRosterWithRegistersResourceArrayResponse(value: object): value is RosterWithRegistersResourceArrayResponse {
+    return true;
+}
+
+export function RosterWithRegistersResourceArrayResponseFromJSON(json: any): RosterWithRegistersResourceArrayResponse {
+    return RosterWithRegistersResourceArrayResponseFromJSONTyped(json, false);
+}
+
+export function RosterWithRegistersResourceArrayResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RosterWithRegistersResourceArrayResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(RosterWithRegistersResourceFromJSON)),
+    };
+}
+
+export function RosterWithRegistersResourceArrayResponseToJSON(json: any): RosterWithRegistersResourceArrayResponse {
+    return RosterWithRegistersResourceArrayResponseToJSONTyped(json, false);
+}
+
+export function RosterWithRegistersResourceArrayResponseToJSONTyped(value?: RosterWithRegistersResourceArrayResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(RosterWithRegistersResourceToJSON)),
+    };
+}
+

package/src/models/RostersExportPdfRequest.ts

@@ -0,0 +1,150 @@
+/* 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 RostersExportPdfRequest
+ */
+export interface RostersExportPdfRequest {
+    /**
+     * 
+     * @type {number}
+     * @memberof RostersExportPdfRequest
+     */
+    venueId: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RostersExportPdfRequest
+     */
+    state?: RostersExportPdfRequestStateEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof RostersExportPdfRequest
+     */
+    guardId?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RostersExportPdfRequest
+     */
+    securityCompanyId?: number;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof RostersExportPdfRequest
+     */
+    isComplete?: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof RostersExportPdfRequest
+     */
+    isCompliant?: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof RostersExportPdfRequest
+     */
+    bookNumber: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof RostersExportPdfRequest
+     */
+    afterStartDateTime: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof RostersExportPdfRequest
+     */
+    beforeStartDateTime: Date;
+}
+
+
+/**
+ * @export
+ */
+export const RostersExportPdfRequestStateEnum = {
+    Qld: 'QLD',
+    Nsw: 'NSW',
+    Act: 'ACT',
+    Vic: 'VIC',
+    Tas: 'TAS',
+    Sa: 'SA',
+    Wa: 'WA',
+    Nt: 'NT'
+} as const;
+export type RostersExportPdfRequestStateEnum = typeof RostersExportPdfRequestStateEnum[keyof typeof RostersExportPdfRequestStateEnum];
+
+
+/**
+ * Check if a given object implements the RostersExportPdfRequest interface.
+ */
+export function instanceOfRostersExportPdfRequest(value: object): value is RostersExportPdfRequest {
+    if (!('venueId' in value) || value['venueId'] === undefined) return false;
+    if (!('bookNumber' in value) || value['bookNumber'] === undefined) return false;
+    if (!('afterStartDateTime' in value) || value['afterStartDateTime'] === undefined) return false;
+    if (!('beforeStartDateTime' in value) || value['beforeStartDateTime'] === undefined) return false;
+    return true;
+}
+
+export function RostersExportPdfRequestFromJSON(json: any): RostersExportPdfRequest {
+    return RostersExportPdfRequestFromJSONTyped(json, false);
+}
+
+export function RostersExportPdfRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RostersExportPdfRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'venueId': json['venue_id'],
+        'state': json['state'] == null ? undefined : json['state'],
+        'guardId': json['guard_id'] == null ? undefined : json['guard_id'],
+        'securityCompanyId': json['security_company_id'] == null ? undefined : json['security_company_id'],
+        'isComplete': json['is_complete'] == null ? undefined : json['is_complete'],
+        'isCompliant': json['is_compliant'] == null ? undefined : json['is_compliant'],
+        'bookNumber': json['book_number'],
+        'afterStartDateTime': (new Date(json['after_start_date_time'])),
+        'beforeStartDateTime': (new Date(json['before_start_date_time'])),
+    };
+}
+
+export function RostersExportPdfRequestToJSON(json: any): RostersExportPdfRequest {
+    return RostersExportPdfRequestToJSONTyped(json, false);
+}
+
+export function RostersExportPdfRequestToJSONTyped(value?: RostersExportPdfRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'venue_id': value['venueId'],
+        'state': value['state'],
+        'guard_id': value['guardId'],
+        'security_company_id': value['securityCompanyId'],
+        'is_complete': value['isComplete'],
+        'is_compliant': value['isCompliant'],
+        'book_number': value['bookNumber'],
+        'after_start_date_time': ((value['afterStartDateTime']).toISOString()),
+        'before_start_date_time': ((value['beforeStartDateTime']).toISOString()),
+    };
+}
+

package/src/models/RostersListRequest.ts

@@ -45,10 +45,10 @@ export interface RostersListRequest {
     perPage?: number;
     /**
      * 
-     * @type {number}
+     * @type {string}
      * @memberof RostersListRequest
      */
-    page?: number;
+    page?: string;
     /**
      * 
      * @type {Array<string>}

package/src/models/RostersListWithRegistersRequest.ts

@@ -0,0 +1,231 @@
+/* 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 RostersListWithRegistersRequest
+ */
+export interface RostersListWithRegistersRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof RostersListWithRegistersRequest
+     */
+    search?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RostersListWithRegistersRequest
+     */
+    sortBy?: RostersListWithRegistersRequestSortByEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof RostersListWithRegistersRequest
+     */
+    sortDirection?: RostersListWithRegistersRequestSortDirectionEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof RostersListWithRegistersRequest
+     */
+    perPage?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RostersListWithRegistersRequest
+     */
+    page?: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof RostersListWithRegistersRequest
+     */
+    isComplete?: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof RostersListWithRegistersRequest
+     */
+    isCompliant?: Array<string>;
+    /**
+     * 
+     * @type {Date}
+     * @memberof RostersListWithRegistersRequest
+     */
+    beforeStartDateTime?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof RostersListWithRegistersRequest
+     */
+    afterStartDateTime?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof RostersListWithRegistersRequest
+     */
+    beforeFinishDateTime?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof RostersListWithRegistersRequest
+     */
+    afterFinishDateTime?: Date;
+    /**
+     * 
+     * @type {number}
+     * @memberof RostersListWithRegistersRequest
+     */
+    relatedId?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RostersListWithRegistersRequest
+     */
+    relatedType?: RostersListWithRegistersRequestRelatedTypeEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof RostersListWithRegistersRequest
+     */
+    includesRelations?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof RostersListWithRegistersRequest
+     */
+    state?: RostersListWithRegistersRequestStateEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof RostersListWithRegistersRequest
+     */
+    guardId?: number;
+}
+
+
+/**
+ * @export
+ */
+export const RostersListWithRegistersRequestSortByEnum = {
+    VenueName: 'venue-name',
+    SecurityCompanyName: 'securityCompany-name',
+    StartDateTime: 'start_date_time',
+    FinishDateTime: 'finish_date_time'
+} as const;
+export type RostersListWithRegistersRequestSortByEnum = typeof RostersListWithRegistersRequestSortByEnum[keyof typeof RostersListWithRegistersRequestSortByEnum];
+
+/**
+ * @export
+ */
+export const RostersListWithRegistersRequestSortDirectionEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+} as const;
+export type RostersListWithRegistersRequestSortDirectionEnum = typeof RostersListWithRegistersRequestSortDirectionEnum[keyof typeof RostersListWithRegistersRequestSortDirectionEnum];
+
+/**
+ * @export
+ */
+export const RostersListWithRegistersRequestRelatedTypeEnum = {
+    Venue: 'venue',
+    SecurityCompany: 'securityCompany'
+} as const;
+export type RostersListWithRegistersRequestRelatedTypeEnum = typeof RostersListWithRegistersRequestRelatedTypeEnum[keyof typeof RostersListWithRegistersRequestRelatedTypeEnum];
+
+/**
+ * @export
+ */
+export const RostersListWithRegistersRequestStateEnum = {
+    Qld: 'QLD',
+    Nsw: 'NSW',
+    Act: 'ACT',
+    Vic: 'VIC',
+    Tas: 'TAS',
+    Sa: 'SA',
+    Wa: 'WA',
+    Nt: 'NT'
+} as const;
+export type RostersListWithRegistersRequestStateEnum = typeof RostersListWithRegistersRequestStateEnum[keyof typeof RostersListWithRegistersRequestStateEnum];
+
+
+/**
+ * Check if a given object implements the RostersListWithRegistersRequest interface.
+ */
+export function instanceOfRostersListWithRegistersRequest(value: object): value is RostersListWithRegistersRequest {
+    return true;
+}
+
+export function RostersListWithRegistersRequestFromJSON(json: any): RostersListWithRegistersRequest {
+    return RostersListWithRegistersRequestFromJSONTyped(json, false);
+}
+
+export function RostersListWithRegistersRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RostersListWithRegistersRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'search': json['search'] == null ? undefined : json['search'],
+        'sortBy': json['sort_by'] == null ? undefined : json['sort_by'],
+        'sortDirection': json['sort_direction'] == null ? undefined : json['sort_direction'],
+        'perPage': json['per_page'] == null ? undefined : json['per_page'],
+        'page': json['page'] == null ? undefined : json['page'],
+        'isComplete': json['is_complete'] == null ? undefined : json['is_complete'],
+        'isCompliant': json['is_compliant'] == null ? undefined : json['is_compliant'],
+        'beforeStartDateTime': json['before_start_date_time'] == null ? undefined : (new Date(json['before_start_date_time'])),
+        'afterStartDateTime': json['after_start_date_time'] == null ? undefined : (new Date(json['after_start_date_time'])),
+        'beforeFinishDateTime': json['before_finish_date_time'] == null ? undefined : (new Date(json['before_finish_date_time'])),
+        'afterFinishDateTime': json['after_finish_date_time'] == null ? undefined : (new Date(json['after_finish_date_time'])),
+        'relatedId': json['related_id'] == null ? undefined : json['related_id'],
+        'relatedType': json['related_type'] == null ? undefined : json['related_type'],
+        'includesRelations': json['includes_relations'] == null ? undefined : json['includes_relations'],
+        'state': json['state'] == null ? undefined : json['state'],
+        'guardId': json['guard_id'] == null ? undefined : json['guard_id'],
+    };
+}
+
+export function RostersListWithRegistersRequestToJSON(json: any): RostersListWithRegistersRequest {
+    return RostersListWithRegistersRequestToJSONTyped(json, false);
+}
+
+export function RostersListWithRegistersRequestToJSONTyped(value?: RostersListWithRegistersRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'search': value['search'],
+        'sort_by': value['sortBy'],
+        'sort_direction': value['sortDirection'],
+        'per_page': value['perPage'],
+        'page': value['page'],
+        'is_complete': value['isComplete'],
+        'is_compliant': value['isCompliant'],
+        'before_start_date_time': value['beforeStartDateTime'] == null ? undefined : ((value['beforeStartDateTime']).toISOString()),
+        'after_start_date_time': value['afterStartDateTime'] == null ? undefined : ((value['afterStartDateTime']).toISOString()),
+        'before_finish_date_time': value['beforeFinishDateTime'] == null ? undefined : ((value['beforeFinishDateTime']).toISOString()),
+        'after_finish_date_time': value['afterFinishDateTime'] == null ? undefined : ((value['afterFinishDateTime']).toISOString()),
+        'related_id': value['relatedId'],
+        'related_type': value['relatedType'],
+        'includes_relations': value['includesRelations'],
+        'state': value['state'],
+        'guard_id': value['guardId'],
+    };
+}
+

package/src/models/SecurityCompaniesListRequest.ts

@@ -45,10 +45,10 @@ export interface SecurityCompaniesListRequest {
     perPage?: number;
     /**
      * 
-     * @type {number}
+     * @type {string}
      * @memberof SecurityCompaniesListRequest
      */
-    page?: number;
+    page?: string;
     /**
      * 
      * @type {Array<string>}

package/src/models/SecurityCompanyResource.ts

@@ -44,7 +44,7 @@ export interface SecurityCompanyResource {
      * @type {string}
      * @memberof SecurityCompanyResource
      */
-    email?: string | null;
+    email: string;
     /**
      * 
      * @type {boolean}
@@ -82,6 +82,7 @@ export interface SecurityCompanyResource {
  */
 export function instanceOfSecurityCompanyResource(value: object): value is SecurityCompanyResource {
     if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('email' in value) || value['email'] === undefined) return false;
     if (!('isEnabled' in value) || value['isEnabled'] === undefined) return false;
     if (!('address' in value) || value['address'] === undefined) return false;
     if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
@@ -100,7 +101,7 @@ export function SecurityCompanyResourceFromJSONTyped(json: any, ignoreDiscrimina
         
         'id': json['id'] == null ? undefined : json['id'],
         'name': json['name'],
-        'email': json['email'] == null ? undefined : json['email'],
+        'email': json['email'],
         'isEnabled': json['isEnabled'],
         'address': AddressResourceFromJSON(json['address']),
         'licenceNumber': json['licenceNumber'],