@reposit/api-client 6.37.0 → 6.39.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.
Files changed (4) hide show
  1. package/dist/api.d.ts +31 -19
  2. package/dist/api.js +1630 -1382
  3. package/dist/api.js.map +1 -1
  4. package/package.json +1 -1
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
  }
@@ -1343,6 +1343,7 @@ export interface OrderDTO {
1343
1343
  integratorId?: string;
1344
1344
  integrator?: IntegratorDTO;
1345
1345
  manualPayments?: Array<OrderManualPaymentDTO>;
1346
+ refundHandling?: OrderDTORefundHandlingEnum;
1346
1347
  }
1347
1348
  export declare enum OrderDTOProductIdEnum {
1348
1349
  REPOSIT = "REPOSIT",
@@ -1359,6 +1360,10 @@ export declare enum OrderDTOStatusIdEnum {
1359
1360
  CANCELLED = "CANCELLED",
1360
1361
  REFUNDED = "REFUNDED"
1361
1362
  }
1363
+ export declare enum OrderDTORefundHandlingEnum {
1364
+ MANUAL = "MANUAL",
1365
+ AUTOMATIC = "AUTOMATIC"
1366
+ }
1362
1367
  export interface OrderManualPaymentDTO {
1363
1368
  id: string;
1364
1369
  orderId: string;
@@ -1378,6 +1383,7 @@ export interface OrderWithOrderCustomersDTO {
1378
1383
  integratorId?: string;
1379
1384
  integrator?: IntegratorDTO;
1380
1385
  manualPayments?: Array<OrderManualPaymentDTO>;
1386
+ refundHandling?: OrderWithOrderCustomersDTORefundHandlingEnum;
1381
1387
  orderCustomers: Array<OrderCustomerDTO>;
1382
1388
  }
1383
1389
  export declare enum OrderWithOrderCustomersDTOProductIdEnum {
@@ -1395,6 +1401,10 @@ export declare enum OrderWithOrderCustomersDTOStatusIdEnum {
1395
1401
  CANCELLED = "CANCELLED",
1396
1402
  REFUNDED = "REFUNDED"
1397
1403
  }
1404
+ export declare enum OrderWithOrderCustomersDTORefundHandlingEnum {
1405
+ MANUAL = "MANUAL",
1406
+ AUTOMATIC = "AUTOMATIC"
1407
+ }
1398
1408
  export interface OrganizationAttributesDTO {
1399
1409
  vatRegistered?: boolean;
1400
1410
  vatNumber?: string;
@@ -1509,6 +1519,7 @@ export interface OrganizationSettingsDTO {
1509
1519
  maximumPolicyCover?: OrganizationSettingsDTOMaximumPolicyCoverEnum;
1510
1520
  evidenceChaserEnabled?: boolean;
1511
1521
  offerRepositEnabled?: boolean;
1522
+ optimisedSearchEnabled?: boolean;
1512
1523
  }
1513
1524
  export declare enum OrganizationSettingsDTOPricingRuleEnum {
1514
1525
  STANDARD = "STANDARD",
@@ -1832,6 +1843,7 @@ export declare enum QueueMessageDTOTypeEnum {
1832
1843
  PROCESSSTRIPECHARGEEXPIRED = "PROCESS_STRIPE_CHARGE_EXPIRED",
1833
1844
  PROCESSEXPIRINGCUSTOMERSOURCE = "PROCESS_EXPIRING_CUSTOMER_SOURCE",
1834
1845
  PROCESSSENDSLACKMESSAGE = "PROCESS_SEND_SLACK_MESSAGE",
1846
+ PROCESSSTRIPEREFUNDCREATED = "PROCESS_STRIPE_REFUND_CREATED",
1835
1847
  PAYMENTMETHODCARDAUTOMATICALLYUPDATED = "PAYMENT_METHOD_CARD_AUTOMATICALLY_UPDATED",
1836
1848
  MONTHLYDIRECTCOMMISSIONFORORGANIZATION = "MONTHLY_DIRECT_COMMISSION_FOR_ORGANIZATION",
1837
1849
  LANDLORDTRANSFERREMINDER = "LANDLORD_TRANSFER_REMINDER",
@@ -3201,7 +3213,7 @@ export interface ClaimsApiInterface {
3201
3213
  updateTenantDisputeMessage(claimId: string, updateTenantDisputeMessageDTO: UpdateTenantDisputeMessageDTO, options?: any): AxiosPromise<ClaimDTO>;
3202
3214
  verifyClaim(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
3203
3215
  waiveDisputeFee(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
3204
- zipDocuments(type: 'ADR' | 'INSURER', claimId: string, options?: any): AxiosPromise<object>;
3216
+ zipDocuments(type: "ADR" | "INSURER", claimId: string, options?: any): AxiosPromise<object>;
3205
3217
  }
3206
3218
  export declare class ClaimsApi extends BaseAPI implements ClaimsApiInterface {
3207
3219
  acknowledgeCaseSentToInsurer(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
@@ -3226,7 +3238,7 @@ export declare class ClaimsApi extends BaseAPI implements ClaimsApiInterface {
3226
3238
  updateTenantDisputeMessage(claimId: string, updateTenantDisputeMessageDTO: UpdateTenantDisputeMessageDTO, options?: any): AxiosPromise<ClaimDTO>;
3227
3239
  verifyClaim(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
3228
3240
  waiveDisputeFee(claimId: string, options?: any): AxiosPromise<ClaimDTO>;
3229
- zipDocuments(type: 'ADR' | 'INSURER', claimId: string, options?: any): AxiosPromise<object>;
3241
+ zipDocuments(type: "ADR" | "INSURER", claimId: string, options?: any): AxiosPromise<object>;
3230
3242
  }
3231
3243
  export declare const CommissionApiAxiosParamCreator: (configuration?: Configuration) => {
3232
3244
  generateCommissionCsvForPeriod(period: string, options?: any): RequestArgs;
@@ -3910,7 +3922,7 @@ export interface OrganizationsApiInterface {
3910
3922
  confirmBankAccounts(id: string, options?: any): AxiosPromise<OrganizationDTO>;
3911
3923
  createOrganization(createOrganizationDTO: CreateOrganizationDTO, options?: any): AxiosPromise<OrganizationDTO>;
3912
3924
  disableProductCreation(id: string, options?: any): AxiosPromise<OrganizationDTO>;
3913
- dismissOrganizationMessage(messageId: 'featureBankAccounts' | 'warningBankAccounts', id: string, options?: any): AxiosPromise<OrganizationDTO>;
3925
+ dismissOrganizationMessage(messageId: "featureBankAccounts" | "warningBankAccounts", id: string, options?: any): AxiosPromise<OrganizationDTO>;
3914
3926
  enableProductCreation(id: string, options?: any): AxiosPromise<OrganizationDTO>;
3915
3927
  fetchAddressesByOrganizationId(id: string, options?: any): AxiosPromise<Array<AddressDTO>>;
3916
3928
  fetchLandlordsByOrganizationId(id: string, options?: any): AxiosPromise<Array<LandlordDTO>>;
@@ -3936,7 +3948,7 @@ export declare class OrganizationsApi extends BaseAPI implements OrganizationsAp
3936
3948
  confirmBankAccounts(id: string, options?: any): AxiosPromise<OrganizationDTO>;
3937
3949
  createOrganization(createOrganizationDTO: CreateOrganizationDTO, options?: any): AxiosPromise<OrganizationDTO>;
3938
3950
  disableProductCreation(id: string, options?: any): AxiosPromise<OrganizationDTO>;
3939
- dismissOrganizationMessage(messageId: 'featureBankAccounts' | 'warningBankAccounts', id: string, options?: any): AxiosPromise<OrganizationDTO>;
3951
+ dismissOrganizationMessage(messageId: "featureBankAccounts" | "warningBankAccounts", id: string, options?: any): AxiosPromise<OrganizationDTO>;
3940
3952
  enableProductCreation(id: string, options?: any): AxiosPromise<OrganizationDTO>;
3941
3953
  fetchAddressesByOrganizationId(id: string, options?: any): AxiosPromise<AddressDTO[]>;
3942
3954
  fetchLandlordsByOrganizationId(id: string, options?: any): AxiosPromise<LandlordDTO[]>;
@@ -4266,7 +4278,7 @@ export interface ReferencesApiInterface {
4266
4278
  getChecks(id: string, options?: any): AxiosPromise<Array<CheckDTO>>;
4267
4279
  getReferenceDocuments(id: string, options?: any): AxiosPromise<Array<ReferenceDocumentDTO>>;
4268
4280
  readyForReview(id: string, options?: any): AxiosPromise<ReferenceDTO>;
4269
- searchReferences(status: string, page: number, size: number, sortBy?: 'CREATED_AT', options?: any): AxiosPromise<SearchReferencesResultsDTO>;
4281
+ searchReferences(status: string, page: number, size: number, sortBy?: "CREATED_AT", options?: any): AxiosPromise<SearchReferencesResultsDTO>;
4270
4282
  submitChecks(id: string, options?: any): AxiosPromise<Array<CheckDTO>>;
4271
4283
  }
4272
4284
  export declare class ReferencesApi extends BaseAPI implements ReferencesApiInterface {
@@ -4275,7 +4287,7 @@ export declare class ReferencesApi extends BaseAPI implements ReferencesApiInter
4275
4287
  getChecks(id: string, options?: any): AxiosPromise<CheckDTO[]>;
4276
4288
  getReferenceDocuments(id: string, options?: any): AxiosPromise<ReferenceDocumentDTO[]>;
4277
4289
  readyForReview(id: string, options?: any): AxiosPromise<ReferenceDTO>;
4278
- searchReferences(status: string, page: number, size: number, sortBy?: 'CREATED_AT', options?: any): AxiosPromise<SearchReferencesResultsDTO>;
4290
+ searchReferences(status: string, page: number, size: number, sortBy?: "CREATED_AT", options?: any): AxiosPromise<SearchReferencesResultsDTO>;
4279
4291
  submitChecks(id: string, options?: any): AxiosPromise<CheckDTO[]>;
4280
4292
  }
4281
4293
  export declare const RepositOffersApiAxiosParamCreator: (configuration?: Configuration) => {
@@ -4310,8 +4322,8 @@ export interface RepositOffersApiInterface {
4310
4322
  createOffer(offerToTenantRequestDTO: OfferToTenantRequestDTO, options?: any): AxiosPromise<object>;
4311
4323
  deleteOffer(id: string, options?: any): AxiosPromise<object>;
4312
4324
  getRepositOffer(id: string, token: string, options?: any): AxiosPromise<RepositOfferWithRecipientDTO>;
4313
- respondToOffer(id: string, choice: 'REPOSIT' | 'CASH_DEPOSIT', token: string, options?: any): AxiosPromise<object>;
4314
- 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>;
4325
+ respondToOffer(id: string, choice: "REPOSIT" | "CASH_DEPOSIT", token: string, options?: any): AxiosPromise<object>;
4326
+ 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>;
4315
4327
  sendReminder(id: string, options?: any): AxiosPromise<object>;
4316
4328
  }
4317
4329
  export declare class RepositOffersApi extends BaseAPI implements RepositOffersApiInterface {
@@ -4319,8 +4331,8 @@ export declare class RepositOffersApi extends BaseAPI implements RepositOffersAp
4319
4331
  createOffer(offerToTenantRequestDTO: OfferToTenantRequestDTO, options?: any): AxiosPromise<object>;
4320
4332
  deleteOffer(id: string, options?: any): AxiosPromise<object>;
4321
4333
  getRepositOffer(id: string, token: string, options?: any): AxiosPromise<RepositOfferWithRecipientDTO>;
4322
- respondToOffer(id: string, choice: 'REPOSIT' | 'CASH_DEPOSIT', token: string, options?: any): AxiosPromise<object>;
4323
- 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>;
4334
+ respondToOffer(id: string, choice: "REPOSIT" | "CASH_DEPOSIT", token: string, options?: any): AxiosPromise<object>;
4335
+ 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>;
4324
4336
  sendReminder(id: string, options?: any): AxiosPromise<object>;
4325
4337
  }
4326
4338
  export declare const RepositsApiAxiosParamCreator: (configuration?: Configuration) => {
@@ -4547,11 +4559,11 @@ export declare const TenancyInventoriesApiFactory: (configuration?: Configuratio
4547
4559
  };
4548
4560
  export interface TenancyInventoriesApiInterface {
4549
4561
  disableWarnings(id: string, tenancyId: string, options?: any): AxiosPromise<TenancyInventoryDTO>;
4550
- tenantConfirmation(token: string, response: 'CONFIRMED' | 'UNCONFIRMED', tenancyId: string, options?: any): AxiosPromise<object>;
4562
+ tenantConfirmation(token: string, response: "CONFIRMED" | "UNCONFIRMED", tenancyId: string, options?: any): AxiosPromise<object>;
4551
4563
  }
4552
4564
  export declare class TenancyInventoriesApi extends BaseAPI implements TenancyInventoriesApiInterface {
4553
4565
  disableWarnings(id: string, tenancyId: string, options?: any): AxiosPromise<TenancyInventoryDTO>;
4554
- tenantConfirmation(token: string, response: 'CONFIRMED' | 'UNCONFIRMED', tenancyId: string, options?: any): AxiosPromise<object>;
4566
+ tenantConfirmation(token: string, response: "CONFIRMED" | "UNCONFIRMED", tenancyId: string, options?: any): AxiosPromise<object>;
4555
4567
  }
4556
4568
  export declare const TenancyInvitesApiAxiosParamCreator: (configuration?: Configuration) => {
4557
4569
  acceptTenancyInvite(token: string, clearSession: boolean, tenancyId: string, options?: any): RequestArgs;
@@ -4642,19 +4654,19 @@ export declare const TenancyOrdersApiFactory: (configuration?: Configuration, ba
4642
4654
  };
4643
4655
  export interface TenancyOrdersApiInterface {
4644
4656
  getTenancyOrderById(id: string, includeDeleted?: boolean, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4645
- 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>;
4657
+ 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>;
4646
4658
  removeTenancyOrderById(id: string, removeTenancyOrderDTO: RemoveTenancyOrderDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4647
4659
  reopenTenancyOrder(id: string, reopenRepositDTO: ReopenRepositDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4648
- search(productId: string, 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>;
4660
+ search(productId: string, 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>;
4649
4661
  sendOverdueChasers(id: string, options?: any): AxiosPromise<{}>;
4650
4662
  transferTenancyOrderToOrganization(id: string, transferTenancyOrderDTO: TransferTenancyOrderDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4651
4663
  }
4652
4664
  export declare class TenancyOrdersApi extends BaseAPI implements TenancyOrdersApiInterface {
4653
4665
  getTenancyOrderById(id: string, includeDeleted?: boolean, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4654
- 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>;
4666
+ 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>;
4655
4667
  removeTenancyOrderById(id: string, removeTenancyOrderDTO: RemoveTenancyOrderDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4656
4668
  reopenTenancyOrder(id: string, reopenRepositDTO: ReopenRepositDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4657
- search(productId: string, 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>;
4669
+ search(productId: string, 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>;
4658
4670
  sendOverdueChasers(id: string, options?: any): AxiosPromise<Response>;
4659
4671
  transferTenancyOrderToOrganization(id: string, transferTenancyOrderDTO: TransferTenancyOrderDTO, options?: any): AxiosPromise<TenancyOrderWithTenancyAndOrderCustomersDTO>;
4660
4672
  }