@reposit/api-client 6.50.0 → 6.52.0

package/dist/api.d.ts

@@ -1301,6 +1301,11 @@ export interface OfferToTenantRequestDTO {
     organizationId: string;
     tenants: Array<TenantForOfferDTO>;
     cashDepositAmount?: number;
+    tenantsReferenceStatus?: OfferToTenantRequestDTOTenantsReferenceStatusEnum;
+}
+export declare enum OfferToTenantRequestDTOTenantsReferenceStatusEnum {
+    PASSED = "PASSED",
+    FAILED = "FAILED"
 }
 export interface OneTimeSessionTokenDTO {
     id: string;
@@ -1472,6 +1477,12 @@ export declare enum OrganizationBankAccountDTOAccountTypeEnum {
     DEFAULT = "DEFAULT",
     CLAIM = "CLAIM"
 }
+export interface OrganizationCashDepositSchemeDTO {
+    id: string;
+    cashDepositSchemeId: string;
+    createdAt: string;
+    updatedAt: string;
+}
 export interface OrganizationDTO {
     id: string;
     parentId: string;
@@ -1617,6 +1628,25 @@ export declare enum OrganizationVerticalDTONameEnum {
     HMO = "HMO",
     PBSA = "PBSA"
 }
+export interface OrganizationWithCashDepositDTO {
+    id: string;
+    parentId: string;
+    name: string;
+    attributes?: OrganizationAttributesDTO;
+    settings?: OrganizationSettingsDTO;
+    organizationTypeId: OrganizationWithCashDepositDTOOrganizationTypeIdEnum;
+    organizationRecipients?: Array<OrganizationRecipientDTO>;
+    createdAt: string;
+    updatedAt: string;
+    legacyId?: string;
+    hasCashDepositEnabled: boolean;
+}
+export declare enum OrganizationWithCashDepositDTOOrganizationTypeIdEnum {
+    AGENCY = "AGENCY",
+    BUILDTORENT = "BUILD_TO_RENT",
+    PRIVATE = "PRIVATE",
+    INTEGRATORREFERRAL = "INTEGRATOR_REFERRAL"
+}
 export interface OrganizationWithRepositsAndRoles {
     id: string;
     parentId: string;
@@ -2082,9 +2112,14 @@ export interface RepositOfferDTO {
     repositAmount: number;
     savingAmount: number;
     tenancyOrder?: TenancyOrderDTO;
+    tenantsReferenceStatus?: RepositOfferDTOTenantsReferenceStatusEnum;
     createdAt: string;
     updatedAt: string;
 }
+export declare enum RepositOfferDTOTenantsReferenceStatusEnum {
+    PASSED = "PASSED",
+    FAILED = "FAILED"
+}
 export interface RepositOfferRecipientDTO {
     id: string;
     repositOfferId: string;
@@ -2528,6 +2563,7 @@ export interface TenantForOfferDTO {
     email: string;
     firstName: string;
     lastName: string;
+    guarantor?: TenantGuarantorForOfferDTO;
 }
 export interface TenantGuarantorDTO {
     firstName: string;
@@ -2535,6 +2571,12 @@ export interface TenantGuarantorDTO {
     email: string;
     mobileNumber?: string;
 }
+export interface TenantGuarantorForOfferDTO {
+    email: string;
+    firstName: string;
+    lastName: string;
+    mobileNumber?: string;
+}
 export interface TermsDTO {
     url: string;
 }
@@ -3937,6 +3979,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
     fetchTenanciesByOrganizationId(id: string, options?: any): RequestArgs;
     fetchUsersByOrganizationId(id: string, options?: any): RequestArgs;
     findOrganizationById(id: string, options?: any): RequestArgs;
+    getCashDepositScheme(id: string, options?: any): RequestArgs;
     getChildren(id: string, options?: any): RequestArgs;
     getOrganizationMetrics(organizationId: string, options?: any): RequestArgs;
     getOrganizationVerticals(id: string, options?: any): RequestArgs;
@@ -3964,7 +4007,8 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
     fetchPropertiesByOrganizationId(id: string, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise<PropertyDTO[]>;
     fetchTenanciesByOrganizationId(id: string, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise<TenancyDTO[]>;
     fetchUsersByOrganizationId(id: string, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDTO[]>;
-    findOrganizationById(id: string, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationDTO>;
+    findOrganizationById(id: string, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationWithCashDepositDTO>;
+    getCashDepositScheme(id: string, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationCashDepositSchemeDTO[]>;
     getChildren(id: string, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationDTO[]>;
     getOrganizationMetrics(organizationId: string, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationMetricsDTO>;
     getOrganizationVerticals(id: string, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationVerticalDTO[]>;
@@ -3992,7 +4036,8 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
     fetchPropertiesByOrganizationId(id: string, options?: any): AxiosPromise<PropertyDTO[]>;
     fetchTenanciesByOrganizationId(id: string, options?: any): AxiosPromise<TenancyDTO[]>;
     fetchUsersByOrganizationId(id: string, options?: any): AxiosPromise<UserDTO[]>;
-    findOrganizationById(id: string, options?: any): AxiosPromise<OrganizationDTO>;
+    findOrganizationById(id: string, options?: any): AxiosPromise<OrganizationWithCashDepositDTO>;
+    getCashDepositScheme(id: string, options?: any): AxiosPromise<OrganizationCashDepositSchemeDTO[]>;
     getChildren(id: string, options?: any): AxiosPromise<OrganizationDTO[]>;
     getOrganizationMetrics(organizationId: string, options?: any): AxiosPromise<OrganizationMetricsDTO>;
     getOrganizationVerticals(id: string, options?: any): AxiosPromise<OrganizationVerticalDTO[]>;
@@ -4020,7 +4065,8 @@ export interface OrganizationsApiInterface {
     fetchPropertiesByOrganizationId(id: string, options?: any): AxiosPromise<Array<PropertyDTO>>;
     fetchTenanciesByOrganizationId(id: string, options?: any): AxiosPromise<Array<TenancyDTO>>;
     fetchUsersByOrganizationId(id: string, options?: any): AxiosPromise<Array<UserDTO>>;
-    findOrganizationById(id: string, options?: any): AxiosPromise<OrganizationDTO>;
+    findOrganizationById(id: string, options?: any): AxiosPromise<OrganizationWithCashDepositDTO>;
+    getCashDepositScheme(id: string, options?: any): AxiosPromise<Array<OrganizationCashDepositSchemeDTO>>;
     getChildren(id: string, options?: any): AxiosPromise<Array<OrganizationDTO>>;
     getOrganizationMetrics(organizationId: string, options?: any): AxiosPromise<OrganizationMetricsDTO>;
     getOrganizationVerticals(id: string, options?: any): AxiosPromise<Array<OrganizationVerticalDTO>>;
@@ -4048,7 +4094,8 @@ export declare class OrganizationsApi extends BaseAPI implements OrganizationsAp
     fetchPropertiesByOrganizationId(id: string, options?: any): AxiosPromise<PropertyDTO[]>;
     fetchTenanciesByOrganizationId(id: string, options?: any): AxiosPromise<TenancyDTO[]>;
     fetchUsersByOrganizationId(id: string, options?: any): AxiosPromise<UserDTO[]>;
-    findOrganizationById(id: string, options?: any): AxiosPromise<OrganizationDTO>;
+    findOrganizationById(id: string, options?: any): AxiosPromise<OrganizationWithCashDepositDTO>;
+    getCashDepositScheme(id: string, options?: any): AxiosPromise<OrganizationCashDepositSchemeDTO[]>;
     getChildren(id: string, options?: any): AxiosPromise<OrganizationDTO[]>;
     getOrganizationMetrics(organizationId: string, options?: any): AxiosPromise<OrganizationMetricsDTO>;
     getOrganizationVerticals(id: string, options?: any): AxiosPromise<OrganizationVerticalDTO[]>;

package/dist/api.js

@@ -476,6 +476,11 @@ var NetPromoterScoreDTOCategoryEnum;
     NetPromoterScoreDTOCategoryEnum["DETRACTOR"] = "DETRACTOR";
     NetPromoterScoreDTOCategoryEnum["PASSIVE"] = "PASSIVE";
 })(NetPromoterScoreDTOCategoryEnum = exports.NetPromoterScoreDTOCategoryEnum || (exports.NetPromoterScoreDTOCategoryEnum = {}));
+var OfferToTenantRequestDTOTenantsReferenceStatusEnum;
+(function (OfferToTenantRequestDTOTenantsReferenceStatusEnum) {
+    OfferToTenantRequestDTOTenantsReferenceStatusEnum["PASSED"] = "PASSED";
+    OfferToTenantRequestDTOTenantsReferenceStatusEnum["FAILED"] = "FAILED";
+})(OfferToTenantRequestDTOTenantsReferenceStatusEnum = exports.OfferToTenantRequestDTOTenantsReferenceStatusEnum || (exports.OfferToTenantRequestDTOTenantsReferenceStatusEnum = {}));
 var OrderCustomerActionDTOTypeIdEnum;
 (function (OrderCustomerActionDTOTypeIdEnum) {
     OrderCustomerActionDTOTypeIdEnum["REPOSITABOUTYOU"] = "REPOSIT_ABOUT_YOU";
@@ -618,6 +623,13 @@ var OrganizationVerticalDTONameEnum;
     OrganizationVerticalDTONameEnum["HMO"] = "HMO";
     OrganizationVerticalDTONameEnum["PBSA"] = "PBSA";
 })(OrganizationVerticalDTONameEnum = exports.OrganizationVerticalDTONameEnum || (exports.OrganizationVerticalDTONameEnum = {}));
+var OrganizationWithCashDepositDTOOrganizationTypeIdEnum;
+(function (OrganizationWithCashDepositDTOOrganizationTypeIdEnum) {
+    OrganizationWithCashDepositDTOOrganizationTypeIdEnum["AGENCY"] = "AGENCY";
+    OrganizationWithCashDepositDTOOrganizationTypeIdEnum["BUILDTORENT"] = "BUILD_TO_RENT";
+    OrganizationWithCashDepositDTOOrganizationTypeIdEnum["PRIVATE"] = "PRIVATE";
+    OrganizationWithCashDepositDTOOrganizationTypeIdEnum["INTEGRATORREFERRAL"] = "INTEGRATOR_REFERRAL";
+})(OrganizationWithCashDepositDTOOrganizationTypeIdEnum = exports.OrganizationWithCashDepositDTOOrganizationTypeIdEnum || (exports.OrganizationWithCashDepositDTOOrganizationTypeIdEnum = {}));
 var OrganizationWithRepositsAndRolesOrganizationTypeIdEnum;
 (function (OrganizationWithRepositsAndRolesOrganizationTypeIdEnum) {
     OrganizationWithRepositsAndRolesOrganizationTypeIdEnum["AGENCY"] = "AGENCY";
@@ -846,6 +858,11 @@ var RepositDTOStatusEnum;
     RepositDTOStatusEnum["DRAFT"] = "DRAFT";
     RepositDTOStatusEnum["PUBLISHED"] = "PUBLISHED";
 })(RepositDTOStatusEnum = exports.RepositDTOStatusEnum || (exports.RepositDTOStatusEnum = {}));
+var RepositOfferDTOTenantsReferenceStatusEnum;
+(function (RepositOfferDTOTenantsReferenceStatusEnum) {
+    RepositOfferDTOTenantsReferenceStatusEnum["PASSED"] = "PASSED";
+    RepositOfferDTOTenantsReferenceStatusEnum["FAILED"] = "FAILED";
+})(RepositOfferDTOTenantsReferenceStatusEnum = exports.RepositOfferDTOTenantsReferenceStatusEnum || (exports.RepositOfferDTOTenantsReferenceStatusEnum = {}));
 var RepositOfferRecipientDTOChoiceEnum;
 (function (RepositOfferRecipientDTOChoiceEnum) {
     RepositOfferRecipientDTOChoiceEnum["REPOSIT"] = "REPOSIT";
@@ -8186,6 +8203,29 @@ exports.OrganizationsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        getCashDepositScheme: function (id, options) {
+            if (options === void 0) { options = {}; }
+            if (id === null || id === undefined) {
+                throw new base_1.RequiredError('id', 'Required parameter id was null or undefined when calling getCashDepositScheme.');
+            }
+            var localVarPath = "/v2/organizations/{id}/cash-deposit-scheme"
+                .replace("{" + "id" + "}", encodeURIComponent(String(id)));
+            var localVarUrlObj = globalImportUrl.parse(localVarPath, true);
+            var baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            var localVarRequestOptions = __assign({ method: 'GET' }, baseOptions, options);
+            var localVarHeaderParameter = {};
+            var localVarQueryParameter = {};
+            localVarUrlObj.query = __assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = __assign({}, localVarHeaderParameter, options.headers);
+            return {
+                url: globalImportUrl.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         getChildren: function (id, options) {
             if (options === void 0) { options = {}; }
             if (id === null || id === undefined) {
@@ -8662,6 +8702,15 @@ exports.OrganizationsApiFp = function (configuration) {
                 return axios.request(axiosRequestArgs);
             };
         },
+        getCashDepositScheme: function (id, options) {
+            var localVarAxiosArgs = exports.OrganizationsApiAxiosParamCreator(configuration).getCashDepositScheme(id, 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);
+            };
+        },
         getChildren: function (id, options) {
             var localVarAxiosArgs = exports.OrganizationsApiAxiosParamCreator(configuration).getChildren(id, options);
             return function (axios, basePath) {
@@ -8828,6 +8877,9 @@ exports.OrganizationsApiFactory = function (configuration, basePath, axios) {
         findOrganizationById: function (id, options) {
             return exports.OrganizationsApiFp(configuration).findOrganizationById(id, options)(axios, basePath);
         },
+        getCashDepositScheme: function (id, options) {
+            return exports.OrganizationsApiFp(configuration).getCashDepositScheme(id, options)(axios, basePath);
+        },
         getChildren: function (id, options) {
             return exports.OrganizationsApiFp(configuration).getChildren(id, options)(axios, basePath);
         },
@@ -8913,6 +8965,9 @@ var OrganizationsApi = (function (_super) {
     OrganizationsApi.prototype.findOrganizationById = function (id, options) {
         return exports.OrganizationsApiFp(this.configuration).findOrganizationById(id, options)(this.axios, this.basePath);
     };
+    OrganizationsApi.prototype.getCashDepositScheme = function (id, options) {
+        return exports.OrganizationsApiFp(this.configuration).getCashDepositScheme(id, options)(this.axios, this.basePath);
+    };
     OrganizationsApi.prototype.getChildren = function (id, options) {
         return exports.OrganizationsApiFp(this.configuration).getChildren(id, options)(this.axios, this.basePath);
     };