@reposit/api-client 6.52.0 → 6.54.0-beta.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/api.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  /// <reference path="../src/custom.d.ts" />
2
- import { Configuration } from './configuration';
3
- import { AxiosPromise, AxiosInstance } from 'axios';
4
- import { RequestArgs, BaseAPI } from './base';
2
+ import { Configuration } from "./configuration";
3
+ import { AxiosPromise, AxiosInstance } from "axios";
4
+ import { RequestArgs, BaseAPI } from "./base";
5
5
  export interface AddItemsDTO {
6
6
  items: Array<CreateInsuredItemDTO>;
7
7
  }
@@ -1100,9 +1100,16 @@ export interface EvidenceChaserItemRequestDTO {
1100
1100
  userId: string;
1101
1101
  message: string;
1102
1102
  response?: EvidenceChaserItemResponseDTO;
1103
+ publishedAt?: string;
1104
+ publicationStatus?: EvidenceChaserItemRequestDTOPublicationStatusEnum;
1105
+ isDraft: boolean;
1103
1106
  createdAt: string;
1104
1107
  updatedAt: string;
1105
1108
  }
1109
+ export declare enum EvidenceChaserItemRequestDTOPublicationStatusEnum {
1110
+ DRAFT = "DRAFT",
1111
+ PUBLISHED = "PUBLISHED"
1112
+ }
1106
1113
  export interface EvidenceChaserItemResponseDTO {
1107
1114
  id: string;
1108
1115
  evidenceChaserItemRequestId: string;
@@ -1111,9 +1118,16 @@ export interface EvidenceChaserItemResponseDTO {
1111
1118
  message?: string;
1112
1119
  documents: Array<EvidenceChaserItemResponseDocumentDTO>;
1113
1120
  review?: EvidenceChaserItemReviewDTO;
1121
+ publishedAt?: string;
1122
+ publicationStatus?: EvidenceChaserItemResponseDTOPublicationStatusEnum;
1123
+ isDraft: boolean;
1114
1124
  createdAt: string;
1115
1125
  updatedAt: string;
1116
1126
  }
1127
+ export declare enum EvidenceChaserItemResponseDTOPublicationStatusEnum {
1128
+ DRAFT = "DRAFT",
1129
+ PUBLISHED = "PUBLISHED"
1130
+ }
1117
1131
  export interface EvidenceChaserItemResponseDocumentDTO {
1118
1132
  id: string;
1119
1133
  evidenceChaserItemResponseId: string;
@@ -1129,6 +1143,9 @@ export interface EvidenceChaserItemReviewDTO {
1129
1143
  message: string;
1130
1144
  status: EvidenceChaserItemReviewDTOStatusEnum;
1131
1145
  claimItemReviews: Array<EvidenceChaserItemClaimItemReviewDTO>;
1146
+ publishedAt?: string;
1147
+ publicationStatus?: EvidenceChaserItemReviewDTOPublicationStatusEnum;
1148
+ isDraft: boolean;
1132
1149
  createdAt: string;
1133
1150
  updatedAt: string;
1134
1151
  }
@@ -1137,6 +1154,10 @@ export declare enum EvidenceChaserItemReviewDTOStatusEnum {
1137
1154
  REJECTED = "REJECTED",
1138
1155
  MISSING = "MISSING"
1139
1156
  }
1157
+ export declare enum EvidenceChaserItemReviewDTOPublicationStatusEnum {
1158
+ DRAFT = "DRAFT",
1159
+ PUBLISHED = "PUBLISHED"
1160
+ }
1140
1161
  export interface EvidenceChaserRoundDTO {
1141
1162
  id: string;
1142
1163
  evidenceChaserId: string;
@@ -1302,6 +1323,9 @@ export interface OfferToTenantRequestDTO {
1302
1323
  tenants: Array<TenantForOfferDTO>;
1303
1324
  cashDepositAmount?: number;
1304
1325
  tenantsReferenceStatus?: OfferToTenantRequestDTOTenantsReferenceStatusEnum;
1326
+ tenancyStartDate?: string;
1327
+ tenancyEndDate?: string;
1328
+ tenancyLetOnly?: boolean;
1305
1329
  }
1306
1330
  export declare enum OfferToTenantRequestDTOTenantsReferenceStatusEnum {
1307
1331
  PASSED = "PASSED",
@@ -2113,6 +2137,9 @@ export interface RepositOfferDTO {
2113
2137
  savingAmount: number;
2114
2138
  tenancyOrder?: TenancyOrderDTO;
2115
2139
  tenantsReferenceStatus?: RepositOfferDTOTenantsReferenceStatusEnum;
2140
+ tenancyStartDate?: string;
2141
+ tenancyEndDate?: string;
2142
+ tenancyLetOnly?: boolean;
2116
2143
  createdAt: string;
2117
2144
  updatedAt: string;
2118
2145
  }
@@ -3303,7 +3330,7 @@ export interface ClaimsApiInterface {
3303
3330
  updateTenantDisputeMessage(claimId: string, updateTenantDisputeMessageDTO: UpdateTenantDisputeMessageDTO, options?: any): AxiosPromise<ClaimDTO>;
3304
3331
  verifyClaim(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
3305
3332
  waiveDisputeFee(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
3306
- zipDocuments(type: 'ADR' | 'INSURER', claimId: string, options?: any): AxiosPromise<object>;
3333
+ zipDocuments(type: "ADR" | "INSURER", claimId: string, options?: any): AxiosPromise<object>;
3307
3334
  }
3308
3335
  export declare class ClaimsApi extends BaseAPI implements ClaimsApiInterface {
3309
3336
  acknowledgeCaseSentToInsurer(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
@@ -3329,7 +3356,7 @@ export declare class ClaimsApi extends BaseAPI implements ClaimsApiInterface {
3329
3356
  updateTenantDisputeMessage(claimId: string, updateTenantDisputeMessageDTO: UpdateTenantDisputeMessageDTO, options?: any): AxiosPromise<ClaimDTO>;
3330
3357
  verifyClaim(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
3331
3358
  waiveDisputeFee(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
3332
- zipDocuments(type: 'ADR' | 'INSURER', claimId: string, options?: any): AxiosPromise<object>;
3359
+ zipDocuments(type: "ADR" | "INSURER", claimId: string, options?: any): AxiosPromise<object>;
3333
3360
  }
3334
3361
  export declare const CommissionApiAxiosParamCreator: (configuration?: Configuration) => {
3335
3362
  generateCommissionCsvForPeriod(period: string, options?: any): RequestArgs;
@@ -4057,7 +4084,7 @@ export interface OrganizationsApiInterface {
4057
4084
  confirmBankAccounts(id: string, options?: any): AxiosPromise<OrganizationDTO>;
4058
4085
  createOrganization(createOrganizationDTO: CreateOrganizationDTO, options?: any): AxiosPromise<OrganizationDTO>;
4059
4086
  disableProductCreation(id: string, options?: any): AxiosPromise<OrganizationDTO>;
4060
- dismissOrganizationMessage(messageId: 'featureBankAccounts' | 'warningBankAccounts', id: string, options?: any): AxiosPromise<OrganizationDTO>;
4087
+ dismissOrganizationMessage(messageId: "featureBankAccounts" | "warningBankAccounts", id: string, options?: any): AxiosPromise<OrganizationDTO>;
4061
4088
  enableProductCreation(id: string, options?: any): AxiosPromise<OrganizationDTO>;
4062
4089
  fetchAddressesByOrganizationId(id: string, options?: any): AxiosPromise<Array<AddressDTO>>;
4063
4090
  fetchLandlordsByOrganizationId(id: string, options?: any): AxiosPromise<Array<LandlordDTO>>;
@@ -4086,7 +4113,7 @@ export declare class OrganizationsApi extends BaseAPI implements OrganizationsAp
4086
4113
  confirmBankAccounts(id: string, options?: any): AxiosPromise<OrganizationDTO>;
4087
4114
  createOrganization(createOrganizationDTO: CreateOrganizationDTO, options?: any): AxiosPromise<OrganizationDTO>;
4088
4115
  disableProductCreation(id: string, options?: any): AxiosPromise<OrganizationDTO>;
4089
- dismissOrganizationMessage(messageId: 'featureBankAccounts' | 'warningBankAccounts', id: string, options?: any): AxiosPromise<OrganizationDTO>;
4116
+ dismissOrganizationMessage(messageId: "featureBankAccounts" | "warningBankAccounts", id: string, options?: any): AxiosPromise<OrganizationDTO>;
4090
4117
  enableProductCreation(id: string, options?: any): AxiosPromise<OrganizationDTO>;
4091
4118
  fetchAddressesByOrganizationId(id: string, options?: any): AxiosPromise<AddressDTO[]>;
4092
4119
  fetchLandlordsByOrganizationId(id: string, options?: any): AxiosPromise<LandlordDTO[]>;
@@ -4419,7 +4446,7 @@ export interface ReferencesApiInterface {
4419
4446
  getChecks(id: string, options?: any): AxiosPromise<Array<CheckDTO>>;
4420
4447
  getReferenceDocuments(id: string, options?: any): AxiosPromise<Array<ReferenceDocumentDTO>>;
4421
4448
  readyForReview(id: string, options?: any): AxiosPromise<ReferenceDTO>;
4422
- searchReferences(status: string, page: number, size: number, sortBy?: 'CREATED_AT', options?: any): AxiosPromise<SearchReferencesResultsDTO>;
4449
+ searchReferences(status: string, page: number, size: number, sortBy?: "CREATED_AT", options?: any): AxiosPromise<SearchReferencesResultsDTO>;
4423
4450
  submitChecks(id: string, options?: any): AxiosPromise<Array<CheckDTO>>;
4424
4451
  }
4425
4452
  export declare class ReferencesApi extends BaseAPI implements ReferencesApiInterface {
@@ -4428,7 +4455,7 @@ export declare class ReferencesApi extends BaseAPI implements ReferencesApiInter
4428
4455
  getChecks(id: string, options?: any): AxiosPromise<CheckDTO[]>;
4429
4456
  getReferenceDocuments(id: string, options?: any): AxiosPromise<ReferenceDocumentDTO[]>;
4430
4457
  readyForReview(id: string, options?: any): AxiosPromise<ReferenceDTO>;
4431
- searchReferences(status: string, page: number, size: number, sortBy?: 'CREATED_AT', options?: any): AxiosPromise<SearchReferencesResultsDTO>;
4458
+ searchReferences(status: string, page: number, size: number, sortBy?: "CREATED_AT", options?: any): AxiosPromise<SearchReferencesResultsDTO>;
4432
4459
  submitChecks(id: string, options?: any): AxiosPromise<CheckDTO[]>;
4433
4460
  }
4434
4461
  export declare const RepositOffersApiAxiosParamCreator: (configuration?: Configuration) => {
@@ -4463,8 +4490,8 @@ export interface RepositOffersApiInterface {
4463
4490
  createOffer(offerToTenantRequestDTO: OfferToTenantRequestDTO, options?: any): AxiosPromise<object>;
4464
4491
  deleteOffer(id: string, options?: any): AxiosPromise<object>;
4465
4492
  getRepositOffer(id: string, token: string, options?: any): AxiosPromise<RepositOfferWithRecipientDTO>;
4466
- respondToOffer(id: string, choice: 'REPOSIT' | 'CASH_DEPOSIT', token: string, options?: any): AxiosPromise<object>;
4467
- 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>;
4493
+ respondToOffer(id: string, choice: "REPOSIT" | "CASH_DEPOSIT", token: string, options?: any): AxiosPromise<object>;
4494
+ 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>;
4468
4495
  sendReminder(id: string, options?: any): AxiosPromise<object>;
4469
4496
  }
4470
4497
  export declare class RepositOffersApi extends BaseAPI implements RepositOffersApiInterface {
@@ -4472,8 +4499,8 @@ export declare class RepositOffersApi extends BaseAPI implements RepositOffersAp
4472
4499
  createOffer(offerToTenantRequestDTO: OfferToTenantRequestDTO, options?: any): AxiosPromise<object>;
4473
4500
  deleteOffer(id: string, options?: any): AxiosPromise<object>;
4474
4501
  getRepositOffer(id: string, token: string, options?: any): AxiosPromise<RepositOfferWithRecipientDTO>;
4475
- respondToOffer(id: string, choice: 'REPOSIT' | 'CASH_DEPOSIT', token: string, options?: any): AxiosPromise<object>;
4476
- 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>;
4502
+ respondToOffer(id: string, choice: "REPOSIT" | "CASH_DEPOSIT", token: string, options?: any): AxiosPromise<object>;
4503
+ 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>;
4477
4504
  sendReminder(id: string, options?: any): AxiosPromise<object>;
4478
4505
  }
4479
4506
  export declare const RepositsApiAxiosParamCreator: (configuration?: Configuration) => {
@@ -4700,11 +4727,11 @@ export declare const TenancyInventoriesApiFactory: (configuration?: Configuratio
4700
4727
  };
4701
4728
  export interface TenancyInventoriesApiInterface {
4702
4729
  disableWarnings(id: string, tenancyId: string, options?: any): AxiosPromise<TenancyInventoryDTO>;
4703
- tenantConfirmation(token: string, response: 'CONFIRMED' | 'UNCONFIRMED', tenancyId: string, options?: any): AxiosPromise<object>;
4730
+ tenantConfirmation(token: string, response: "CONFIRMED" | "UNCONFIRMED", tenancyId: string, options?: any): AxiosPromise<object>;
4704
4731
  }
4705
4732
  export declare class TenancyInventoriesApi extends BaseAPI implements TenancyInventoriesApiInterface {
4706
4733
  disableWarnings(id: string, tenancyId: string, options?: any): AxiosPromise<TenancyInventoryDTO>;
4707
- tenantConfirmation(token: string, response: 'CONFIRMED' | 'UNCONFIRMED', tenancyId: string, options?: any): AxiosPromise<object>;
4734
+ tenantConfirmation(token: string, response: "CONFIRMED" | "UNCONFIRMED", tenancyId: string, options?: any): AxiosPromise<object>;
4708
4735
  }
4709
4736
  export declare const TenancyInvitesApiAxiosParamCreator: (configuration?: Configuration) => {
4710
4737
  acceptTenancyInvite(token: string, clearSession: boolean, tenancyId: string, options?: any): RequestArgs;
@@ -4792,7 +4819,7 @@ export declare const TenancyOrdersApiFactory: (configuration?: Configuration, ba
4792
4819
  };
4793
4820
  export interface TenancyOrdersApiInterface {
4794
4821
  getTenancyOrderById(id: string, includeDeleted?: boolean, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4795
- 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>;
4822
+ 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>;
4796
4823
  removeTenancyOrderById(id: string, removeTenancyOrderDTO: RemoveTenancyOrderDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4797
4824
  reopenTenancyOrder(id: string, reopenRepositDTO: ReopenRepositDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4798
4825
  sendOverdueChasers(id: string, options?: any): AxiosPromise<{}>;
@@ -4800,7 +4827,7 @@ export interface TenancyOrdersApiInterface {
4800
4827
  }
4801
4828
  export declare class TenancyOrdersApi extends BaseAPI implements TenancyOrdersApiInterface {
4802
4829
  getTenancyOrderById(id: string, includeDeleted?: boolean, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4803
- 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>;
4830
+ 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>;
4804
4831
  removeTenancyOrderById(id: string, removeTenancyOrderDTO: RemoveTenancyOrderDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4805
4832
  reopenTenancyOrder(id: string, reopenRepositDTO: ReopenRepositDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4806
4833
  sendOverdueChasers(id: string, options?: any): AxiosPromise<Response>;
@@ -4940,7 +4967,7 @@ export interface UsersApiInterface {
4940
4967
  completeOnboardingIntroduction(options?: any): AxiosPromise<UserDTO>;
4941
4968
  createOneTimeSessionToken(options?: any): AxiosPromise<OneTimeSessionTokenDTO>;
4942
4969
  dismissNewProductUpdates(options?: any): AxiosPromise<UserDTO>;
4943
- dismissUserMessage(messageId: 'featureClaimUploads' | 'marketingMessageSwitchApril2023' | 'minimumRepositPricingMarch2024' | 'partnerDashboardBetaWelcome' | 'partnerEOTChasersWelcome', options?: any): AxiosPromise<UserDTO>;
4970
+ dismissUserMessage(messageId: "featureClaimUploads" | "marketingMessageSwitchApril2023" | "minimumRepositPricingMarch2024" | "partnerDashboardBetaWelcome" | "partnerEOTChasersWelcome", options?: any): AxiosPromise<UserDTO>;
4944
4971
  findOneByID(id: string, options?: any): AxiosPromise<UserDTO>;
4945
4972
  getCustomer(options?: any): AxiosPromise<CustomerDTO>;
4946
4973
  getOrganizationUsers(id: string, options?: any): AxiosPromise<Array<OrganizationUserDTO>>;
@@ -4960,7 +4987,7 @@ export declare class UsersApi extends BaseAPI implements UsersApiInterface {
4960
4987
  completeOnboardingIntroduction(options?: any): AxiosPromise<UserDTO>;
4961
4988
  createOneTimeSessionToken(options?: any): AxiosPromise<OneTimeSessionTokenDTO>;
4962
4989
  dismissNewProductUpdates(options?: any): AxiosPromise<UserDTO>;
4963
- dismissUserMessage(messageId: 'featureClaimUploads' | 'marketingMessageSwitchApril2023' | 'minimumRepositPricingMarch2024' | 'partnerDashboardBetaWelcome' | 'partnerEOTChasersWelcome', options?: any): AxiosPromise<UserDTO>;
4990
+ dismissUserMessage(messageId: "featureClaimUploads" | "marketingMessageSwitchApril2023" | "minimumRepositPricingMarch2024" | "partnerDashboardBetaWelcome" | "partnerEOTChasersWelcome", options?: any): AxiosPromise<UserDTO>;
4964
4991
  findOneByID(id: string, options?: any): AxiosPromise<UserDTO>;
4965
4992
  getCustomer(options?: any): AxiosPromise<CustomerDTO>;
4966
4993
  getOrganizationUsers(id: string, options?: any): AxiosPromise<OrganizationUserDTO[]>;