@reposit/api-client 6.53.0 → 6.54.0

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;
@@ -3309,7 +3330,7 @@ export interface ClaimsApiInterface {
3309
3330
  updateTenantDisputeMessage(claimId: string, updateTenantDisputeMessageDTO: UpdateTenantDisputeMessageDTO, options?: any): AxiosPromise<ClaimDTO>;
3310
3331
  verifyClaim(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
3311
3332
  waiveDisputeFee(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
3312
- zipDocuments(type: 'ADR' | 'INSURER', claimId: string, options?: any): AxiosPromise<object>;
3333
+ zipDocuments(type: "ADR" | "INSURER", claimId: string, options?: any): AxiosPromise<object>;
3313
3334
  }
3314
3335
  export declare class ClaimsApi extends BaseAPI implements ClaimsApiInterface {
3315
3336
  acknowledgeCaseSentToInsurer(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
@@ -3335,7 +3356,7 @@ export declare class ClaimsApi extends BaseAPI implements ClaimsApiInterface {
3335
3356
  updateTenantDisputeMessage(claimId: string, updateTenantDisputeMessageDTO: UpdateTenantDisputeMessageDTO, options?: any): AxiosPromise<ClaimDTO>;
3336
3357
  verifyClaim(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
3337
3358
  waiveDisputeFee(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
3338
- zipDocuments(type: 'ADR' | 'INSURER', claimId: string, options?: any): AxiosPromise<object>;
3359
+ zipDocuments(type: "ADR" | "INSURER", claimId: string, options?: any): AxiosPromise<object>;
3339
3360
  }
3340
3361
  export declare const CommissionApiAxiosParamCreator: (configuration?: Configuration) => {
3341
3362
  generateCommissionCsvForPeriod(period: string, options?: any): RequestArgs;
@@ -4063,7 +4084,7 @@ export interface OrganizationsApiInterface {
4063
4084
  confirmBankAccounts(id: string, options?: any): AxiosPromise<OrganizationDTO>;
4064
4085
  createOrganization(createOrganizationDTO: CreateOrganizationDTO, options?: any): AxiosPromise<OrganizationDTO>;
4065
4086
  disableProductCreation(id: string, options?: any): AxiosPromise<OrganizationDTO>;
4066
- dismissOrganizationMessage(messageId: 'featureBankAccounts' | 'warningBankAccounts', id: string, options?: any): AxiosPromise<OrganizationDTO>;
4087
+ dismissOrganizationMessage(messageId: "featureBankAccounts" | "warningBankAccounts", id: string, options?: any): AxiosPromise<OrganizationDTO>;
4067
4088
  enableProductCreation(id: string, options?: any): AxiosPromise<OrganizationDTO>;
4068
4089
  fetchAddressesByOrganizationId(id: string, options?: any): AxiosPromise<Array<AddressDTO>>;
4069
4090
  fetchLandlordsByOrganizationId(id: string, options?: any): AxiosPromise<Array<LandlordDTO>>;
@@ -4092,7 +4113,7 @@ export declare class OrganizationsApi extends BaseAPI implements OrganizationsAp
4092
4113
  confirmBankAccounts(id: string, options?: any): AxiosPromise<OrganizationDTO>;
4093
4114
  createOrganization(createOrganizationDTO: CreateOrganizationDTO, options?: any): AxiosPromise<OrganizationDTO>;
4094
4115
  disableProductCreation(id: string, options?: any): AxiosPromise<OrganizationDTO>;
4095
- dismissOrganizationMessage(messageId: 'featureBankAccounts' | 'warningBankAccounts', id: string, options?: any): AxiosPromise<OrganizationDTO>;
4116
+ dismissOrganizationMessage(messageId: "featureBankAccounts" | "warningBankAccounts", id: string, options?: any): AxiosPromise<OrganizationDTO>;
4096
4117
  enableProductCreation(id: string, options?: any): AxiosPromise<OrganizationDTO>;
4097
4118
  fetchAddressesByOrganizationId(id: string, options?: any): AxiosPromise<AddressDTO[]>;
4098
4119
  fetchLandlordsByOrganizationId(id: string, options?: any): AxiosPromise<LandlordDTO[]>;
@@ -4425,7 +4446,7 @@ export interface ReferencesApiInterface {
4425
4446
  getChecks(id: string, options?: any): AxiosPromise<Array<CheckDTO>>;
4426
4447
  getReferenceDocuments(id: string, options?: any): AxiosPromise<Array<ReferenceDocumentDTO>>;
4427
4448
  readyForReview(id: string, options?: any): AxiosPromise<ReferenceDTO>;
4428
- 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>;
4429
4450
  submitChecks(id: string, options?: any): AxiosPromise<Array<CheckDTO>>;
4430
4451
  }
4431
4452
  export declare class ReferencesApi extends BaseAPI implements ReferencesApiInterface {
@@ -4434,7 +4455,7 @@ export declare class ReferencesApi extends BaseAPI implements ReferencesApiInter
4434
4455
  getChecks(id: string, options?: any): AxiosPromise<CheckDTO[]>;
4435
4456
  getReferenceDocuments(id: string, options?: any): AxiosPromise<ReferenceDocumentDTO[]>;
4436
4457
  readyForReview(id: string, options?: any): AxiosPromise<ReferenceDTO>;
4437
- 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>;
4438
4459
  submitChecks(id: string, options?: any): AxiosPromise<CheckDTO[]>;
4439
4460
  }
4440
4461
  export declare const RepositOffersApiAxiosParamCreator: (configuration?: Configuration) => {
@@ -4469,8 +4490,8 @@ export interface RepositOffersApiInterface {
4469
4490
  createOffer(offerToTenantRequestDTO: OfferToTenantRequestDTO, options?: any): AxiosPromise<object>;
4470
4491
  deleteOffer(id: string, options?: any): AxiosPromise<object>;
4471
4492
  getRepositOffer(id: string, token: string, options?: any): AxiosPromise<RepositOfferWithRecipientDTO>;
4472
- respondToOffer(id: string, choice: 'REPOSIT' | 'CASH_DEPOSIT', token: string, options?: any): AxiosPromise<object>;
4473
- 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>;
4474
4495
  sendReminder(id: string, options?: any): AxiosPromise<object>;
4475
4496
  }
4476
4497
  export declare class RepositOffersApi extends BaseAPI implements RepositOffersApiInterface {
@@ -4478,8 +4499,8 @@ export declare class RepositOffersApi extends BaseAPI implements RepositOffersAp
4478
4499
  createOffer(offerToTenantRequestDTO: OfferToTenantRequestDTO, options?: any): AxiosPromise<object>;
4479
4500
  deleteOffer(id: string, options?: any): AxiosPromise<object>;
4480
4501
  getRepositOffer(id: string, token: string, options?: any): AxiosPromise<RepositOfferWithRecipientDTO>;
4481
- respondToOffer(id: string, choice: 'REPOSIT' | 'CASH_DEPOSIT', token: string, options?: any): AxiosPromise<object>;
4482
- 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>;
4483
4504
  sendReminder(id: string, options?: any): AxiosPromise<object>;
4484
4505
  }
4485
4506
  export declare const RepositsApiAxiosParamCreator: (configuration?: Configuration) => {
@@ -4706,11 +4727,11 @@ export declare const TenancyInventoriesApiFactory: (configuration?: Configuratio
4706
4727
  };
4707
4728
  export interface TenancyInventoriesApiInterface {
4708
4729
  disableWarnings(id: string, tenancyId: string, options?: any): AxiosPromise<TenancyInventoryDTO>;
4709
- 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>;
4710
4731
  }
4711
4732
  export declare class TenancyInventoriesApi extends BaseAPI implements TenancyInventoriesApiInterface {
4712
4733
  disableWarnings(id: string, tenancyId: string, options?: any): AxiosPromise<TenancyInventoryDTO>;
4713
- 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>;
4714
4735
  }
4715
4736
  export declare const TenancyInvitesApiAxiosParamCreator: (configuration?: Configuration) => {
4716
4737
  acceptTenancyInvite(token: string, clearSession: boolean, tenancyId: string, options?: any): RequestArgs;
@@ -4798,7 +4819,7 @@ export declare const TenancyOrdersApiFactory: (configuration?: Configuration, ba
4798
4819
  };
4799
4820
  export interface TenancyOrdersApiInterface {
4800
4821
  getTenancyOrderById(id: string, includeDeleted?: boolean, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4801
- 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>;
4802
4823
  removeTenancyOrderById(id: string, removeTenancyOrderDTO: RemoveTenancyOrderDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4803
4824
  reopenTenancyOrder(id: string, reopenRepositDTO: ReopenRepositDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4804
4825
  sendOverdueChasers(id: string, options?: any): AxiosPromise<{}>;
@@ -4806,7 +4827,7 @@ export interface TenancyOrdersApiInterface {
4806
4827
  }
4807
4828
  export declare class TenancyOrdersApi extends BaseAPI implements TenancyOrdersApiInterface {
4808
4829
  getTenancyOrderById(id: string, includeDeleted?: boolean, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4809
- 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>;
4810
4831
  removeTenancyOrderById(id: string, removeTenancyOrderDTO: RemoveTenancyOrderDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4811
4832
  reopenTenancyOrder(id: string, reopenRepositDTO: ReopenRepositDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4812
4833
  sendOverdueChasers(id: string, options?: any): AxiosPromise<Response>;
@@ -4946,7 +4967,7 @@ export interface UsersApiInterface {
4946
4967
  completeOnboardingIntroduction(options?: any): AxiosPromise<UserDTO>;
4947
4968
  createOneTimeSessionToken(options?: any): AxiosPromise<OneTimeSessionTokenDTO>;
4948
4969
  dismissNewProductUpdates(options?: any): AxiosPromise<UserDTO>;
4949
- dismissUserMessage(messageId: 'featureClaimUploads' | 'marketingMessageSwitchApril2023' | 'minimumRepositPricingMarch2024' | 'partnerDashboardBetaWelcome' | 'partnerEOTChasersWelcome', options?: any): AxiosPromise<UserDTO>;
4970
+ dismissUserMessage(messageId: "featureClaimUploads" | "marketingMessageSwitchApril2023" | "minimumRepositPricingMarch2024" | "partnerDashboardBetaWelcome" | "partnerEOTChasersWelcome", options?: any): AxiosPromise<UserDTO>;
4950
4971
  findOneByID(id: string, options?: any): AxiosPromise<UserDTO>;
4951
4972
  getCustomer(options?: any): AxiosPromise<CustomerDTO>;
4952
4973
  getOrganizationUsers(id: string, options?: any): AxiosPromise<Array<OrganizationUserDTO>>;
@@ -4966,7 +4987,7 @@ export declare class UsersApi extends BaseAPI implements UsersApiInterface {
4966
4987
  completeOnboardingIntroduction(options?: any): AxiosPromise<UserDTO>;
4967
4988
  createOneTimeSessionToken(options?: any): AxiosPromise<OneTimeSessionTokenDTO>;
4968
4989
  dismissNewProductUpdates(options?: any): AxiosPromise<UserDTO>;
4969
- dismissUserMessage(messageId: 'featureClaimUploads' | 'marketingMessageSwitchApril2023' | 'minimumRepositPricingMarch2024' | 'partnerDashboardBetaWelcome' | 'partnerEOTChasersWelcome', options?: any): AxiosPromise<UserDTO>;
4990
+ dismissUserMessage(messageId: "featureClaimUploads" | "marketingMessageSwitchApril2023" | "minimumRepositPricingMarch2024" | "partnerDashboardBetaWelcome" | "partnerEOTChasersWelcome", options?: any): AxiosPromise<UserDTO>;
4970
4991
  findOneByID(id: string, options?: any): AxiosPromise<UserDTO>;
4971
4992
  getCustomer(options?: any): AxiosPromise<CustomerDTO>;
4972
4993
  getOrganizationUsers(id: string, options?: any): AxiosPromise<OrganizationUserDTO[]>;