@digital8/security-registers-backend-ts-sdk 0.0.361 → 0.0.363

package/src/models/CurrentRegisterResource.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { VenueLiteResource } from './VenueLiteResource';
+import {
+    VenueLiteResourceFromJSON,
+    VenueLiteResourceFromJSONTyped,
+    VenueLiteResourceToJSON,
+    VenueLiteResourceToJSONTyped,
+} from './VenueLiteResource';
+
 /**
  * 
  * @export
@@ -21,43 +29,24 @@ import { mapValues } from '../runtime';
 export interface CurrentRegisterResource {
     /**
      * 
-     * @type {number}
-     * @memberof CurrentRegisterResource
-     */
-    id?: number | null;
-    /**
-     * 
-     * @type {number}
-     * @memberof CurrentRegisterResource
-     */
-    venueId?: number | null;
-    /**
-     * 
-     * @type {Date}
-     * @memberof CurrentRegisterResource
-     */
-    startDateTime: Date;
-    /**
-     * 
-     * @type {number}
+     * @type {VenueLiteResource}
      * @memberof CurrentRegisterResource
      */
-    latitude: number;
+    venue: VenueLiteResource | null;
     /**
      * 
-     * @type {number}
+     * @type {object}
      * @memberof CurrentRegisterResource
      */
-    longitude: number;
+    signOnDateTime: object;
 }
 
 /**
  * Check if a given object implements the CurrentRegisterResource interface.
  */
 export function instanceOfCurrentRegisterResource(value: object): value is CurrentRegisterResource {
-    if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
-    if (!('latitude' in value) || value['latitude'] === undefined) return false;
-    if (!('longitude' in value) || value['longitude'] === undefined) return false;
+    if (!('venue' in value) || value['venue'] === undefined) return false;
+    if (!('signOnDateTime' in value) || value['signOnDateTime'] === undefined) return false;
     return true;
 }
 
@@ -71,11 +60,8 @@ export function CurrentRegisterResourceFromJSONTyped(json: any, ignoreDiscrimina
     }
     return {
         
-        'id': json['id'] == null ? undefined : json['id'],
-        'venueId': json['venueId'] == null ? undefined : json['venueId'],
-        'startDateTime': (new Date(json['startDateTime'])),
-        'latitude': json['latitude'],
-        'longitude': json['longitude'],
+        'venue': VenueLiteResourceFromJSON(json['venue']),
+        'signOnDateTime': json['signOnDateTime'],
     };
 }
 
@@ -90,11 +76,8 @@ export function CurrentRegisterResourceToJSONTyped(value?: CurrentRegisterResour
 
     return {
         
-        'id': value['id'],
-        'venueId': value['venueId'],
-        'startDateTime': ((value['startDateTime']).toISOString()),
-        'latitude': value['latitude'],
-        'longitude': value['longitude'],
+        'venue': VenueLiteResourceToJSON(value['venue']),
+        'signOnDateTime': value['signOnDateTime'],
     };
 }
 

package/src/models/IncidentFieldAuditResource.ts

