@vrplatform/api 1.3.1-stage.4758 → 1.3.1-stage.4767
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.
|
@@ -2153,7 +2153,12 @@ export interface paths {
|
|
|
2153
2153
|
* Required scope: self:read
|
|
2154
2154
|
*/
|
|
2155
2155
|
get: operations["getMe"];
|
|
2156
|
-
|
|
2156
|
+
/**
|
|
2157
|
+
* @description Update the authenticated user's first and/or last name. Values are trimmed, persisted synchronously, and returned in the same user shape as GET /me.
|
|
2158
|
+
*
|
|
2159
|
+
* Required scope: self:write
|
|
2160
|
+
*/
|
|
2161
|
+
put: operations["updateMeProfile"];
|
|
2157
2162
|
post?: never;
|
|
2158
2163
|
delete?: never;
|
|
2159
2164
|
options?: never;
|
|
@@ -8284,7 +8289,7 @@ export interface operations {
|
|
|
8284
8289
|
hint: string | null;
|
|
8285
8290
|
role: string | null;
|
|
8286
8291
|
scope: string | null;
|
|
8287
|
-
scopes: ("self:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:delete" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:pay" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "transaction-mappings:read" | "transaction-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:pay" | "statements:export" | "statement-layouts:read" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
|
|
8292
|
+
scopes: ("self:read" | "self:write" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:delete" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:pay" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "transaction-mappings:read" | "transaction-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:pay" | "statements:export" | "statement-layouts:read" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
|
|
8288
8293
|
}[];
|
|
8289
8294
|
pagination: {
|
|
8290
8295
|
/** @default 100 */
|
|
@@ -8470,7 +8475,7 @@ export interface operations {
|
|
|
8470
8475
|
hint: string | null;
|
|
8471
8476
|
role: string | null;
|
|
8472
8477
|
scope: string | null;
|
|
8473
|
-
scopes: ("self:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:delete" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:pay" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "transaction-mappings:read" | "transaction-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:pay" | "statements:export" | "statement-layouts:read" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
|
|
8478
|
+
scopes: ("self:read" | "self:write" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:delete" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:pay" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "transaction-mappings:read" | "transaction-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:pay" | "statements:export" | "statement-layouts:read" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
|
|
8474
8479
|
apiToken: string;
|
|
8475
8480
|
};
|
|
8476
8481
|
};
|
|
@@ -8640,7 +8645,7 @@ export interface operations {
|
|
|
8640
8645
|
hint: string | null;
|
|
8641
8646
|
role: string | null;
|
|
8642
8647
|
scope: string | null;
|
|
8643
|
-
scopes: ("self:read" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:delete" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:pay" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "transaction-mappings:read" | "transaction-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:pay" | "statements:export" | "statement-layouts:read" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
|
|
8648
|
+
scopes: ("self:read" | "self:write" | "partner:read" | "teams:read" | "teams:provision" | "teams:write" | "teams:delete" | "teams:initialize" | "embedded-sessions:issue" | "team-members:read" | "team-members:manage" | "partner-users:read" | "partner-users:manage" | "partner-memberships:manage" | "team-settings:read" | "team-settings:write" | "team-onboarding:read" | "team-onboarding:write" | "team-issues:read" | "books:close" | "listings:read" | "listings:write" | "listings:delete" | "listings:export" | "contacts:read" | "contacts:write" | "contacts:delete" | "contacts:export" | "ownerships:read" | "ownerships:write" | "ownerships:delete" | "reservations:read" | "reservations:write" | "reservations:delete" | "reservations:export" | "reservations:post-journals" | "transactions:read" | "transactions:write" | "transactions:delete" | "transactions:export" | "transactions:post-journals" | "transactions:pay" | "accounts:read" | "accounts:write" | "accounts:delete" | "accounts:export" | "accounts:recalculate" | "tax-rates:read" | "tax-rates:write" | "tax-rates:delete" | "reservation-mappings:read" | "reservation-mappings:write" | "transaction-mappings:read" | "transaction-mappings:write" | "statements:read" | "statements:write" | "statements:delete" | "statements:publish" | "statements:pay" | "statements:export" | "statement-layouts:read" | "reports:read" | "reports:export" | "metrics:read" | "bank-accounts:read" | "bank-accounts:write" | "bank-connections:manage" | "bank-records:read" | "bank-records:write" | "bank-records:delete" | "bank-records:export" | "bank-rules:read" | "bank-rules:write" | "bank-rules:delete" | "bank-rules:execute" | "webhooks:read" | "webhooks:manage" | "webhooks:replay")[];
|
|
8644
8649
|
apiToken: string;
|
|
8645
8650
|
};
|
|
8646
8651
|
};
|
|
@@ -38642,6 +38647,183 @@ export interface operations {
|
|
|
38642
38647
|
};
|
|
38643
38648
|
};
|
|
38644
38649
|
};
|
|
38650
|
+
updateMeProfile: {
|
|
38651
|
+
parameters: {
|
|
38652
|
+
query?: never;
|
|
38653
|
+
header?: never;
|
|
38654
|
+
path?: never;
|
|
38655
|
+
cookie?: never;
|
|
38656
|
+
};
|
|
38657
|
+
requestBody?: {
|
|
38658
|
+
content: {
|
|
38659
|
+
"application/json": {
|
|
38660
|
+
firstName?: string;
|
|
38661
|
+
lastName?: string;
|
|
38662
|
+
};
|
|
38663
|
+
};
|
|
38664
|
+
};
|
|
38665
|
+
responses: {
|
|
38666
|
+
/** @description Successful response */
|
|
38667
|
+
200: {
|
|
38668
|
+
headers: {
|
|
38669
|
+
[name: string]: unknown;
|
|
38670
|
+
};
|
|
38671
|
+
content: {
|
|
38672
|
+
"application/json": {
|
|
38673
|
+
/** Format: uuid */
|
|
38674
|
+
id: string;
|
|
38675
|
+
/** @enum {string} */
|
|
38676
|
+
type: "admin" | "user" | "owner";
|
|
38677
|
+
firstName?: string;
|
|
38678
|
+
lastName?: string;
|
|
38679
|
+
email: string | null;
|
|
38680
|
+
secondaryEmails: string[];
|
|
38681
|
+
phone?: string;
|
|
38682
|
+
/** Format: uuid */
|
|
38683
|
+
partnerId?: string;
|
|
38684
|
+
/**
|
|
38685
|
+
* Format: date-time
|
|
38686
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
38687
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
38688
|
+
*/
|
|
38689
|
+
createdAt: string;
|
|
38690
|
+
};
|
|
38691
|
+
};
|
|
38692
|
+
};
|
|
38693
|
+
/** @description Bad request */
|
|
38694
|
+
400: {
|
|
38695
|
+
headers: {
|
|
38696
|
+
[name: string]: unknown;
|
|
38697
|
+
};
|
|
38698
|
+
content: {
|
|
38699
|
+
"application/json": {
|
|
38700
|
+
code: string;
|
|
38701
|
+
message: string;
|
|
38702
|
+
links?: {
|
|
38703
|
+
docs: string;
|
|
38704
|
+
schema: string;
|
|
38705
|
+
};
|
|
38706
|
+
issues?: {
|
|
38707
|
+
message: string;
|
|
38708
|
+
path?: (string | number)[];
|
|
38709
|
+
schema?: string;
|
|
38710
|
+
}[];
|
|
38711
|
+
context?: unknown;
|
|
38712
|
+
};
|
|
38713
|
+
};
|
|
38714
|
+
};
|
|
38715
|
+
/** @description Unauthorized */
|
|
38716
|
+
401: {
|
|
38717
|
+
headers: {
|
|
38718
|
+
[name: string]: unknown;
|
|
38719
|
+
};
|
|
38720
|
+
content: {
|
|
38721
|
+
"application/json": {
|
|
38722
|
+
code: string;
|
|
38723
|
+
message: string;
|
|
38724
|
+
links?: {
|
|
38725
|
+
docs: string;
|
|
38726
|
+
schema: string;
|
|
38727
|
+
};
|
|
38728
|
+
issues?: {
|
|
38729
|
+
message: string;
|
|
38730
|
+
path?: (string | number)[];
|
|
38731
|
+
schema?: string;
|
|
38732
|
+
}[];
|
|
38733
|
+
context?: unknown;
|
|
38734
|
+
};
|
|
38735
|
+
};
|
|
38736
|
+
};
|
|
38737
|
+
/** @description Forbidden */
|
|
38738
|
+
403: {
|
|
38739
|
+
headers: {
|
|
38740
|
+
[name: string]: unknown;
|
|
38741
|
+
};
|
|
38742
|
+
content: {
|
|
38743
|
+
"application/json": {
|
|
38744
|
+
code: string;
|
|
38745
|
+
message: string;
|
|
38746
|
+
links?: {
|
|
38747
|
+
docs: string;
|
|
38748
|
+
schema: string;
|
|
38749
|
+
};
|
|
38750
|
+
issues?: {
|
|
38751
|
+
message: string;
|
|
38752
|
+
path?: (string | number)[];
|
|
38753
|
+
schema?: string;
|
|
38754
|
+
}[];
|
|
38755
|
+
context?: unknown;
|
|
38756
|
+
};
|
|
38757
|
+
};
|
|
38758
|
+
};
|
|
38759
|
+
/** @description Not found */
|
|
38760
|
+
404: {
|
|
38761
|
+
headers: {
|
|
38762
|
+
[name: string]: unknown;
|
|
38763
|
+
};
|
|
38764
|
+
content: {
|
|
38765
|
+
"application/json": {
|
|
38766
|
+
code: string;
|
|
38767
|
+
message: string;
|
|
38768
|
+
links?: {
|
|
38769
|
+
docs: string;
|
|
38770
|
+
schema: string;
|
|
38771
|
+
};
|
|
38772
|
+
issues?: {
|
|
38773
|
+
message: string;
|
|
38774
|
+
path?: (string | number)[];
|
|
38775
|
+
schema?: string;
|
|
38776
|
+
}[];
|
|
38777
|
+
context?: unknown;
|
|
38778
|
+
};
|
|
38779
|
+
};
|
|
38780
|
+
};
|
|
38781
|
+
/** @description Internal server error */
|
|
38782
|
+
500: {
|
|
38783
|
+
headers: {
|
|
38784
|
+
[name: string]: unknown;
|
|
38785
|
+
};
|
|
38786
|
+
content: {
|
|
38787
|
+
"application/json": {
|
|
38788
|
+
code: string;
|
|
38789
|
+
message: string;
|
|
38790
|
+
links?: {
|
|
38791
|
+
docs: string;
|
|
38792
|
+
schema: string;
|
|
38793
|
+
};
|
|
38794
|
+
issues?: {
|
|
38795
|
+
message: string;
|
|
38796
|
+
path?: (string | number)[];
|
|
38797
|
+
schema?: string;
|
|
38798
|
+
}[];
|
|
38799
|
+
context?: unknown;
|
|
38800
|
+
};
|
|
38801
|
+
};
|
|
38802
|
+
};
|
|
38803
|
+
/** @description Service unavailable */
|
|
38804
|
+
503: {
|
|
38805
|
+
headers: {
|
|
38806
|
+
[name: string]: unknown;
|
|
38807
|
+
};
|
|
38808
|
+
content: {
|
|
38809
|
+
"application/json": {
|
|
38810
|
+
code: string;
|
|
38811
|
+
message: string;
|
|
38812
|
+
links?: {
|
|
38813
|
+
docs: string;
|
|
38814
|
+
schema: string;
|
|
38815
|
+
};
|
|
38816
|
+
issues?: {
|
|
38817
|
+
message: string;
|
|
38818
|
+
path?: (string | number)[];
|
|
38819
|
+
schema?: string;
|
|
38820
|
+
}[];
|
|
38821
|
+
context?: unknown;
|
|
38822
|
+
};
|
|
38823
|
+
};
|
|
38824
|
+
};
|
|
38825
|
+
};
|
|
38826
|
+
};
|
|
38645
38827
|
updateMeNotifications: {
|
|
38646
38828
|
parameters: {
|
|
38647
38829
|
query?: never;
|