@vrplatform/api 1.3.1-stage.1986 → 1.3.1-stage.1988

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/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "1.3.1-stage.1986",
6
+ "version": "1.3.1-stage.1988",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -834,6 +834,23 @@ export interface paths {
834
834
  patch?: never;
835
835
  trace?: never;
836
836
  };
837
+ "/listings/opening-balance": {
838
+ parameters: {
839
+ query?: never;
840
+ header?: never;
841
+ path?: never;
842
+ cookie?: never;
843
+ };
844
+ /** @description Get opening balances for listings */
845
+ get: operations["getListingsOpeningBalance"];
846
+ put?: never;
847
+ post?: never;
848
+ delete?: never;
849
+ options?: never;
850
+ head?: never;
851
+ patch?: never;
852
+ trace?: never;
853
+ };
837
854
  "/listings/ownership-periods": {
838
855
  parameters: {
839
856
  query?: never;
@@ -12320,6 +12337,145 @@ export interface operations {
12320
12337
  };
12321
12338
  };
12322
12339
  };
12340
+ getListingsOpeningBalance: {
12341
+ parameters: {
12342
+ query?: {
12343
+ status?: "active" | "inactive";
12344
+ connectionId?: string;
12345
+ /** @description comma separated listing ids */
12346
+ ids?: string;
12347
+ search?: string;
12348
+ contactId?: string;
12349
+ /** @description comma separated listing short refs */
12350
+ shortRefs?: string;
12351
+ activeOwnership?: boolean;
12352
+ activeRecurringFeePeriods?: string;
12353
+ /** @description Filter listings that have (true) or lack (false) opening balances */
12354
+ openingBalance?: boolean;
12355
+ /** @description Filter listings by setup issue code, "all" (all setup issues), or "any" (at least one setup issue) */
12356
+ issue?: "all" | "any" | "missingOwnershipOrDeactivation" | "missingFeesAndCommission" | "missingOpeningBalance";
12357
+ };
12358
+ header?: never;
12359
+ path?: never;
12360
+ cookie?: never;
12361
+ };
12362
+ requestBody?: never;
12363
+ responses: {
12364
+ /** @description Successful response */
12365
+ 200: {
12366
+ headers: {
12367
+ [name: string]: unknown;
12368
+ };
12369
+ content: {
12370
+ "application/json": {
12371
+ data: {
12372
+ /** Format: uuid */
12373
+ id: string;
12374
+ name: string;
12375
+ address?: {
12376
+ full?: string | null;
12377
+ line1?: string | null;
12378
+ line2?: string | null;
12379
+ city?: string | null;
12380
+ /** @description Deprecated, use stateCode instead */
12381
+ state?: string | null;
12382
+ postalCode?: string | null;
12383
+ stateCode?: string | null;
12384
+ countryCode?: string | null;
12385
+ } | null;
12386
+ openingBalance: {
12387
+ /** @description Value in cents (100 = 1€) */
12388
+ amount: number;
12389
+ /** @description Currency in ISO 4217 format, will be converted to lowercase */
12390
+ currency: string;
12391
+ updatedAt?: string | null;
12392
+ };
12393
+ }[];
12394
+ };
12395
+ };
12396
+ };
12397
+ /** @description Bad request */
12398
+ 400: {
12399
+ headers: {
12400
+ [name: string]: unknown;
12401
+ };
12402
+ content: {
12403
+ "application/json": {
12404
+ code: string;
12405
+ message: string;
12406
+ issues?: {
12407
+ message: string;
12408
+ }[];
12409
+ context?: unknown;
12410
+ };
12411
+ };
12412
+ };
12413
+ /** @description Unauthorized */
12414
+ 401: {
12415
+ headers: {
12416
+ [name: string]: unknown;
12417
+ };
12418
+ content: {
12419
+ "application/json": {
12420
+ code: string;
12421
+ message: string;
12422
+ issues?: {
12423
+ message: string;
12424
+ }[];
12425
+ context?: unknown;
12426
+ };
12427
+ };
12428
+ };
12429
+ /** @description Forbidden */
12430
+ 403: {
12431
+ headers: {
12432
+ [name: string]: unknown;
12433
+ };
12434
+ content: {
12435
+ "application/json": {
12436
+ code: string;
12437
+ message: string;
12438
+ issues?: {
12439
+ message: string;
12440
+ }[];
12441
+ context?: unknown;
12442
+ };
12443
+ };
12444
+ };
12445
+ /** @description Not found */
12446
+ 404: {
12447
+ headers: {
12448
+ [name: string]: unknown;
12449
+ };
12450
+ content: {
12451
+ "application/json": {
12452
+ code: string;
12453
+ message: string;
12454
+ issues?: {
12455
+ message: string;
12456
+ }[];
12457
+ context?: unknown;
12458
+ };
12459
+ };
12460
+ };
12461
+ /** @description Internal server error */
12462
+ 500: {
12463
+ headers: {
12464
+ [name: string]: unknown;
12465
+ };
12466
+ content: {
12467
+ "application/json": {
12468
+ code: string;
12469
+ message: string;
12470
+ issues?: {
12471
+ message: string;
12472
+ }[];
12473
+ context?: unknown;
12474
+ };
12475
+ };
12476
+ };
12477
+ };
12478
+ };
12323
12479
  getListingsOwnershipPeriods: {
12324
12480
  parameters: {
12325
12481
  query?: {