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

package/dist/models/RostersListWithRegistersRequest.d.ts

@@ -0,0 +1,162 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare const RostersListWithRegistersRequestSortByEnum: {
+    readonly VenueName: "venue-name";
+    readonly SecurityCompanyName: "securityCompany-name";
+    readonly StartDateTime: "start_date_time";
+    readonly FinishDateTime: "finish_date_time";
+};
+export type RostersListWithRegistersRequestSortByEnum = typeof RostersListWithRegistersRequestSortByEnum[keyof typeof RostersListWithRegistersRequestSortByEnum];
+/**
+ * @export
+ */
+export declare const RostersListWithRegistersRequestSortDirectionEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type RostersListWithRegistersRequestSortDirectionEnum = typeof RostersListWithRegistersRequestSortDirectionEnum[keyof typeof RostersListWithRegistersRequestSortDirectionEnum];
+/**
+ * @export
+ */
+export declare const RostersListWithRegistersRequestRelatedTypeEnum: {
+    readonly Venue: "venue";
+    readonly SecurityCompany: "securityCompany";
+};
+export type RostersListWithRegistersRequestRelatedTypeEnum = typeof RostersListWithRegistersRequestRelatedTypeEnum[keyof typeof RostersListWithRegistersRequestRelatedTypeEnum];
+/**
+ * @export
+ */
+export declare const RostersListWithRegistersRequestStateEnum: {
+    readonly Qld: "QLD";
+    readonly Nsw: "NSW";
+    readonly Act: "ACT";
+    readonly Vic: "VIC";
+    readonly Tas: "TAS";
+    readonly Sa: "SA";
+    readonly Wa: "WA";
+    readonly Nt: "NT";
+};
+export type RostersListWithRegistersRequestStateEnum = typeof RostersListWithRegistersRequestStateEnum[keyof typeof RostersListWithRegistersRequestStateEnum];
+/**
+ * Check if a given object implements the RostersListWithRegistersRequest interface.
+ */
+export declare function instanceOfRostersListWithRegistersRequest(value: object): value is RostersListWithRegistersRequest;
+export declare function RostersListWithRegistersRequestFromJSON(json: any): RostersListWithRegistersRequest;
+export declare function RostersListWithRegistersRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RostersListWithRegistersRequest;
+export declare function RostersListWithRegistersRequestToJSON(json: any): RostersListWithRegistersRequest;
+export declare function RostersListWithRegistersRequestToJSONTyped(value?: RostersListWithRegistersRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/RostersListWithRegistersRequest.js

@@ -0,0 +1,116 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RostersListWithRegistersRequestStateEnum = exports.RostersListWithRegistersRequestRelatedTypeEnum = exports.RostersListWithRegistersRequestSortDirectionEnum = exports.RostersListWithRegistersRequestSortByEnum = void 0;
+exports.instanceOfRostersListWithRegistersRequest = instanceOfRostersListWithRegistersRequest;
+exports.RostersListWithRegistersRequestFromJSON = RostersListWithRegistersRequestFromJSON;
+exports.RostersListWithRegistersRequestFromJSONTyped = RostersListWithRegistersRequestFromJSONTyped;
+exports.RostersListWithRegistersRequestToJSON = RostersListWithRegistersRequestToJSON;
+exports.RostersListWithRegistersRequestToJSONTyped = RostersListWithRegistersRequestToJSONTyped;
+/**
+ * @export
+ */
+exports.RostersListWithRegistersRequestSortByEnum = {
+    VenueName: 'venue-name',
+    SecurityCompanyName: 'securityCompany-name',
+    StartDateTime: 'start_date_time',
+    FinishDateTime: 'finish_date_time'
+};
+/**
+ * @export
+ */
+exports.RostersListWithRegistersRequestSortDirectionEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+};
+/**
+ * @export
+ */
+exports.RostersListWithRegistersRequestRelatedTypeEnum = {
+    Venue: 'venue',
+    SecurityCompany: 'securityCompany'
+};
+/**
+ * @export
+ */
+exports.RostersListWithRegistersRequestStateEnum = {
+    Qld: 'QLD',
+    Nsw: 'NSW',
+    Act: 'ACT',
+    Vic: 'VIC',
+    Tas: 'TAS',
+    Sa: 'SA',
+    Wa: 'WA',
+    Nt: 'NT'
+};
+/**
+ * Check if a given object implements the RostersListWithRegistersRequest interface.
+ */
+function instanceOfRostersListWithRegistersRequest(value) {
+    return true;
+}
+function RostersListWithRegistersRequestFromJSON(json) {
+    return RostersListWithRegistersRequestFromJSONTyped(json, false);
+}
+function RostersListWithRegistersRequestFromJSONTyped(json, ignoreDiscriminator) {
+    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'],
+    };
+}
+function RostersListWithRegistersRequestToJSON(json) {
+    return RostersListWithRegistersRequestToJSONTyped(json, false);
+}
+function RostersListWithRegistersRequestToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    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/dist/models/SecurityCompaniesListRequest.d.ts

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

