@reposit/api-client 6.54.0 → 6.56.0

package/dist/api.d.ts

@@ -1,7 +1,7 @@
 /// <reference path="../src/custom.d.ts" />
-import { Configuration } from "./configuration";
-import { AxiosPromise, AxiosInstance } from "axios";
-import { RequestArgs, BaseAPI } from "./base";
+import { Configuration } from './configuration';
+import { AxiosPromise, AxiosInstance } from 'axios';
+import { RequestArgs, BaseAPI } from './base';
 export interface AddItemsDTO {
     items: Array<CreateInsuredItemDTO>;
 }
@@ -1955,6 +1955,7 @@ export declare enum QueueMessageDTOTypeEnum {
     REPOSITOFFERREMINDER = "REPOSIT_OFFER_REMINDER",
     EVIDENCECHASERREMINDER = "EVIDENCE_CHASER_REMINDER",
     EVIDENCECHASEREXPIREDNOTIFICATION = "EVIDENCE_CHASER_EXPIRED_NOTIFICATION",
+    EVIDENCECHASERSUPPLIERDRAFTREMINDER = "EVIDENCE_CHASER_SUPPLIER_DRAFT_REMINDER",
     ARBITRATIONSENTNOTIFICATION = "ARBITRATION_SENT_NOTIFICATION",
     IVRCALLPROCESSING = "IVR_CALL_PROCESSING",
     PROCESSTWILIOIVRWEBHOOK = "PROCESS_TWILIO_IVR_WEBHOOK",
@@ -1999,6 +2000,7 @@ export declare enum QueueMessageDTOCronNameEnum {
     DAILYREPOSITOFFERREMINDER = "DAILY_REPOSIT_OFFER_REMINDER",
     DAILYEVIDENCECHASERREMINDER = "DAILY_EVIDENCE_CHASER_REMINDER",
     DAILYEVIDENCECHASEREXPIREDNOTIFICATION = "DAILY_EVIDENCE_CHASER_EXPIRED_NOTIFICATION",
+    DAILYEVIDENCECHASERSUPPLIERDRAFTREMINDER = "DAILY_EVIDENCE_CHASER_SUPPLIER_DRAFT_REMINDER",
     DAILYARBITRATIONSENTNOTIFICATION = "DAILY_ARBITRATION_SENT_NOTIFICATION",
     DAILYIVRCALLPROCESSING = "DAILY_IVR_CALL_PROCESSING",
     WEEKLYPENDINGREPOSITPASTSTARTDATEREMINDER = "WEEKLY_PENDING_REPOSIT_PAST_START_DATE_REMINDER"
@@ -2337,9 +2339,33 @@ export interface SearchReferencesResultsDTO {
     count: number;
     results: Array<ReferenceDTO>;
 }
+export interface SearchRepositOfferDTO {
+    id: string;
+    PPM: number;
+    property: PropertyDTO;
+    propertyId: string;
+    organization: OrganizationDTO;
+    organizationId: string;
+    repositOfferRecipients?: Array<RepositOfferRecipientDTO>;
+    cashDepositAmount: number;
+    repositAmount: number;
+    savingAmount: number;
+    tenancyOrder?: TenancyOrderDTO;
+    tenantsReferenceStatus?: SearchRepositOfferDTOTenantsReferenceStatusEnum;
+    tenancyStartDate?: string;
+    tenancyEndDate?: string;
+    tenancyLetOnly?: boolean;
+    createdAt: string;
+    updatedAt: string;
+    canViewReposit: boolean;
+}
+export declare enum SearchRepositOfferDTOTenantsReferenceStatusEnum {
+    PASSED = "PASSED",
+    FAILED = "FAILED"
+}
 export interface SearchRepositOfferResultsDTO {
     count: number;
-    results: Array<RepositOfferDTO>;
+    results: Array<SearchRepositOfferDTO>;
 }
 export interface SearchTenancyOrderResultsDTO {
     count: number;
@@ -2507,6 +2533,7 @@ export interface TenancyOrderWithTenancyAndOrderCustomersDTO {
     updatedAt: string;
     deletedAt: string;
     deactivationReason?: string;
+    tenantFee: number | null;
 }
 export interface TenancyOrderWithTenancyDTO {
     id: string;
@@ -3330,7 +3357,7 @@ export interface ClaimsApiInterface {
     updateTenantDisputeMessage(claimId: string, updateTenantDisputeMessageDTO: UpdateTenantDisputeMessageDTO, options?: any): AxiosPromise<ClaimDTO>;
     verifyClaim(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
     waiveDisputeFee(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
-    zipDocuments(type: "ADR" | "INSURER", claimId: string, options?: any): AxiosPromise<object>;
+    zipDocuments(type: 'ADR' | 'INSURER', claimId: string, options?: any): AxiosPromise<object>;
 }
 export declare class ClaimsApi extends BaseAPI implements ClaimsApiInterface {
     acknowledgeCaseSentToInsurer(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
@@ -3356,7 +3383,7 @@ export declare class ClaimsApi extends BaseAPI implements ClaimsApiInterface {
     updateTenantDisputeMessage(claimId: string, updateTenantDisputeMessageDTO: UpdateTenantDisputeMessageDTO, options?: any): AxiosPromise<ClaimDTO>;
     verifyClaim(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
     waiveDisputeFee(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
-    zipDocuments(type: "ADR" | "INSURER", claimId: string, options?: any): AxiosPromise<object>;
+    zipDocuments(type: 'ADR' | 'INSURER', claimId: string, options?: any): AxiosPromise<object>;
 }
 export declare const CommissionApiAxiosParamCreator: (configuration?: Configuration) => {
     generateCommissionCsvForPeriod(period: string, options?: any): RequestArgs;
@@ -4084,7 +4111,7 @@ export interface OrganizationsApiInterface {
     confirmBankAccounts(id: string, options?: any): AxiosPromise<OrganizationDTO>;
     createOrganization(createOrganizationDTO: CreateOrganizationDTO, options?: any): AxiosPromise<OrganizationDTO>;
     disableProductCreation(id: string, options?: any): AxiosPromise<OrganizationDTO>;
-    dismissOrganizationMessage(messageId: "featureBankAccounts" | "warningBankAccounts", id: string, options?: any): AxiosPromise<OrganizationDTO>;
+    dismissOrganizationMessage(messageId: 'featureBankAccounts' | 'warningBankAccounts', id: string, options?: any): AxiosPromise<OrganizationDTO>;
     enableProductCreation(id: string, options?: any): AxiosPromise<OrganizationDTO>;
     fetchAddressesByOrganizationId(id: string, options?: any): AxiosPromise<Array<AddressDTO>>;
     fetchLandlordsByOrganizationId(id: string, options?: any): AxiosPromise<Array<LandlordDTO>>;
@@ -4113,7 +4140,7 @@ export declare class OrganizationsApi extends BaseAPI implements OrganizationsAp
     confirmBankAccounts(id: string, options?: any): AxiosPromise<OrganizationDTO>;
     createOrganization(createOrganizationDTO: CreateOrganizationDTO, options?: any): AxiosPromise<OrganizationDTO>;
     disableProductCreation(id: string, options?: any): AxiosPromise<OrganizationDTO>;
-    dismissOrganizationMessage(messageId: "featureBankAccounts" | "warningBankAccounts", id: string, options?: any): AxiosPromise<OrganizationDTO>;
+    dismissOrganizationMessage(messageId: 'featureBankAccounts' | 'warningBankAccounts', id: string, options?: any): AxiosPromise<OrganizationDTO>;
     enableProductCreation(id: string, options?: any): AxiosPromise<OrganizationDTO>;
     fetchAddressesByOrganizationId(id: string, options?: any): AxiosPromise<AddressDTO[]>;
     fetchLandlordsByOrganizationId(id: string, options?: any): AxiosPromise<LandlordDTO[]>;
@@ -4446,7 +4473,7 @@ export interface ReferencesApiInterface {
     getChecks(id: string, options?: any): AxiosPromise<Array<CheckDTO>>;
     getReferenceDocuments(id: string, options?: any): AxiosPromise<Array<ReferenceDocumentDTO>>;
     readyForReview(id: string, options?: any): AxiosPromise<ReferenceDTO>;
-    searchReferences(status: string, page: number, size: number, sortBy?: "CREATED_AT", options?: any): AxiosPromise<SearchReferencesResultsDTO>;
+    searchReferences(status: string, page: number, size: number, sortBy?: 'CREATED_AT', options?: any): AxiosPromise<SearchReferencesResultsDTO>;
     submitChecks(id: string, options?: any): AxiosPromise<Array<CheckDTO>>;
 }
 export declare class ReferencesApi extends BaseAPI implements ReferencesApiInterface {
@@ -4455,7 +4482,7 @@ export declare class ReferencesApi extends BaseAPI implements ReferencesApiInter
     getChecks(id: string, options?: any): AxiosPromise<CheckDTO[]>;
     getReferenceDocuments(id: string, options?: any): AxiosPromise<ReferenceDocumentDTO[]>;
     readyForReview(id: string, options?: any): AxiosPromise<ReferenceDTO>;
-    searchReferences(status: string, page: number, size: number, sortBy?: "CREATED_AT", options?: any): AxiosPromise<SearchReferencesResultsDTO>;
+    searchReferences(status: string, page: number, size: number, sortBy?: 'CREATED_AT', options?: any): AxiosPromise<SearchReferencesResultsDTO>;
     submitChecks(id: string, options?: any): AxiosPromise<CheckDTO[]>;
 }
 export declare const RepositOffersApiAxiosParamCreator: (configuration?: Configuration) => {
@@ -4490,8 +4517,8 @@ export interface RepositOffersApiInterface {
     createOffer(offerToTenantRequestDTO: OfferToTenantRequestDTO, options?: any): AxiosPromise<object>;
     deleteOffer(id: string, options?: any): AxiosPromise<object>;
     getRepositOffer(id: string, token: string, options?: any): AxiosPromise<RepositOfferWithRecipientDTO>;
-    respondToOffer(id: string, choice: "REPOSIT" | "CASH_DEPOSIT", token: string, options?: any): AxiosPromise<object>;
-    searchOffers(page: number, size: number, organizationId: string, query?: string, status?: "PENDING" | "REPOSIT_CHOSEN" | "CASH_DEPOSIT_CHOSEN", orderStatus?: "DRAFT" | "PENDING" | "COMPLETE" | "CANCELLED" | "REFUNDED", options?: any): AxiosPromise<SearchRepositOfferResultsDTO>;
+    respondToOffer(id: string, choice: 'REPOSIT' | 'CASH_DEPOSIT', token: string, options?: any): AxiosPromise<object>;
+    searchOffers(page: number, size: number, organizationId: string, query?: string, status?: 'PENDING' | 'REPOSIT_CHOSEN' | 'CASH_DEPOSIT_CHOSEN', orderStatus?: 'DRAFT' | 'PENDING' | 'COMPLETE' | 'CANCELLED' | 'REFUNDED', options?: any): AxiosPromise<SearchRepositOfferResultsDTO>;
     sendReminder(id: string, options?: any): AxiosPromise<object>;
 }
 export declare class RepositOffersApi extends BaseAPI implements RepositOffersApiInterface {
@@ -4499,8 +4526,8 @@ export declare class RepositOffersApi extends BaseAPI implements RepositOffersAp
     createOffer(offerToTenantRequestDTO: OfferToTenantRequestDTO, options?: any): AxiosPromise<object>;
     deleteOffer(id: string, options?: any): AxiosPromise<object>;
     getRepositOffer(id: string, token: string, options?: any): AxiosPromise<RepositOfferWithRecipientDTO>;
-    respondToOffer(id: string, choice: "REPOSIT" | "CASH_DEPOSIT", token: string, options?: any): AxiosPromise<object>;
-    searchOffers(page: number, size: number, organizationId: string, query?: string, status?: "PENDING" | "REPOSIT_CHOSEN" | "CASH_DEPOSIT_CHOSEN", orderStatus?: "DRAFT" | "PENDING" | "COMPLETE" | "CANCELLED" | "REFUNDED", options?: any): AxiosPromise<SearchRepositOfferResultsDTO>;
+    respondToOffer(id: string, choice: 'REPOSIT' | 'CASH_DEPOSIT', token: string, options?: any): AxiosPromise<object>;
+    searchOffers(page: number, size: number, organizationId: string, query?: string, status?: 'PENDING' | 'REPOSIT_CHOSEN' | 'CASH_DEPOSIT_CHOSEN', orderStatus?: 'DRAFT' | 'PENDING' | 'COMPLETE' | 'CANCELLED' | 'REFUNDED', options?: any): AxiosPromise<SearchRepositOfferResultsDTO>;
     sendReminder(id: string, options?: any): AxiosPromise<object>;
 }
 export declare const RepositsApiAxiosParamCreator: (configuration?: Configuration) => {
@@ -4727,11 +4754,11 @@ export declare const TenancyInventoriesApiFactory: (configuration?: Configuratio
 };
 export interface TenancyInventoriesApiInterface {
     disableWarnings(id: string, tenancyId: string, options?: any): AxiosPromise<TenancyInventoryDTO>;
-    tenantConfirmation(token: string, response: "CONFIRMED" | "UNCONFIRMED", tenancyId: string, options?: any): AxiosPromise<object>;
+    tenantConfirmation(token: string, response: 'CONFIRMED' | 'UNCONFIRMED', tenancyId: string, options?: any): AxiosPromise<object>;
 }
 export declare class TenancyInventoriesApi extends BaseAPI implements TenancyInventoriesApiInterface {
     disableWarnings(id: string, tenancyId: string, options?: any): AxiosPromise<TenancyInventoryDTO>;
-    tenantConfirmation(token: string, response: "CONFIRMED" | "UNCONFIRMED", tenancyId: string, options?: any): AxiosPromise<object>;
+    tenantConfirmation(token: string, response: 'CONFIRMED' | 'UNCONFIRMED', tenancyId: string, options?: any): AxiosPromise<object>;
 }
 export declare const TenancyInvitesApiAxiosParamCreator: (configuration?: Configuration) => {
     acceptTenancyInvite(token: string, clearSession: boolean, tenancyId: string, options?: any): RequestArgs;
@@ -4819,7 +4846,7 @@ export declare const TenancyOrdersApiFactory: (configuration?: Configuration, ba
 };
 export interface TenancyOrdersApiInterface {
     getTenancyOrderById(id: string, includeDeleted?: boolean, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
-    optimisedSearch(organizationId: string, page: number, size: number, includeDeleted: boolean, onlyDeleted: boolean, query?: string, orderStatus?: "DRAFT" | "PENDING" | "COMPLETE" | "CANCELLED" | "REFUNDED", tenancyStatus?: "ACTIVE" | "CHECKED_OUT" | "OVERDUE" | "ENDING_SOON" | "CLOSING_SOON", sortBy?: "CREATED_AT" | "START_DATE" | "END_DATE", sortDirection?: "ASC" | "DESC", letOnly?: boolean, options?: any): AxiosPromise<SearchTenancyOrderResultsDTO>;
+    optimisedSearch(organizationId: string, page: number, size: number, includeDeleted: boolean, onlyDeleted: boolean, query?: string, orderStatus?: 'DRAFT' | 'PENDING' | 'COMPLETE' | 'CANCELLED' | 'REFUNDED', tenancyStatus?: 'ACTIVE' | 'CHECKED_OUT' | 'OVERDUE' | 'ENDING_SOON' | 'CLOSING_SOON', sortBy?: 'CREATED_AT' | 'START_DATE' | 'END_DATE', sortDirection?: 'ASC' | 'DESC', letOnly?: boolean, options?: any): AxiosPromise<SearchTenancyOrderResultsDTO>;
     removeTenancyOrderById(id: string, removeTenancyOrderDTO: RemoveTenancyOrderDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
     reopenTenancyOrder(id: string, reopenRepositDTO: ReopenRepositDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
     sendOverdueChasers(id: string, options?: any): AxiosPromise<{}>;
@@ -4827,7 +4854,7 @@ export interface TenancyOrdersApiInterface {
 }
 export declare class TenancyOrdersApi extends BaseAPI implements TenancyOrdersApiInterface {
     getTenancyOrderById(id: string, includeDeleted?: boolean, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
-    optimisedSearch(organizationId: string, page: number, size: number, includeDeleted: boolean, onlyDeleted: boolean, query?: string, orderStatus?: "DRAFT" | "PENDING" | "COMPLETE" | "CANCELLED" | "REFUNDED", tenancyStatus?: "ACTIVE" | "CHECKED_OUT" | "OVERDUE" | "ENDING_SOON" | "CLOSING_SOON", sortBy?: "CREATED_AT" | "START_DATE" | "END_DATE", sortDirection?: "ASC" | "DESC", letOnly?: boolean, options?: any): AxiosPromise<SearchTenancyOrderResultsDTO>;
+    optimisedSearch(organizationId: string, page: number, size: number, includeDeleted: boolean, onlyDeleted: boolean, query?: string, orderStatus?: 'DRAFT' | 'PENDING' | 'COMPLETE' | 'CANCELLED' | 'REFUNDED', tenancyStatus?: 'ACTIVE' | 'CHECKED_OUT' | 'OVERDUE' | 'ENDING_SOON' | 'CLOSING_SOON', sortBy?: 'CREATED_AT' | 'START_DATE' | 'END_DATE', sortDirection?: 'ASC' | 'DESC', letOnly?: boolean, options?: any): AxiosPromise<SearchTenancyOrderResultsDTO>;
     removeTenancyOrderById(id: string, removeTenancyOrderDTO: RemoveTenancyOrderDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
     reopenTenancyOrder(id: string, reopenRepositDTO: ReopenRepositDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
     sendOverdueChasers(id: string, options?: any): AxiosPromise<Response>;
@@ -4967,7 +4994,7 @@ export interface UsersApiInterface {
     completeOnboardingIntroduction(options?: any): AxiosPromise<UserDTO>;
     createOneTimeSessionToken(options?: any): AxiosPromise<OneTimeSessionTokenDTO>;
     dismissNewProductUpdates(options?: any): AxiosPromise<UserDTO>;
-    dismissUserMessage(messageId: "featureClaimUploads" | "marketingMessageSwitchApril2023" | "minimumRepositPricingMarch2024" | "partnerDashboardBetaWelcome" | "partnerEOTChasersWelcome", options?: any): AxiosPromise<UserDTO>;
+    dismissUserMessage(messageId: 'featureClaimUploads' | 'marketingMessageSwitchApril2023' | 'minimumRepositPricingMarch2024' | 'partnerDashboardBetaWelcome' | 'partnerEOTChasersWelcome', options?: any): AxiosPromise<UserDTO>;
     findOneByID(id: string, options?: any): AxiosPromise<UserDTO>;
     getCustomer(options?: any): AxiosPromise<CustomerDTO>;
     getOrganizationUsers(id: string, options?: any): AxiosPromise<Array<OrganizationUserDTO>>;
@@ -4987,7 +5014,7 @@ export declare class UsersApi extends BaseAPI implements UsersApiInterface {
     completeOnboardingIntroduction(options?: any): AxiosPromise<UserDTO>;
     createOneTimeSessionToken(options?: any): AxiosPromise<OneTimeSessionTokenDTO>;
     dismissNewProductUpdates(options?: any): AxiosPromise<UserDTO>;
-    dismissUserMessage(messageId: "featureClaimUploads" | "marketingMessageSwitchApril2023" | "minimumRepositPricingMarch2024" | "partnerDashboardBetaWelcome" | "partnerEOTChasersWelcome", options?: any): AxiosPromise<UserDTO>;
+    dismissUserMessage(messageId: 'featureClaimUploads' | 'marketingMessageSwitchApril2023' | 'minimumRepositPricingMarch2024' | 'partnerDashboardBetaWelcome' | 'partnerEOTChasersWelcome', options?: any): AxiosPromise<UserDTO>;
     findOneByID(id: string, options?: any): AxiosPromise<UserDTO>;
     getCustomer(options?: any): AxiosPromise<CustomerDTO>;
     getOrganizationUsers(id: string, options?: any): AxiosPromise<OrganizationUserDTO[]>;