@reposit/api-client 6.56.0 → 6.58.0

package/dist/api.d.ts

@@ -14,6 +14,7 @@ export declare enum AddRejectionReasonRequestDTORejectionReasonEnum {
     NONREFUNDABLEFEE = "NON_REFUNDABLE_FEE",
     TOOEXPENSIVE = "TOO_EXPENSIVE",
     DONTUNDERSTAND = "DONT_UNDERSTAND",
+    FAILEDREFERENCING = "FAILED_REFERENCING",
     OTHER = "OTHER"
 }
 export interface AddTenantRequestDTO {
@@ -103,6 +104,11 @@ export interface ArbitrationResponseDTO {
     message?: string;
     createdAt: string;
 }
+export interface BankDetailsDTO {
+    accountNumber: string;
+    sortCode: string;
+    reference: string;
+}
 export interface BeneficiaryDTO {
     id: string;
     firstName: string;
@@ -113,6 +119,26 @@ export interface BeneficiaryDTO {
 export interface CashDepositDTO {
     cashDeposit: number;
 }
+export interface CashDepositDetailsDTO {
+    amount: number;
+    PPM: number;
+    letOnly: boolean;
+    startDate: string;
+    property: CashDepositPropertyDTO;
+    cashDepositScheme: CashDepositSchemeDTO;
+}
+export interface CashDepositPropertyDTO {
+    address: CoreAddressDTO;
+}
+export interface CashDepositSchemeDTO {
+    id: string;
+    name: string;
+}
+export interface CashDepositTenantDTO {
+    firstName: string;
+    lastName: string;
+    email: string;
+}
 export interface ChangeInstalmentDatesDTO {
     targetInstalmentDate: number;
 }
@@ -417,6 +443,9 @@ export declare enum ClaimWithCheckoutRelationsDTOStatusEnum {
     ARBITRATION = "ARBITRATION",
     INSURANCECLAIM = "INSURANCE_CLAIM"
 }
+export interface ConfirmTenancyDetailsResponseDTO {
+    confirmedAt: Date;
+}
 export interface CoreAddressDTO {
     roomNumber?: string;
     flatNumber?: string;
@@ -1002,6 +1031,16 @@ export interface DeactivateClaimDTO {
 export interface DeferPaymentPlanInstalmentDTO {
     deferredDate: string;
 }
+export interface DepositDTO {
+    cashDepositScheme: OfferDepositSchemeDTO;
+    status: DepositDTOStatusEnum;
+}
+export declare enum DepositDTOStatusEnum {
+    PENDING = "PENDING",
+    CANCELLED = "CANCELLED",
+    PARTIALLYPAID = "PARTIALLY_PAID",
+    PAID = "PAID"
+}
 export interface DocumentDTO {
     id: string;
     name: string;
@@ -1316,6 +1355,10 @@ export interface NextPaymentPlanActionDTO {
 export interface NotifyIntegratorDTO {
     integratorId: string;
 }
+export interface OfferDepositSchemeDTO {
+    id: string;
+    name: string;
+}
 export interface OfferToTenantRequestDTO {
     propertyId: string;
     PPM: number;
@@ -1582,6 +1625,7 @@ export interface OrganizationSettingsDTO {
     offerRepositEnabled?: boolean;
     inventoryChaserDisabled?: boolean;
     minimumFeeDisabled?: boolean;
+    pendingSwitchRemindersDisabled?: boolean;
 }
 export declare enum OrganizationSettingsDTOPricingRuleEnum {
     STANDARD = "STANDARD",
@@ -1960,7 +2004,9 @@ export declare enum QueueMessageDTOTypeEnum {
     IVRCALLPROCESSING = "IVR_CALL_PROCESSING",
     PROCESSTWILIOIVRWEBHOOK = "PROCESS_TWILIO_IVR_WEBHOOK",
     PROCESSTWILIOVOICEMAILWEBHOOK = "PROCESS_TWILIO_VOICEMAIL_WEBHOOK",
-    PENDINGREPOSITPOSTSTARTDATEWEEKLYREMINDER = "PENDING_REPOSIT_POST_START_DATE_WEEKLY_REMINDER"
+    PENDINGREPOSITPOSTSTARTDATEWEEKLYREMINDER = "PENDING_REPOSIT_POST_START_DATE_WEEKLY_REMINDER",
+    DEPOSITCOMPLETED = "DEPOSIT_COMPLETED",
+    REFRESHMYDEPOSITSACCESSTOKEN = "REFRESH_MY_DEPOSITS_ACCESS_TOKEN"
 }
 export declare enum QueueMessageDTOCronNameEnum {
     DAILYKPIS = "DAILY_KPIS",
@@ -2003,7 +2049,9 @@ export declare enum QueueMessageDTOCronNameEnum {
     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"
+    WEEKLYPENDINGREPOSITPASTSTARTDATEREMINDER = "WEEKLY_PENDING_REPOSIT_PAST_START_DATE_REMINDER",
+    POLLPENDINGCASHDEPOSITS = "POLL_PENDING_CASH_DEPOSITS",
+    REFRESHMYDEPOSITSACCESSTOKENS = "REFRESH_MY_DEPOSITS_ACCESS_TOKENS"
 }
 export interface ReconciliationDocumentDTO {
     document: DocumentDTO;
@@ -2138,6 +2186,7 @@ export interface RepositOfferDTO {
     repositAmount: number;
     savingAmount: number;
     tenancyOrder?: TenancyOrderDTO;
+    cashDeposit?: DepositDTO;
     tenantsReferenceStatus?: RepositOfferDTOTenantsReferenceStatusEnum;
     tenancyStartDate?: string;
     tenancyEndDate?: string;
@@ -2351,6 +2400,7 @@ export interface SearchRepositOfferDTO {
     repositAmount: number;
     savingAmount: number;
     tenancyOrder?: TenancyOrderDTO;
+    cashDeposit?: DepositDTO;
     tenantsReferenceStatus?: SearchRepositOfferDTOTenantsReferenceStatusEnum;
     tenancyStartDate?: string;
     tenancyEndDate?: string;
@@ -2870,6 +2920,22 @@ export interface UserFeatureFlagsDTO {
     betaAllowed?: boolean;
     betaEnabled?: boolean;
 }
+export interface VerifyPostcodeRequestDTO {
+    token: string;
+    postcode: string;
+}
+export interface VerifyPostcodeResponseDTO {
+    status: VerifyPostcodeResponseDTOStatusEnum;
+    bankDetails?: BankDetailsDTO;
+    cashDeposit?: CashDepositDetailsDTO;
+    tenants: Array<CashDepositTenantDTO>;
+}
+export declare enum VerifyPostcodeResponseDTOStatusEnum {
+    PENDING = "PENDING",
+    CANCELLED = "CANCELLED",
+    PARTIALLYPAID = "PARTIALLY_PAID",
+    PAID = "PAID"
+}
 export declare const AddressesApiAxiosParamCreator: (configuration?: Configuration) => {
     createAddress(createAddressWithOrgDTO: CreateAddressWithOrgDTO, options?: any): RequestArgs;
     findAddressById(id: string, options?: any): RequestArgs;
@@ -3050,6 +3116,26 @@ export interface BeneficiariesApiInterface {
 export declare class BeneficiariesApi extends BaseAPI implements BeneficiariesApiInterface {
     updateBeneficiary(id: string, updateBeneficiaryDTO: UpdateBeneficiaryDTO, options?: any): AxiosPromise<BeneficiaryDTO>;
 }
+export declare const CashDepositsApiAxiosParamCreator: (configuration?: Configuration) => {
+    confirmTenancyDetails(verifyPostcodeRequestDTO: VerifyPostcodeRequestDTO, options?: any): RequestArgs;
+    verifyPostcode(verifyPostcodeRequestDTO: VerifyPostcodeRequestDTO, options?: any): RequestArgs;
+};
+export declare const CashDepositsApiFp: (configuration?: Configuration) => {
+    confirmTenancyDetails(verifyPostcodeRequestDTO: VerifyPostcodeRequestDTO, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfirmTenancyDetailsResponseDTO>;
+    verifyPostcode(verifyPostcodeRequestDTO: VerifyPostcodeRequestDTO, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise<VerifyPostcodeResponseDTO>;
+};
+export declare const CashDepositsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    confirmTenancyDetails(verifyPostcodeRequestDTO: VerifyPostcodeRequestDTO, options?: any): AxiosPromise<ConfirmTenancyDetailsResponseDTO>;
+    verifyPostcode(verifyPostcodeRequestDTO: VerifyPostcodeRequestDTO, options?: any): AxiosPromise<VerifyPostcodeResponseDTO>;
+};
+export interface CashDepositsApiInterface {
+    confirmTenancyDetails(verifyPostcodeRequestDTO: VerifyPostcodeRequestDTO, options?: any): AxiosPromise<ConfirmTenancyDetailsResponseDTO>;
+    verifyPostcode(verifyPostcodeRequestDTO: VerifyPostcodeRequestDTO, options?: any): AxiosPromise<VerifyPostcodeResponseDTO>;
+}
+export declare class CashDepositsApi extends BaseAPI implements CashDepositsApiInterface {
+    confirmTenancyDetails(verifyPostcodeRequestDTO: VerifyPostcodeRequestDTO, options?: any): AxiosPromise<ConfirmTenancyDetailsResponseDTO>;
+    verifyPostcode(verifyPostcodeRequestDTO: VerifyPostcodeRequestDTO, options?: any): AxiosPromise<VerifyPostcodeResponseDTO>;
+}
 export declare const ChecksApiAxiosParamCreator: (configuration?: Configuration) => {
     findCheckById(id: string, options?: any): RequestArgs;
     override(id: string, options?: any): RequestArgs;

package/dist/api.js

@@ -32,6 +32,7 @@ var AddRejectionReasonRequestDTORejectionReasonEnum;
     AddRejectionReasonRequestDTORejectionReasonEnum["NONREFUNDABLEFEE"] = "NON_REFUNDABLE_FEE";
     AddRejectionReasonRequestDTORejectionReasonEnum["TOOEXPENSIVE"] = "TOO_EXPENSIVE";
     AddRejectionReasonRequestDTORejectionReasonEnum["DONTUNDERSTAND"] = "DONT_UNDERSTAND";
+    AddRejectionReasonRequestDTORejectionReasonEnum["FAILEDREFERENCING"] = "FAILED_REFERENCING";
     AddRejectionReasonRequestDTORejectionReasonEnum["OTHER"] = "OTHER";
 })(AddRejectionReasonRequestDTORejectionReasonEnum = exports.AddRejectionReasonRequestDTORejectionReasonEnum || (exports.AddRejectionReasonRequestDTORejectionReasonEnum = {}));
 var ArbitrationDTOStatusEnum;
@@ -393,6 +394,13 @@ var CurrentUserInfoDTOCurrentOrganizationRolesEnum;
     CurrentUserInfoDTOCurrentOrganizationRolesEnum["BANKACCOUNTS"] = "BANK_ACCOUNTS";
     CurrentUserInfoDTOCurrentOrganizationRolesEnum["ONBOARDING"] = "ONBOARDING";
 })(CurrentUserInfoDTOCurrentOrganizationRolesEnum = exports.CurrentUserInfoDTOCurrentOrganizationRolesEnum || (exports.CurrentUserInfoDTOCurrentOrganizationRolesEnum = {}));
+var DepositDTOStatusEnum;
+(function (DepositDTOStatusEnum) {
+    DepositDTOStatusEnum["PENDING"] = "PENDING";
+    DepositDTOStatusEnum["CANCELLED"] = "CANCELLED";
+    DepositDTOStatusEnum["PARTIALLYPAID"] = "PARTIALLY_PAID";
+    DepositDTOStatusEnum["PAID"] = "PAID";
+})(DepositDTOStatusEnum = exports.DepositDTOStatusEnum || (exports.DepositDTOStatusEnum = {}));
 var EvidenceChaserDTOTypeEnum;
 (function (EvidenceChaserDTOTypeEnum) {
     EvidenceChaserDTOTypeEnum["AUTOACCEPTED"] = "AUTO_ACCEPTED";
@@ -806,6 +814,8 @@ var QueueMessageDTOTypeEnum;
     QueueMessageDTOTypeEnum["PROCESSTWILIOIVRWEBHOOK"] = "PROCESS_TWILIO_IVR_WEBHOOK";
     QueueMessageDTOTypeEnum["PROCESSTWILIOVOICEMAILWEBHOOK"] = "PROCESS_TWILIO_VOICEMAIL_WEBHOOK";
     QueueMessageDTOTypeEnum["PENDINGREPOSITPOSTSTARTDATEWEEKLYREMINDER"] = "PENDING_REPOSIT_POST_START_DATE_WEEKLY_REMINDER";
+    QueueMessageDTOTypeEnum["DEPOSITCOMPLETED"] = "DEPOSIT_COMPLETED";
+    QueueMessageDTOTypeEnum["REFRESHMYDEPOSITSACCESSTOKEN"] = "REFRESH_MY_DEPOSITS_ACCESS_TOKEN";
 })(QueueMessageDTOTypeEnum = exports.QueueMessageDTOTypeEnum || (exports.QueueMessageDTOTypeEnum = {}));
 var QueueMessageDTOCronNameEnum;
 (function (QueueMessageDTOCronNameEnum) {
@@ -850,6 +860,8 @@ var QueueMessageDTOCronNameEnum;
     QueueMessageDTOCronNameEnum["DAILYARBITRATIONSENTNOTIFICATION"] = "DAILY_ARBITRATION_SENT_NOTIFICATION";
     QueueMessageDTOCronNameEnum["DAILYIVRCALLPROCESSING"] = "DAILY_IVR_CALL_PROCESSING";
     QueueMessageDTOCronNameEnum["WEEKLYPENDINGREPOSITPASTSTARTDATEREMINDER"] = "WEEKLY_PENDING_REPOSIT_PAST_START_DATE_REMINDER";
+    QueueMessageDTOCronNameEnum["POLLPENDINGCASHDEPOSITS"] = "POLL_PENDING_CASH_DEPOSITS";
+    QueueMessageDTOCronNameEnum["REFRESHMYDEPOSITSACCESSTOKENS"] = "REFRESH_MY_DEPOSITS_ACCESS_TOKENS";
 })(QueueMessageDTOCronNameEnum = exports.QueueMessageDTOCronNameEnum || (exports.QueueMessageDTOCronNameEnum = {}));
 var ReferenceDTOStatusEnum;
 (function (ReferenceDTOStatusEnum) {
@@ -1016,6 +1028,13 @@ var UserDTOInternalRolesEnum;
     UserDTOInternalRolesEnum["INTERNALREPORTSALES"] = "INTERNAL_REPORT_SALES";
     UserDTOInternalRolesEnum["MANAGEORGANIZATIONUSERROLES"] = "MANAGE_ORGANIZATION_USER_ROLES";
 })(UserDTOInternalRolesEnum = exports.UserDTOInternalRolesEnum || (exports.UserDTOInternalRolesEnum = {}));
+var VerifyPostcodeResponseDTOStatusEnum;
+(function (VerifyPostcodeResponseDTOStatusEnum) {
+    VerifyPostcodeResponseDTOStatusEnum["PENDING"] = "PENDING";
+    VerifyPostcodeResponseDTOStatusEnum["CANCELLED"] = "CANCELLED";
+    VerifyPostcodeResponseDTOStatusEnum["PARTIALLYPAID"] = "PARTIALLY_PAID";
+    VerifyPostcodeResponseDTOStatusEnum["PAID"] = "PAID";
+})(VerifyPostcodeResponseDTOStatusEnum = exports.VerifyPostcodeResponseDTOStatusEnum || (exports.VerifyPostcodeResponseDTOStatusEnum = {}));
 exports.AddressesApiAxiosParamCreator = function (configuration) {
     return {
         createAddress: function (createAddressWithOrgDTO, options) {
@@ -2059,6 +2078,106 @@ var BeneficiariesApi = (function (_super) {
     return BeneficiariesApi;
 }(base_1.BaseAPI));
 exports.BeneficiariesApi = BeneficiariesApi;
+exports.CashDepositsApiAxiosParamCreator = function (configuration) {
+    return {
+        confirmTenancyDetails: function (verifyPostcodeRequestDTO, options) {
+            if (options === void 0) { options = {}; }
+            if (verifyPostcodeRequestDTO === null || verifyPostcodeRequestDTO === undefined) {
+                throw new base_1.RequiredError('verifyPostcodeRequestDTO', 'Required parameter verifyPostcodeRequestDTO was null or undefined when calling confirmTenancyDetails.');
+            }
+            var localVarPath = "/v2/cash-deposit/confirm-tenancy-details";
+            var localVarUrlObj = globalImportUrl.parse(localVarPath, true);
+            var baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            var localVarRequestOptions = __assign({ method: 'POST' }, baseOptions, options);
+            var localVarHeaderParameter = {};
+            var localVarQueryParameter = {};
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarUrlObj.query = __assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = __assign({}, localVarHeaderParameter, options.headers);
+            var needsSerialization = ("VerifyPostcodeRequestDTO" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.data = needsSerialization ? JSON.stringify(verifyPostcodeRequestDTO !== undefined ? verifyPostcodeRequestDTO : {}) : (verifyPostcodeRequestDTO || "");
+            return {
+                url: globalImportUrl.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        verifyPostcode: function (verifyPostcodeRequestDTO, options) {
+            if (options === void 0) { options = {}; }
+            if (verifyPostcodeRequestDTO === null || verifyPostcodeRequestDTO === undefined) {
+                throw new base_1.RequiredError('verifyPostcodeRequestDTO', 'Required parameter verifyPostcodeRequestDTO was null or undefined when calling verifyPostcode.');
+            }
+            var localVarPath = "/v2/cash-deposit/verify-postcode";
+            var localVarUrlObj = globalImportUrl.parse(localVarPath, true);
+            var baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            var localVarRequestOptions = __assign({ method: 'POST' }, baseOptions, options);
+            var localVarHeaderParameter = {};
+            var localVarQueryParameter = {};
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarUrlObj.query = __assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = __assign({}, localVarHeaderParameter, options.headers);
+            var needsSerialization = ("VerifyPostcodeRequestDTO" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.data = needsSerialization ? JSON.stringify(verifyPostcodeRequestDTO !== undefined ? verifyPostcodeRequestDTO : {}) : (verifyPostcodeRequestDTO || "");
+            return {
+                url: globalImportUrl.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    };
+};
+exports.CashDepositsApiFp = function (configuration) {
+    return {
+        confirmTenancyDetails: function (verifyPostcodeRequestDTO, options) {
+            var localVarAxiosArgs = exports.CashDepositsApiAxiosParamCreator(configuration).confirmTenancyDetails(verifyPostcodeRequestDTO, options);
+            return function (axios, basePath) {
+                if (axios === void 0) { axios = axios_1.default; }
+                if (basePath === void 0) { basePath = base_1.BASE_PATH; }
+                var axiosRequestArgs = __assign({}, localVarAxiosArgs.options, { url: basePath + localVarAxiosArgs.url });
+                return axios.request(axiosRequestArgs);
+            };
+        },
+        verifyPostcode: function (verifyPostcodeRequestDTO, options) {
+            var localVarAxiosArgs = exports.CashDepositsApiAxiosParamCreator(configuration).verifyPostcode(verifyPostcodeRequestDTO, options);
+            return function (axios, basePath) {
+                if (axios === void 0) { axios = axios_1.default; }
+                if (basePath === void 0) { basePath = base_1.BASE_PATH; }
+                var axiosRequestArgs = __assign({}, localVarAxiosArgs.options, { url: basePath + localVarAxiosArgs.url });
+                return axios.request(axiosRequestArgs);
+            };
+        },
+    };
+};
+exports.CashDepositsApiFactory = function (configuration, basePath, axios) {
+    return {
+        confirmTenancyDetails: function (verifyPostcodeRequestDTO, options) {
+            return exports.CashDepositsApiFp(configuration).confirmTenancyDetails(verifyPostcodeRequestDTO, options)(axios, basePath);
+        },
+        verifyPostcode: function (verifyPostcodeRequestDTO, options) {
+            return exports.CashDepositsApiFp(configuration).verifyPostcode(verifyPostcodeRequestDTO, options)(axios, basePath);
+        },
+    };
+};
+var CashDepositsApi = (function (_super) {
+    __extends(CashDepositsApi, _super);
+    function CashDepositsApi() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    CashDepositsApi.prototype.confirmTenancyDetails = function (verifyPostcodeRequestDTO, options) {
+        return exports.CashDepositsApiFp(this.configuration).confirmTenancyDetails(verifyPostcodeRequestDTO, options)(this.axios, this.basePath);
+    };
+    CashDepositsApi.prototype.verifyPostcode = function (verifyPostcodeRequestDTO, options) {
+        return exports.CashDepositsApiFp(this.configuration).verifyPostcode(verifyPostcodeRequestDTO, options)(this.axios, this.basePath);
+    };
+    return CashDepositsApi;
+}(base_1.BaseAPI));
+exports.CashDepositsApi = CashDepositsApi;
 exports.ChecksApiAxiosParamCreator = function (configuration) {
     return {
         findCheckById: function (id, options) {