@@ -25,12 +25,6 @@ export interface IncidentFieldAuditResource {
      * @memberof IncidentFieldAuditResource
      */
     id: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof IncidentFieldAuditResource
-     */
-    incidentFieldId?: number | null;
     /**
      * 
      * @type {string}
@@ -80,7 +74,6 @@ export function IncidentFieldAuditResourceFromJSONTyped(json: any, ignoreDiscrim
     return {
         
         'id': json['id'],
-        'incidentFieldId': json['incidentFieldId'] == null ? undefined : json['incidentFieldId'],
         'sectionKey': json['sectionKey'],
         'fieldKey': json['fieldKey'],
         'previousValue': json['previousValue'],
@@ -100,7 +93,6 @@ export function IncidentFieldAuditResourceToJSONTyped(value?: IncidentFieldAudit
     return {
         
         'id': value['id'],
-        'incidentFieldId': value['incidentFieldId'],
         'sectionKey': value['sectionKey'],
         'fieldKey': value['fieldKey'],
         'previousValue': value['previousValue'],

package/src/models/IncidentFieldSchemaResource.ts

@@ -27,16 +27,16 @@ export interface IncidentFieldSchemaResource {
     id?: number | null;
     /**
      * 
-     * @type {string}
+     * @type {object}
      * @memberof IncidentFieldSchemaResource
      */
-    state: IncidentFieldSchemaResourceStateEnum;
+    state: object;
     /**
      * 
-     * @type {object}
+     * @type {{ [key: string]: boolean; }}
      * @memberof IncidentFieldSchemaResource
      */
-    jsonSchema: object;
+    jsonSchema: { [key: string]: boolean; };
     /**
      * 
      * @type {Date}
@@ -51,18 +51,6 @@ export interface IncidentFieldSchemaResource {
     updatedAt?: Date | null;
 }
 
-
-/**
- * @export
- */
-export const IncidentFieldSchemaResourceStateEnum = {
-    Qld: 'QLD',
-    Nsw: 'NSW',
-    Vic: 'VIC'
-} as const;
-export type IncidentFieldSchemaResourceStateEnum = typeof IncidentFieldSchemaResourceStateEnum[keyof typeof IncidentFieldSchemaResourceStateEnum];
-
-
 /**
  * Check if a given object implements the IncidentFieldSchemaResource interface.
  */

package/src/models/IncidentFieldSchemasShowRequest.ts

@@ -34,7 +34,12 @@ export interface IncidentFieldSchemasShowRequest {
 export const IncidentFieldSchemasShowRequestStateEnum = {
     Qld: 'QLD',
     Nsw: 'NSW',
-    Vic: 'VIC'
+    Act: 'ACT',
+    Vic: 'VIC',
+    Tas: 'TAS',
+    Sa: 'SA',
+    Wa: 'WA',
+    Nt: 'NT'
 } as const;
 export type IncidentFieldSchemasShowRequestStateEnum = typeof IncidentFieldSchemasShowRequestStateEnum[keyof typeof IncidentFieldSchemasShowRequestStateEnum];
 

package/src/models/IncidentImageResource.ts

@@ -36,7 +36,7 @@ export interface IncidentImageResource {
      * @type {string}
      * @memberof IncidentImageResource
      */
-    altText: string;
+    altText?: string | null;
     /**
      * 
      * @type {number}
@@ -57,7 +57,6 @@ export interface IncidentImageResource {
 export function instanceOfIncidentImageResource(value: object): value is IncidentImageResource {
     if (!('fileId' in value) || value['fileId'] === undefined) return false;
     if (!('mimeType' in value) || value['mimeType'] === undefined) return false;
-    if (!('altText' in value) || value['altText'] === undefined) return false;
     if (!('assetId' in value) || value['assetId'] === undefined) return false;
     if (!('url' in value) || value['url'] === undefined) return false;
     return true;
@@ -75,7 +74,7 @@ export function IncidentImageResourceFromJSONTyped(json: any, ignoreDiscriminato
         
         'fileId': json['file_id'],
         'mimeType': json['mime_type'],
-        'altText': json['alt_text'],
+        'altText': json['alt_text'] == null ? undefined : json['alt_text'],
         'assetId': json['asset_id'],
         'url': json['url'],
     };

package/src/models/IncidentListResource.ts

@@ -101,12 +101,6 @@ export interface IncidentListResource {
      * @memberof IncidentListResource
      */
     submittedByGuard: boolean;
-    /**
-     * 
-     * @type {number}
-     * @memberof IncidentListResource
-     */
-    videosCount?: number;
     /**
      * 
      * @type {Date}
@@ -156,7 +150,6 @@ export function IncidentListResourceFromJSONTyped(json: any, ignoreDiscriminator
         'incidentDateTime': json['incidentDateTime'] == null ? undefined : (new Date(json['incidentDateTime'])),
         'state': json['state'] == null ? undefined : json['state'],
         'submittedByGuard': json['submittedByGuard'],
-        'videosCount': json['videosCount'] == null ? undefined : json['videosCount'],
         'approvedAt': json['approvedAt'] == null ? undefined : (new Date(json['approvedAt'])),
         'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
         'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
@@ -184,7 +177,6 @@ export function IncidentListResourceToJSONTyped(value?: IncidentListResource | n
         'incidentDateTime': value['incidentDateTime'] === null ? null : ((value['incidentDateTime'] as any)?.toISOString()),
         'state': value['state'],
         'submittedByGuard': value['submittedByGuard'],
-        'videosCount': value['videosCount'],
         'approvedAt': value['approvedAt'] === null ? null : ((value['approvedAt'] as any)?.toISOString()),
         'createdAt': value['createdAt'] === null ? null : ((value['createdAt'] as any)?.toISOString()),
         'updatedAt': value['updatedAt'] === null ? null : ((value['updatedAt'] as any)?.toISOString()),

package/src/models/IncidentVersionResource.ts

@@ -47,10 +47,10 @@ export interface IncidentVersionResource {
     user: UserLiteResource | null;
     /**
      * 
-     * @type {object}
+     * @type {Array<boolean>}
      * @memberof IncidentVersionResource
      */
-    fieldData: object;
+    fieldData: Array<boolean>;
     /**
      * 
      * @type {Date}

package/src/models/IncidentVideoResource.ts

@@ -30,7 +30,7 @@ export interface IncidentVideoResource {
      * @type {string}
      * @memberof IncidentVideoResource
      */
-    status: IncidentVideoResourceStatusEnum;
+    status: string;
     /**
      * 
      * @type {string}
@@ -69,18 +69,6 @@ export interface IncidentVideoResource {
     updatedAt?: Date | null;
 }
 
-
-/**
- * @export
- */
-export const IncidentVideoResourceStatusEnum = {
-    Processing: 'processing',
-    Ready: 'ready',
-    Failed: 'failed'
-} as const;
-export type IncidentVideoResourceStatusEnum = typeof IncidentVideoResourceStatusEnum[keyof typeof IncidentVideoResourceStatusEnum];
-
-
 /**
  * Check if a given object implements the IncidentVideoResource interface.
  */

package/src/models/IncidentsUpdateRequest.ts

@@ -20,11 +20,11 @@ import { mapValues } from '../runtime';
  */
 export interface IncidentsUpdateRequest {
     /**
-     * Dynamic fields keyed by section key. Non-repeatable sections are objects of field_key => value; repeatable sections are arrays of such objects. Shape is driven by the venue state's IncidentFieldSchema.
-     * @type {object}
+     * 
+     * @type {Array<string>}
      * @memberof IncidentsUpdateRequest
      */
-    fields: object;
+    fields: Array<string>;
 }
 
 /**

package/src/models/LicenceListResource.ts

@@ -41,10 +41,10 @@ export interface LicenceListResource {
     user: UserRelationResource | null;
     /**
      * 
-     * @type {string}
+     * @type {object}
      * @memberof LicenceListResource
      */
-    state: LicenceListResourceStateEnum;
+    state: object;
     /**
      * 
      * @type {string}
@@ -83,18 +83,6 @@ export interface LicenceListResource {
     createdAt?: Date | null;
 }
 
-
-/**
- * @export
- */
-export const LicenceListResourceStateEnum = {
-    Qld: 'QLD',
-    Nsw: 'NSW',
-    Vic: 'VIC'
-} as const;
-export type LicenceListResourceStateEnum = typeof LicenceListResourceStateEnum[keyof typeof LicenceListResourceStateEnum];
-
-
 /**
  * Check if a given object implements the LicenceListResource interface.
  */

package/src/models/LicenceLiteResource.ts

@@ -33,24 +33,12 @@ export interface LicenceLiteResource {
     licenceNumber: string;
     /**
      * 
-     * @type {string}
+     * @type {object}
      * @memberof LicenceLiteResource
      */
-    state: LicenceLiteResourceStateEnum;
+    state: object;
 }
 
-
-/**
- * @export
- */
-export const LicenceLiteResourceStateEnum = {
-    Qld: 'QLD',
-    Nsw: 'NSW',
-    Vic: 'VIC'
-} as const;
-export type LicenceLiteResourceStateEnum = typeof LicenceLiteResourceStateEnum[keyof typeof LicenceLiteResourceStateEnum];
-
-
 /**
  * Check if a given object implements the LicenceLiteResource interface.
  */

package/src/models/LicenceResource.ts

@@ -41,10 +41,10 @@ export interface LicenceResource {
     user: UserRelationResource | null;
     /**
      * 
-     * @type {string}
+     * @type {object}
      * @memberof LicenceResource
      */
-    state: LicenceResourceStateEnum;
+    state: object;
     /**
      * 
      * @type {string}
@@ -113,18 +113,6 @@ export interface LicenceResource {
     updatedAt?: Date | null;
 }
 
-
-/**
- * @export
- */
-export const LicenceResourceStateEnum = {
-    Qld: 'QLD',
-    Nsw: 'NSW',
-    Vic: 'VIC'
-} as const;
-export type LicenceResourceStateEnum = typeof LicenceResourceStateEnum[keyof typeof LicenceResourceStateEnum];
-
-
 /**
  * Check if a given object implements the LicenceResource interface.
  */

package/src/models/LicencesStoreRequest.ts

@@ -65,11 +65,11 @@ export interface LicencesStoreRequest {
      */
     lastName: string;
     /**
-     * ISO 8601 calendar date (Y-m-d) in the licence state's timezone. Time and timezone offset must be omitted.
-     * @type {string}
+     * 
+     * @type {Date}
      * @memberof LicencesStoreRequest
      */
-    expiryDate: string;
+    expiryDate: Date;
     /**
      * 
      * @type {AuthRegisterGuardRequestProfileSignature}
@@ -103,7 +103,12 @@ export interface LicencesStoreRequest {
 export const LicencesStoreRequestStateEnum = {
     Qld: 'QLD',
     Nsw: 'NSW',
-    Vic: 'VIC'
+    Act: 'ACT',
+    Vic: 'VIC',
+    Tas: 'TAS',
+    Sa: 'SA',
+    Wa: 'WA',
+    Nt: 'NT'
 } as const;
 export type LicencesStoreRequestStateEnum = typeof LicencesStoreRequestStateEnum[keyof typeof LicencesStoreRequestStateEnum];
 
@@ -137,7 +142,7 @@ export function LicencesStoreRequestFromJSONTyped(json: any, ignoreDiscriminator
         'licenceNumber': json['licence_number'],
         'firstName': json['first_name'],
         'lastName': json['last_name'],
-        'expiryDate': json['expiry_date'],
+        'expiryDate': (new Date(json['expiry_date'])),
         'frontAsset': AuthRegisterGuardRequestProfileSignatureFromJSON(json['front_asset']),
         'backAsset': json['back_asset'] == null ? undefined : LicencesStoreRequestBackAssetFromJSON(json['back_asset']),
         'rsaAsset': json['rsa_asset'] == null ? undefined : LicencesStoreRequestBackAssetFromJSON(json['rsa_asset']),
@@ -161,7 +166,7 @@ export function LicencesStoreRequestToJSONTyped(value?: LicencesStoreRequest | n
         'licence_number': value['licenceNumber'],
         'first_name': value['firstName'],
         'last_name': value['lastName'],
-        'expiry_date': value['expiryDate'],
+        'expiry_date': ((value['expiryDate']).toISOString()),
         'front_asset': AuthRegisterGuardRequestProfileSignatureToJSON(value['frontAsset']),
         'back_asset': LicencesStoreRequestBackAssetToJSON(value['backAsset']),
         'rsa_asset': LicencesStoreRequestBackAssetToJSON(value['rsaAsset']),

package/src/models/LicencesUpdateRequest.ts

@@ -52,11 +52,11 @@ export interface LicencesUpdateRequest {
      */
     lastName?: string;
     /**
-     * ISO 8601 calendar date (Y-m-d) in the licence state's timezone. Time and timezone offset must be omitted.
-     * @type {string}
+     * 
+     * @type {Date}
      * @memberof LicencesUpdateRequest
      */
-    expiryDate?: string;
+    expiryDate?: Date;
     /**
      * 
      * @type {LicencesStoreRequestBackAsset}
@@ -90,7 +90,12 @@ export interface LicencesUpdateRequest {
 export const LicencesUpdateRequestStateEnum = {
     Qld: 'QLD',
     Nsw: 'NSW',
-    Vic: 'VIC'
+    Act: 'ACT',
+    Vic: 'VIC',
+    Tas: 'TAS',
+    Sa: 'SA',
+    Wa: 'WA',
+    Nt: 'NT'
 } as const;
 export type LicencesUpdateRequestStateEnum = typeof LicencesUpdateRequestStateEnum[keyof typeof LicencesUpdateRequestStateEnum];
 
@@ -116,7 +121,7 @@ export function LicencesUpdateRequestFromJSONTyped(json: any, ignoreDiscriminato
         'licenceNumber': json['licence_number'] == null ? undefined : json['licence_number'],
         'firstName': json['first_name'] == null ? undefined : json['first_name'],
         'lastName': json['last_name'] == null ? undefined : json['last_name'],
-        'expiryDate': json['expiry_date'] == null ? undefined : json['expiry_date'],
+        'expiryDate': json['expiry_date'] == null ? undefined : (new Date(json['expiry_date'])),
         'frontAsset': json['front_asset'] == null ? undefined : LicencesStoreRequestBackAssetFromJSON(json['front_asset']),
         'backAsset': json['back_asset'] == null ? undefined : LicencesStoreRequestBackAssetFromJSON(json['back_asset']),
         'rsaAsset': json['rsa_asset'] == null ? undefined : LicencesStoreRequestBackAssetFromJSON(json['rsa_asset']),
@@ -139,7 +144,7 @@ export function LicencesUpdateRequestToJSONTyped(value?: LicencesUpdateRequest |
         'licence_number': value['licenceNumber'],
         'first_name': value['firstName'],
         'last_name': value['lastName'],
-        'expiry_date': value['expiryDate'],
+        'expiry_date': value['expiryDate'] == null ? undefined : ((value['expiryDate']).toISOString()),
         'front_asset': LicencesStoreRequestBackAssetToJSON(value['frontAsset']),
         'back_asset': LicencesStoreRequestBackAssetToJSON(value['backAsset']),
         'rsa_asset': LicencesStoreRequestBackAssetToJSON(value['rsaAsset']),

package/src/models/LicencesVerifyRequest.ts

@@ -44,7 +44,7 @@ export interface LicencesVerifyRequest {
      */
     lastName: string;
     /**
-     * ISO 8601 local-with-offset, anchored to 00:00 in the licence state's timezone (e.g. 2026-05-13T00:00:00+11:00). The offset is required so verification against state systems uses the correct wall-clock day.
+     * 
      * @type {string}
      * @memberof LicencesVerifyRequest
      */
@@ -58,7 +58,12 @@ export interface LicencesVerifyRequest {
 export const LicencesVerifyRequestStateEnum = {
     Qld: 'QLD',
     Nsw: 'NSW',
-    Vic: 'VIC'
+    Act: 'ACT',
+    Vic: 'VIC',
+    Tas: 'TAS',
+    Sa: 'SA',
+    Wa: 'WA',
+    Nt: 'NT'
 } as const;
 export type LicencesVerifyRequestStateEnum = typeof LicencesVerifyRequestStateEnum[keyof typeof LicencesVerifyRequestStateEnum];
 

package/src/models/MobileDeviceResource.ts

@@ -36,7 +36,7 @@ export interface MobileDeviceResource {
      * @type {string}
      * @memberof MobileDeviceResource
      */
-    platform: MobileDeviceResourcePlatformEnum;
+    platform: string;
     /**
      * 
      * @type {string}
@@ -87,17 +87,6 @@ export interface MobileDeviceResource {
     updatedAt?: Date | null;
 }
 
-
-/**
- * @export
- */
-export const MobileDeviceResourcePlatformEnum = {
-    Ios: 'ios',
-    Android: 'android'
-} as const;
-export type MobileDeviceResourcePlatformEnum = typeof MobileDeviceResourcePlatformEnum[keyof typeof MobileDeviceResourcePlatformEnum];
-
-
 /**
  * Check if a given object implements the MobileDeviceResource interface.
  */

package/src/models/NotificationPreferenceResource.ts

@@ -38,7 +38,7 @@ export interface NotificationPreferenceResource {
      * @type {string}
      * @memberof NotificationPreferenceResource
      */
-    notificationType: NotificationPreferenceResourceNotificationTypeEnum;
+    notificationType: string;
     /**
      * 
      * @type {VenueLiteResource}
@@ -65,20 +65,6 @@ export interface NotificationPreferenceResource {
     updatedAt?: Date | null;
 }
 
-
-/**
- * @export
- */
-export const NotificationPreferenceResourceNotificationTypeEnum = {
-    IncidentAdded: 'incident_added',
-    NonSignOff: 'non_sign_off',
-    NonSignOn: 'non_sign_on',
-    SignOnRejected: 'sign_on_rejected',
-    LicenceUpdated: 'licence_updated'
-} as const;
-export type NotificationPreferenceResourceNotificationTypeEnum = typeof NotificationPreferenceResourceNotificationTypeEnum[keyof typeof NotificationPreferenceResourceNotificationTypeEnum];
-
-
 /**
  * Check if a given object implements the NotificationPreferenceResource interface.
  */

package/src/models/NotificationPreferencesStoreRequest.ts

@@ -45,6 +45,7 @@ export interface NotificationPreferencesStoreRequest {
  */
 export const NotificationPreferencesStoreRequestNotificationTypeEnum = {
     IncidentAdded: 'incident_added',
+    IncidentPendingReminder: 'incident_pending_reminder',
     NonSignOff: 'non_sign_off',
     NonSignOn: 'non_sign_on',
     SignOnRejected: 'sign_on_rejected',

package/src/models/NotificationTypeResource.ts

@@ -31,12 +31,6 @@ export interface NotificationTypeResource {
      * @memberof NotificationTypeResource
      */
     label: string;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof NotificationTypeResource
-     */
-    supportsPerVenueOverride: boolean;
 }
 
 /**
@@ -45,7 +39,6 @@ export interface NotificationTypeResource {
 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;
-    if (!('supportsPerVenueOverride' in value) || value['supportsPerVenueOverride'] === undefined) return false;
     return true;
 }
 
@@ -61,7 +54,6 @@ export function NotificationTypeResourceFromJSONTyped(json: any, ignoreDiscrimin
         
         'value': json['value'],
         'label': json['label'],
-        'supportsPerVenueOverride': json['supportsPerVenueOverride'],
     };
 }
 
@@ -78,7 +70,6 @@ export function NotificationTypeResourceToJSONTyped(value?: NotificationTypeReso
         
         'value': value['value'],
         'label': value['label'],
-        'supportsPerVenueOverride': value['supportsPerVenueOverride'],
     };
 }
 

package/src/models/PdfExportQueuedResource.ts

@@ -30,7 +30,7 @@ export interface PdfExportQueuedResource {
      * @type {string}
      * @memberof PdfExportQueuedResource
      */
-    status: PdfExportQueuedResourceStatusEnum;
+    status: string;
     /**
      * 
      * @type {string}
@@ -39,19 +39,6 @@ export interface PdfExportQueuedResource {
     message: string;
 }
 
-
-/**
- * @export
- */
-export const PdfExportQueuedResourceStatusEnum = {
-    Pending: 'pending',
-    Processing: 'processing',
-    Completed: 'completed',
-    Failed: 'failed'
-} as const;
-export type PdfExportQueuedResourceStatusEnum = typeof PdfExportQueuedResourceStatusEnum[keyof typeof PdfExportQueuedResourceStatusEnum];
-
-
 /**
  * Check if a given object implements the PdfExportQueuedResource interface.
  */

package/src/models/PdfExportResource.ts

@@ -30,7 +30,7 @@ export interface PdfExportResource {
      * @type {string}
      * @memberof PdfExportResource
      */
-    status: PdfExportResourceStatusEnum;
+    status: string;
     /**
      * 
      * @type {string}
@@ -45,19 +45,6 @@ export interface PdfExportResource {
     downloadUrl: string;
 }
 
-
-/**
- * @export
- */
-export const PdfExportResourceStatusEnum = {
-    Pending: 'pending',
-    Processing: 'processing',
-    Completed: 'completed',
-    Failed: 'failed'
-} as const;
-export type PdfExportResourceStatusEnum = typeof PdfExportResourceStatusEnum[keyof typeof PdfExportResourceStatusEnum];
-
-
 /**
  * Check if a given object implements the PdfExportResource interface.
  */