package/dist/models/VenuesListRequest.d.ts

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

package/dist/models/index.d.ts

@@ -29,6 +29,7 @@ export * from './PaginatedRegisterListResourceResponse';
 export * from './PaginatedRegisterResourceResponse';
 export * from './PaginatedRosterListResourceResponse';
 export * from './PaginatedRosterResourceResponse';
+export * from './PaginatedRosterWithRegistersResourceResponse';
 export * from './PaginatedSecurityCompanyResourceResponse';
 export * from './PaginatedUserResourceResponse';
 export * from './PaginatedVenueResourceResponse';
@@ -50,8 +51,12 @@ export * from './RosterLiteResource';
 export * from './RosterLiteResourceArrayResponse';
 export * from './RosterResource';
 export * from './RosterResourceArrayResponse';
+export * from './RosterWithRegistersResource';
+export * from './RosterWithRegistersResourceArrayResponse';
+export * from './RostersExportPdfRequest';
 export * from './RostersListAllRequest';
 export * from './RostersListRequest';
+export * from './RostersListWithRegistersRequest';
 export * from './SecurityCompaniesAttachUsersRequest';
 export * from './SecurityCompaniesListAllRequest';
 export * from './SecurityCompaniesListRequest';

package/dist/models/index.js

@@ -47,6 +47,7 @@ __exportStar(require("./PaginatedRegisterListResourceResponse"), exports);
 __exportStar(require("./PaginatedRegisterResourceResponse"), exports);
 __exportStar(require("./PaginatedRosterListResourceResponse"), exports);
 __exportStar(require("./PaginatedRosterResourceResponse"), exports);
+__exportStar(require("./PaginatedRosterWithRegistersResourceResponse"), exports);
 __exportStar(require("./PaginatedSecurityCompanyResourceResponse"), exports);
 __exportStar(require("./PaginatedUserResourceResponse"), exports);
 __exportStar(require("./PaginatedVenueResourceResponse"), exports);
@@ -68,8 +69,12 @@ __exportStar(require("./RosterLiteResource"), exports);
 __exportStar(require("./RosterLiteResourceArrayResponse"), exports);
 __exportStar(require("./RosterResource"), exports);
 __exportStar(require("./RosterResourceArrayResponse"), exports);
+__exportStar(require("./RosterWithRegistersResource"), exports);
+__exportStar(require("./RosterWithRegistersResourceArrayResponse"), exports);
+__exportStar(require("./RostersExportPdfRequest"), exports);
 __exportStar(require("./RostersListAllRequest"), exports);
 __exportStar(require("./RostersListRequest"), exports);
