/*
 * Copyright 2024 Adobe. All rights reserved.
 * This file is licensed to you under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy
 * of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under
 * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */

import type {
  Audit, BaseCollection, BaseModel, Opportunity, QueryOptions, Site,
} from '../index';

export interface LatestAudit extends BaseModel {
  getAudit(): Promise<Audit>
  getAuditedAt(): string;
  getAuditId(): object;
  getAuditResult(): object | [];
  getAuditType(): string;
  getFullAuditRef(): string;
  getInvocationId(): string;
  getIsError(): boolean;
  getIsLive(): boolean;
  getOpportunities(): Promise<Opportunity[]>;
  getOpportunitiesByUpdatedAt(): Promise<Opportunity[]>;
  getSite(): Promise<Site>;
  getSiteId(): string;
}

export interface LatestAuditCollection extends BaseCollection<LatestAudit> {
  allByAuditId(auditId: string): Promise<LatestAudit[]>;
  allByAuditIdAndAuditType(auditId: string, auditType: string): Promise<LatestAudit[]>;
  allByAuditType(auditType: string, options?: QueryOptions): Promise<LatestAudit[]>;
  allBySiteId(siteId: string): Promise<LatestAudit[]>;
  allBySiteIdAndAuditType(siteId: string, auditType: string): Promise<LatestAudit[]>;
  findByAuditId(auditId: string): Promise<LatestAudit | null>;
  findByAuditIdAndAuditType(auditId: string, auditType: string): Promise<LatestAudit | null>;
  findByAuditType(auditType: string): Promise<LatestAudit | null>;
  findBySiteId(siteId: string): Promise<LatestAudit | null>;
  findBySiteIdAndAuditType(siteId: string, auditType: string): Promise<LatestAudit | null>;
}