@vrplatform/api 1.3.1-stage.2097 → 1.3.1-stage.2098

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.2097",
6
+ "version": "1.3.1-stage.2098",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -75,6 +75,40 @@ export interface paths {
75
75
  patch?: never;
76
76
  trace?: never;
77
77
  };
78
+ "/accounts/{id}/connect-bank-account": {
79
+ parameters: {
80
+ query?: never;
81
+ header?: never;
82
+ path?: never;
83
+ cookie?: never;
84
+ };
85
+ get?: never;
86
+ put?: never;
87
+ /** @description Connect a bank account to an account */
88
+ post: operations["postAccountsByIdConnectBankAccount"];
89
+ delete?: never;
90
+ options?: never;
91
+ head?: never;
92
+ patch?: never;
93
+ trace?: never;
94
+ };
95
+ "/accounts/{id}/disconnect-bank-account": {
96
+ parameters: {
97
+ query?: never;
98
+ header?: never;
99
+ path?: never;
100
+ cookie?: never;
101
+ };
102
+ get?: never;
103
+ put?: never;
104
+ /** @description Disconnect a bank account from an account */
105
+ post: operations["postAccountsByIdDisconnectBankAccount"];
106
+ delete?: never;
107
+ options?: never;
108
+ head?: never;
109
+ patch?: never;
110
+ trace?: never;
111
+ };
78
112
  "/accounts/{id}/recalculate-balances": {
79
113
  parameters: {
80
114
  query?: never;
@@ -3241,6 +3275,7 @@ export interface operations {
3241
3275
  connections: {
3242
3276
  id: string;
3243
3277
  name: string;
3278
+ startDate?: string | null;
3244
3279
  connection?: {
3245
3280
  id: string;
3246
3281
  appId: string;
@@ -3453,6 +3488,7 @@ export interface operations {
3453
3488
  connections: {
3454
3489
  id: string;
3455
3490
  name: string;
3491
+ startDate?: string | null;
3456
3492
  connection?: {
3457
3493
  id: string;
3458
3494
  appId: string;
@@ -3747,6 +3783,7 @@ export interface operations {
3747
3783
  connections: {
3748
3784
  id: string;
3749
3785
  name: string;
3786
+ startDate?: string | null;
3750
3787
  connection?: {
3751
3788
  id: string;
3752
3789
  appId: string;
@@ -3951,6 +3988,7 @@ export interface operations {
3951
3988
  connections: {
3952
3989
  id: string;
3953
3990
  name: string;
3991
+ startDate?: string | null;
3954
3992
  connection?: {
3955
3993
  id: string;
3956
3994
  appId: string;
@@ -4565,6 +4603,401 @@ export interface operations {
4565
4603
  };
4566
4604
  };
4567
4605
  };
4606
+ postAccountsByIdConnectBankAccount: {
4607
+ parameters: {
4608
+ query?: never;
4609
+ header?: never;
4610
+ path: {
4611
+ id: string;
4612
+ };
4613
+ cookie?: never;
4614
+ };
4615
+ requestBody?: {
4616
+ content: {
4617
+ "application/json": {
4618
+ /** Format: uuid */
4619
+ bankAccountId: string;
4620
+ startDate: string;
4621
+ /**
4622
+ * @default error
4623
+ * @enum {string}
4624
+ */
4625
+ onConflict?: "error" | "replace" | "replace-and-detach-history";
4626
+ };
4627
+ };
4628
+ };
4629
+ responses: {
4630
+ /** @description Successful response */
4631
+ 200: {
4632
+ headers: {
4633
+ [name: string]: unknown;
4634
+ };
4635
+ content: {
4636
+ "application/json": {
4637
+ name: string;
4638
+ /** @enum {string} */
4639
+ status?: "active" | "inactive";
4640
+ /** @enum {string} */
4641
+ type: "ledger" | "bank" | "recurringFee" | "nonPosting";
4642
+ uniqueRef?: string | null;
4643
+ id: string;
4644
+ offsetAccount?: {
4645
+ id: string;
4646
+ name: string;
4647
+ uniqueRef?: string | null;
4648
+ /** @enum {string} */
4649
+ status: "active" | "inactive";
4650
+ } | null;
4651
+ assignments: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "openingBalance" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "transfer_ownerPayout" | "transfer")[];
4652
+ category?: {
4653
+ id: string;
4654
+ name: string;
4655
+ classification?: ("asset" | "liability" | "revenue" | "expense") | null;
4656
+ } | null;
4657
+ categoryLock: {
4658
+ /** @constant */
4659
+ status: "locked";
4660
+ /** @constant */
4661
+ reason: "immutable";
4662
+ };
4663
+ issues: {
4664
+ /** @constant */
4665
+ code: "bankAccountLast4OutOfSync";
4666
+ /** @constant */
4667
+ severity: "warning";
4668
+ context: {
4669
+ accountLast4?: string | null;
4670
+ bankAccountLast4: string;
4671
+ bankAccountIds: string[];
4672
+ };
4673
+ }[];
4674
+ banking?: {
4675
+ category?: ("trust" | "operating" | "external") | null;
4676
+ type?: ("deposit" | "creditCard") | null;
4677
+ last4?: string | null;
4678
+ currency?: string | null;
4679
+ connections: {
4680
+ id: string;
4681
+ name: string;
4682
+ startDate?: string | null;
4683
+ connection?: {
4684
+ id: string;
4685
+ appId: string;
4686
+ name: string;
4687
+ /** @enum {string} */
4688
+ status: "active" | "inactive";
4689
+ isErrorState: boolean;
4690
+ icon?: string | null;
4691
+ } | null;
4692
+ status?: ("active" | "inactive") | null;
4693
+ currentSync?: {
4694
+ /** @enum {string} */
4695
+ status: "queued" | "started" | "completed" | "failed" | "canceled";
4696
+ createdAt: string;
4697
+ updatedAt: string;
4698
+ message?: string | null;
4699
+ } | null;
4700
+ source?: {
4701
+ /** Format: uuid */
4702
+ id: string;
4703
+ type: string;
4704
+ status?: ("active" | "inactive") | null;
4705
+ } | null;
4706
+ }[];
4707
+ bankRecords: {
4708
+ reconciled: number;
4709
+ unreconciled: number;
4710
+ total: number;
4711
+ latestCreatedAt?: string | null;
4712
+ };
4713
+ balance?: {
4714
+ openingDate?: string | null;
4715
+ opening: number;
4716
+ ending: number;
4717
+ } | null;
4718
+ } | null;
4719
+ };
4720
+ };
4721
+ };
4722
+ /** @description Bad request */
4723
+ 400: {
4724
+ headers: {
4725
+ [name: string]: unknown;
4726
+ };
4727
+ content: {
4728
+ "application/json": {
4729
+ code: string;
4730
+ message: string;
4731
+ issues?: {
4732
+ message: string;
4733
+ }[];
4734
+ context?: unknown;
4735
+ };
4736
+ };
4737
+ };
4738
+ /** @description Unauthorized */
4739
+ 401: {
4740
+ headers: {
4741
+ [name: string]: unknown;
4742
+ };
4743
+ content: {
4744
+ "application/json": {
4745
+ code: string;
4746
+ message: string;
4747
+ issues?: {
4748
+ message: string;
4749
+ }[];
4750
+ context?: unknown;
4751
+ };
4752
+ };
4753
+ };
4754
+ /** @description Forbidden */
4755
+ 403: {
4756
+ headers: {
4757
+ [name: string]: unknown;
4758
+ };
4759
+ content: {
4760
+ "application/json": {
4761
+ code: string;
4762
+ message: string;
4763
+ issues?: {
4764
+ message: string;
4765
+ }[];
4766
+ context?: unknown;
4767
+ };
4768
+ };
4769
+ };
4770
+ /** @description Not found */
4771
+ 404: {
4772
+ headers: {
4773
+ [name: string]: unknown;
4774
+ };
4775
+ content: {
4776
+ "application/json": {
4777
+ code: string;
4778
+ message: string;
4779
+ issues?: {
4780
+ message: string;
4781
+ }[];
4782
+ context?: unknown;
4783
+ };
4784
+ };
4785
+ };
4786
+ /** @description Internal server error */
4787
+ 500: {
4788
+ headers: {
4789
+ [name: string]: unknown;
4790
+ };
4791
+ content: {
4792
+ "application/json": {
4793
+ code: string;
4794
+ message: string;
4795
+ issues?: {
4796
+ message: string;
4797
+ }[];
4798
+ context?: unknown;
4799
+ };
4800
+ };
4801
+ };
4802
+ };
4803
+ };
4804
+ postAccountsByIdDisconnectBankAccount: {
4805
+ parameters: {
4806
+ query?: never;
4807
+ header?: never;
4808
+ path: {
4809
+ id: string;
4810
+ };
4811
+ cookie?: never;
4812
+ };
4813
+ requestBody?: {
4814
+ content: {
4815
+ "application/json": {
4816
+ /** Format: uuid */
4817
+ bankAccountId: string;
4818
+ /**
4819
+ * @default preserve-history
4820
+ * @enum {string}
4821
+ */
4822
+ mode?: "preserve-history" | "detach-history";
4823
+ };
4824
+ };
4825
+ };
4826
+ responses: {
4827
+ /** @description Successful response */
4828
+ 200: {
4829
+ headers: {
4830
+ [name: string]: unknown;
4831
+ };
4832
+ content: {
4833
+ "application/json": {
4834
+ name: string;
4835
+ /** @enum {string} */
4836
+ status?: "active" | "inactive";
4837
+ /** @enum {string} */
4838
+ type: "ledger" | "bank" | "recurringFee" | "nonPosting";
4839
+ uniqueRef?: string | null;
4840
+ id: string;
4841
+ offsetAccount?: {
4842
+ id: string;
4843
+ name: string;
4844
+ uniqueRef?: string | null;
4845
+ /** @enum {string} */
4846
+ status: "active" | "inactive";
4847
+ } | null;
4848
+ assignments: ("accountsPayable" | "accountsReceivable" | "cancellationRevenue" | "deferredRevenue" | "deposit_channelFee" | "deposit_coHostPayout" | "deposit_merchantFee" | "openingBalance" | "deposit_reserve" | "deposit_vat" | "dueToFromTrust" | "expense_markup" | "expense_reimbursement" | "expense_salesTax" | "transfer_ownerPayout" | "transfer")[];
4849
+ category?: {
4850
+ id: string;
4851
+ name: string;
4852
+ classification?: ("asset" | "liability" | "revenue" | "expense") | null;
4853
+ } | null;
4854
+ categoryLock: {
4855
+ /** @constant */
4856
+ status: "locked";
4857
+ /** @constant */
4858
+ reason: "immutable";
4859
+ };
4860
+ issues: {
4861
+ /** @constant */
4862
+ code: "bankAccountLast4OutOfSync";
4863
+ /** @constant */
4864
+ severity: "warning";
4865
+ context: {
4866
+ accountLast4?: string | null;
4867
+ bankAccountLast4: string;
4868
+ bankAccountIds: string[];
4869
+ };
4870
+ }[];
4871
+ banking?: {
4872
+ category?: ("trust" | "operating" | "external") | null;
4873
+ type?: ("deposit" | "creditCard") | null;
4874
+ last4?: string | null;
4875
+ currency?: string | null;
4876
+ connections: {
4877
+ id: string;
4878
+ name: string;
4879
+ startDate?: string | null;
4880
+ connection?: {
4881
+ id: string;
4882
+ appId: string;
4883
+ name: string;
4884
+ /** @enum {string} */
4885
+ status: "active" | "inactive";
4886
+ isErrorState: boolean;
4887
+ icon?: string | null;
4888
+ } | null;
4889
+ status?: ("active" | "inactive") | null;
4890
+ currentSync?: {
4891
+ /** @enum {string} */
4892
+ status: "queued" | "started" | "completed" | "failed" | "canceled";
4893
+ createdAt: string;
4894
+ updatedAt: string;
4895
+ message?: string | null;
4896
+ } | null;
4897
+ source?: {
4898
+ /** Format: uuid */
4899
+ id: string;
4900
+ type: string;
4901
+ status?: ("active" | "inactive") | null;
4902
+ } | null;
4903
+ }[];
4904
+ bankRecords: {
4905
+ reconciled: number;
4906
+ unreconciled: number;
4907
+ total: number;
4908
+ latestCreatedAt?: string | null;
4909
+ };
4910
+ balance?: {
4911
+ openingDate?: string | null;
4912
+ opening: number;
4913
+ ending: number;
4914
+ } | null;
4915
+ } | null;
4916
+ };
4917
+ };
4918
+ };
4919
+ /** @description Bad request */
4920
+ 400: {
4921
+ headers: {
4922
+ [name: string]: unknown;
4923
+ };
4924
+ content: {
4925
+ "application/json": {
4926
+ code: string;
4927
+ message: string;
4928
+ issues?: {
4929
+ message: string;
4930
+ }[];
4931
+ context?: unknown;
4932
+ };
4933
+ };
4934
+ };
4935
+ /** @description Unauthorized */
4936
+ 401: {
4937
+ headers: {
4938
+ [name: string]: unknown;
4939
+ };
4940
+ content: {
4941
+ "application/json": {
4942
+ code: string;
4943
+ message: string;
4944
+ issues?: {
4945
+ message: string;
4946
+ }[];
4947
+ context?: unknown;
4948
+ };
4949
+ };
4950
+ };
4951
+ /** @description Forbidden */
4952
+ 403: {
4953
+ headers: {
4954
+ [name: string]: unknown;
4955
+ };
4956
+ content: {
4957
+ "application/json": {
4958
+ code: string;
4959
+ message: string;
4960
+ issues?: {
4961
+ message: string;
4962
+ }[];
4963
+ context?: unknown;
4964
+ };
4965
+ };
4966
+ };
4967
+ /** @description Not found */
4968
+ 404: {
4969
+ headers: {
4970
+ [name: string]: unknown;
4971
+ };
4972
+ content: {
4973
+ "application/json": {
4974
+ code: string;
4975
+ message: string;
4976
+ issues?: {
4977
+ message: string;
4978
+ }[];
4979
+ context?: unknown;
4980
+ };
4981
+ };
4982
+ };
4983
+ /** @description Internal server error */
4984
+ 500: {
4985
+ headers: {
4986
+ [name: string]: unknown;
4987
+ };
4988
+ content: {
4989
+ "application/json": {
4990
+ code: string;
4991
+ message: string;
4992
+ issues?: {
4993
+ message: string;
4994
+ }[];
4995
+ context?: unknown;
4996
+ };
4997
+ };
4998
+ };
4999
+ };
5000
+ };
4568
5001
  postAccountsByIdRecalculateBalances: {
4569
5002
  parameters: {
4570
5003
  query?: never;
@@ -6107,6 +6540,7 @@ export interface operations {
6107
6540
  lastDigits?: string | null;
6108
6541
  status?: ("active" | "inactive") | null;
6109
6542
  accountId?: string | null;
6543
+ startDate?: string | null;
6110
6544
  }[];
6111
6545
  };
6112
6546
  };
@@ -6241,6 +6675,7 @@ export interface operations {
6241
6675
  lastDigits?: string | null;
6242
6676
  status?: ("active" | "inactive") | null;
6243
6677
  accountId?: string | null;
6678
+ startDate?: string | null;
6244
6679
  };
6245
6680
  };
6246
6681
  };
@@ -6263,6 +6698,7 @@ export interface operations {
6263
6698
  currency?: string | null;
6264
6699
  lastDigits?: string | null;
6265
6700
  status: ("active" | "inactive") | null;
6701
+ startDate?: string | null;
6266
6702
  account?: {
6267
6703
  id: string;
6268
6704
  name: string;