+__exportStar(require("./RostersListWithRegistersRequest"), exports);
 __exportStar(require("./SecurityCompaniesAttachUsersRequest"), exports);
 __exportStar(require("./SecurityCompaniesListAllRequest"), exports);
 __exportStar(require("./SecurityCompaniesListRequest"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digital8/security-registers-backend-ts-sdk",
-  "version": "0.0.144",
+  "version": "0.0.145",
   "description": "OpenAPI client for @digital8/security-registers-backend-ts-sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/GeneralApi.ts

@@ -30,6 +30,7 @@ import type {
   PaginatedLicenceListResourceResponse,
   PaginatedRegisterListResourceResponse,
   PaginatedRosterListResourceResponse,
+  PaginatedRosterWithRegistersResourceResponse,
   PaginatedSecurityCompanyResourceResponse,
   PaginatedUserResourceResponse,
   PaginatedVenueResourceResponse,
@@ -42,8 +43,10 @@ import type {
   ResetPasswordAuthRequest,
   RosterLiteResourceArrayResponse,
   RosterResource,
+  RostersExportPdfRequest,
   RostersListAllRequest,
   RostersListRequest,
+  RostersListWithRegistersRequest,
   SecurityCompaniesAttachUsersRequest,
   SecurityCompaniesListAllRequest,
   SecurityCompaniesListRequest,
@@ -103,6 +106,8 @@ import {
     PaginatedRegisterListResourceResponseToJSON,
     PaginatedRosterListResourceResponseFromJSON,
     PaginatedRosterListResourceResponseToJSON,
+    PaginatedRosterWithRegistersResourceResponseFromJSON,
+    PaginatedRosterWithRegistersResourceResponseToJSON,
     PaginatedSecurityCompanyResourceResponseFromJSON,
     PaginatedSecurityCompanyResourceResponseToJSON,
     PaginatedUserResourceResponseFromJSON,
@@ -127,10 +132,14 @@ import {
     RosterLiteResourceArrayResponseToJSON,
     RosterResourceFromJSON,
     RosterResourceToJSON,
+    RostersExportPdfRequestFromJSON,
+    RostersExportPdfRequestToJSON,
     RostersListAllRequestFromJSON,
     RostersListAllRequestToJSON,
     RostersListRequestFromJSON,
     RostersListRequestToJSON,
+    RostersListWithRegistersRequestFromJSON,
+    RostersListWithRegistersRequestToJSON,
     SecurityCompaniesAttachUsersRequestFromJSON,
     SecurityCompaniesAttachUsersRequestToJSON,
     SecurityCompaniesListAllRequestFromJSON,
@@ -256,6 +265,10 @@ export interface ResetPasswordAuthOperationRequest {
     resetPasswordAuthRequest?: ResetPasswordAuthRequest;
 }
 
+export interface RostersExportPdfOperationRequest {
+    rostersExportPdfRequest?: RostersExportPdfRequest;
+}
+
 export interface RostersListOperationRequest {
     rostersListRequest?: RostersListRequest;
 }
@@ -264,6 +277,10 @@ export interface RostersListAllOperationRequest {
     rostersListAllRequest?: RostersListAllRequest;
 }
 
+export interface RostersListWithRegistersOperationRequest {
+    rostersListWithRegistersRequest?: RostersListWithRegistersRequest;
+}
+
 export interface RostersShowRequest {
     roster: number;
 }
@@ -1182,6 +1199,46 @@ export class GeneralApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Auto-generated: rosters.exportPdf
+     */
+    async rostersExportPdfRaw(requestParameters: RostersExportPdfOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
+        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/rosters/export-pdf`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: RostersExportPdfRequestToJSON(requestParameters['rostersExportPdfRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: rosters.exportPdf
+     */
+    async rostersExportPdf(requestParameters: RostersExportPdfOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
+        const response = await this.rostersExportPdfRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Auto-generated: rosters.list
      */
@@ -1262,6 +1319,46 @@ export class GeneralApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Auto-generated: rosters.list.withRegisters
+     */
+    async rostersListWithRegistersRaw(requestParameters: RostersListWithRegistersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedRosterWithRegistersResourceResponse>> {
+        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/rosters/list/with-registers`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: RostersListWithRegistersRequestToJSON(requestParameters['rostersListWithRegistersRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedRosterWithRegistersResourceResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: rosters.list.withRegisters
+     */
+    async rostersListWithRegisters(requestParameters: RostersListWithRegistersOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedRosterWithRegistersResourceResponse> {
+        const response = await this.rostersListWithRegistersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Auto-generated: rosters.show
      */

package/src/models/AddressResource.ts

@@ -36,7 +36,7 @@ export interface AddressResource {
      * @type {string}
      * @memberof AddressResource
      */
-    addressLine2: string;
+    addressLine2?: string | null;
     /**
      * 
      * @type {string}
@@ -80,7 +80,6 @@ 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;
@@ -102,7 +101,7 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
         
         'id': json['id'] == null ? undefined : json['id'],
         'addressLine1': json['addressLine1'],
-        'addressLine2': json['addressLine2'],
+        'addressLine2': json['addressLine2'] == null ? undefined : json['addressLine2'],
         'suburb': json['suburb'],
         'city': json['city'],
         'state': json['state'],

package/src/models/AssetResource.ts

@@ -48,7 +48,7 @@ export interface AssetResource {
      * @type {string}
      * @memberof AssetResource
      */
-    altText?: string | null;
+    altText: string;
     /**
      * 
      * @type {number}
@@ -71,6 +71,7 @@ export function instanceOfAssetResource(value: object): value is AssetResource {
     if (!('filePath' in value) || value['filePath'] === undefined) return false;
     if (!('fileName' in value) || value['fileName'] === undefined) return false;
     if (!('mimeType' in value) || value['mimeType'] === undefined) return false;
+    if (!('altText' in value) || value['altText'] === undefined) return false;
     if (!('index' in value) || value['index'] === undefined) return false;
     if (!('fileId' in value) || value['fileId'] === undefined) return false;
     return true;
@@ -90,7 +91,7 @@ export function AssetResourceFromJSONTyped(json: any, ignoreDiscriminator: boole
         'filePath': json['filePath'],
         'fileName': json['fileName'],
         'mimeType': json['mimeType'],
-        'altText': json['altText'] == null ? undefined : json['altText'],
+        'altText': json['altText'],
         'index': json['index'],
         'fileId': json['fileId'],
     };

package/src/models/IndexUserRequest.ts

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

package/src/models/LicencesListRequest.ts

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