@vrplatform/api 1.3.1-stage.5312 → 1.3.1-stage.5323

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.5312",
6
+ "version": "1.3.1-stage.5323",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -1826,7 +1826,7 @@ export interface paths {
1826
1826
  path?: never;
1827
1827
  cookie?: never;
1828
1828
  };
1829
- /** @description List booking channels for the icon management overview */
1829
+ /** @description List control-plane booking channels for the global icon management overview with page and limit pagination. Available to any authenticated user. */
1830
1830
  get: operations["getInternalBookingChannels"];
1831
1831
  put?: never;
1832
1832
  post?: never;
@@ -1845,7 +1845,7 @@ export interface paths {
1845
1845
  };
1846
1846
  get?: never;
1847
1847
  put?: never;
1848
- /** @description Generate icon candidates for many booking channels in one backend-owned bulk request */
1848
+ /** @description Generate icon candidates for many booking channels in one backend-owned bulk request. VRP-admin only. */
1849
1849
  post: operations["postInternalBookingChannelsBulkGenerateIconCandidates"];
1850
1850
  delete?: never;
1851
1851
  options?: never;
@@ -1862,7 +1862,7 @@ export interface paths {
1862
1862
  };
1863
1863
  get?: never;
1864
1864
  put?: never;
1865
- /** @description Copy the current selected icon or logo from one booking channel to many target booking channels */
1865
+ /** @description Copy the current selected icon or logo from one booking channel to many target booking channels. VRP-admin only. */
1866
1866
  post: operations["postInternalBookingChannelsBulkSetAssets"];
1867
1867
  delete?: never;
1868
1868
  options?: never;
@@ -1879,7 +1879,7 @@ export interface paths {
1879
1879
  };
1880
1880
  get?: never;
1881
1881
  put?: never;
1882
- /** @description Generate and persist booking channel icon candidates from uniqueRef */
1882
+ /** @description Generate and persist booking channel icon candidates from uniqueRef. VRP-admin only. */
1883
1883
  post: operations["postInternalBookingChannelsGenerateIconCandidates"];
1884
1884
  delete?: never;
1885
1885
  options?: never;
@@ -1894,10 +1894,10 @@ export interface paths {
1894
1894
  path?: never;
1895
1895
  cookie?: never;
1896
1896
  };
1897
- /** @description List icon candidates for a booking channel */
1897
+ /** @description List control-plane icon candidates for a booking channel with page and limit pagination. Available to any authenticated user. */
1898
1898
  get: operations["getInternalBookingChannelsByBookingChannelIdIconCandidates"];
1899
1899
  put?: never;
1900
- /** @description Upload or reference an icon asset, store it in Cloudflare Images, and create a manual booking channel icon candidate */
1900
+ /** @description Upload or reference an icon asset, store it in Cloudflare Images, and create a manual booking channel icon candidate. VRP-admin only. */
1901
1901
  post: operations["postInternalBookingChannelsByBookingChannelIdIconCandidates"];
1902
1902
  delete?: never;
1903
1903
  options?: never;
@@ -1913,10 +1913,10 @@ export interface paths {
1913
1913
  cookie?: never;
1914
1914
  };
1915
1915
  get?: never;
1916
- /** @description Update mutable booking channel icon candidate metadata */
1916
+ /** @description Update mutable booking channel icon candidate metadata. VRP-admin only. */
1917
1917
  put: operations["putInternalBookingChannelsByBookingChannelIdIconCandidatesByCandidateId"];
1918
1918
  post?: never;
1919
- /** @description Delete a booking channel icon candidate */
1919
+ /** @description Delete a booking channel icon candidate. VRP-admin only. */
1920
1920
  delete: operations["deleteInternalBookingChannelsByBookingChannelIdIconCandidatesByCandidateId"];
1921
1921
  options?: never;
1922
1922
  head?: never;
@@ -1931,7 +1931,7 @@ export interface paths {
1931
1931
  cookie?: never;
1932
1932
  };
1933
1933
  get?: never;
1934
- /** @description Set or clear the selected icon or logo candidate for a booking channel */
1934
+ /** @description Set or clear the global control-plane icon or logo selection for a booking channel. VRP-admin only. */
1935
1935
  put: operations["putInternalBookingChannelsByBookingChannelIdSelectedAsset"];
1936
1936
  post?: never;
1937
1937
  delete?: never;
@@ -1948,7 +1948,7 @@ export interface paths {
1948
1948
  cookie?: never;
1949
1949
  };
1950
1950
  get?: never;
1951
- /** @description Update the nullable color for a booking channel */
1951
+ /** @description Update the nullable color for a booking channel. VRP-admin only. */
1952
1952
  put: operations["putInternalBookingChannelsById"];
1953
1953
  post?: never;
1954
1954
  delete?: never;
@@ -1998,10 +1998,10 @@ export interface paths {
1998
1998
  path?: never;
1999
1999
  cookie?: never;
2000
2000
  };
2001
- /** @description List feature flags with team and user assignments. Omitted status returns testing and ready flags. Sorting defaults to createdAt desc. VRP-admin only. */
2001
+ /** @description List global control-plane feature flags with team and user assignments. Omitted status returns testing and ready flags. Sorting defaults to createdAt desc. VRP-admin only. */
2002
2002
  get: operations["getInternalFeatureFlags"];
2003
2003
  put?: never;
2004
- /** @description Create a feature flag. Team enablement and testers are managed via the teams and users sub-resources. VRP-admin only. */
2004
+ /** @description Create a global control-plane feature flag. Team enablement and testers are managed via the teams and users sub-resources. VRP-admin only. */
2005
2005
  post: operations["postInternalFeatureFlags"];
2006
2006
  delete?: never;
2007
2007
  options?: never;
@@ -2036,7 +2036,7 @@ export interface paths {
2036
2036
  };
2037
2037
  /** @description List team assignments for a feature flag. Status 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access. VRP-admin only. */
2038
2038
  get: operations["getInternalFeatureFlagsByIdTeams"];
2039
- /** @description Replace the set of teams a feature flag is enabled on. Status 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access. Teams served from another data region are rejected. VRP-admin only. */
2039
+ /** @description Replace the set of teams a feature flag is enabled on. Status 'all' enables the flag for every team member; 'partially' only for users approved on the flag; 'disabled' explicitly denies access. Teams may belong to any data region. VRP-admin only. */
2040
2040
  put: operations["putInternalFeatureFlagsByIdTeams"];
2041
2041
  post?: never;
2042
2042
  delete?: never;
@@ -2087,7 +2087,7 @@ export interface paths {
2087
2087
  path?: never;
2088
2088
  cookie?: never;
2089
2089
  };
2090
- /** @description List global issue-message overwrites with case-insensitive search across patterns and replacement messages. VRP-admin only. */
2090
+ /** @description List global control-plane issue-message overwrites with case-insensitive search across patterns and replacement messages. Uses page and limit pagination. Available to any authenticated user. */
2091
2091
  get: operations["getInternalMessageOverwrites"];
2092
2092
  put?: never;
2093
2093
  /** @description Create a global issue-message overwrite from a non-empty glob pattern and replacement message. VRP-admin only. */
@@ -5403,7 +5403,7 @@ export interface paths {
5403
5403
  get: operations["getTeams"];
5404
5404
  put?: never;
5405
5405
  /**
5406
- * @description Create team. The generic gateway forwards an explicit dataRegion to that regional cell; an omitted region uses the receiving cell. Partner provisioning requires a uniqueRef; if a team with that uniqueRef already exists for the partner the request fails with 409 — fetch the existing team with GET /teams/lookup. Retrying a provisioning request that failed before completing is safe. defaultCurrency must exist in the target region currency catalog; unsupported values return 400 before creation.
5406
+ * @description Create team. The generic gateway forwards an explicit dataRegion to that regional cell; an omitted region uses the receiving cell. Partner provisioning requires a uniqueRef. An exact repeat of a completed provision fails with 409 and context.existingTeamId identifies the existing team; changed retry payloads fail without it. Fetch that team with GET /teams/lookup instead of creating it again. Retrying a provisioning request that failed before completing is safe. defaultCurrency must exist in the target region currency catalog; unsupported values return 400 before creation.
5407
5407
  *
5408
5408
  * Required scope: teams:provision
5409
5409
  */
@@ -39811,7 +39811,11 @@ export interface operations {
39811
39811
  };
39812
39812
  getInternalBookingChannels: {
39813
39813
  parameters: {
39814
- query?: never;
39814
+ query?: {
39815
+ limit?: number;
39816
+ page?: number;
39817
+ offset?: number;
39818
+ };
39815
39819
  header?: never;
39816
39820
  path?: never;
39817
39821
  cookie?: never;
@@ -39841,6 +39845,15 @@ export interface operations {
39841
39845
  selectedBookingChannelIconCandidateId: string | null;
39842
39846
  selectedBookingChannelLogoCandidateId: string | null;
39843
39847
  }[];
39848
+ pagination: {
39849
+ /** @default 100 */
39850
+ limit: number;
39851
+ /** @default 1 */
39852
+ page: number;
39853
+ total: number;
39854
+ totalPage: number;
39855
+ nextPage?: number;
39856
+ };
39844
39857
  };
39845
39858
  };
39846
39859
  };
@@ -40898,7 +40911,11 @@ export interface operations {
40898
40911
  };
40899
40912
  getInternalBookingChannelsByBookingChannelIdIconCandidates: {
40900
40913
  parameters: {
40901
- query?: never;
40914
+ query?: {
40915
+ limit?: number;
40916
+ page?: number;
40917
+ offset?: number;
40918
+ };
40902
40919
  header?: never;
40903
40920
  path: {
40904
40921
  bookingChannelId: string;
@@ -40944,6 +40961,15 @@ export interface operations {
40944
40961
  */
40945
40962
  updatedAt: string;
40946
40963
  }[];
40964
+ pagination: {
40965
+ /** @default 100 */
40966
+ limit: number;
40967
+ /** @default 1 */
40968
+ page: number;
40969
+ total: number;
40970
+ totalPage: number;
40971
+ nextPage?: number;
40972
+ };
40947
40973
  };
40948
40974
  };
40949
40975
  };
@@ -95263,15 +95289,19 @@ export interface operations {
95263
95289
  query?: {
95264
95290
  limit?: number;
95265
95291
  page?: number;
95292
+ /** @description Comma-separated ownership period UUIDs. */
95266
95293
  periodIds?: string;
95267
95294
  /** @description Year in format YYYY */
95268
95295
  year?: number;
95296
+ /** @description Comma-separated listing UUIDs. */
95269
95297
  listingIds?: string;
95298
+ /** @description Comma-separated statement UUIDs. */
95270
95299
  statementIds?: string;
95271
95300
  /** @description Month string in format `YYYY-MM`. */
95272
95301
  month?: string;
95273
95302
  search?: string;
95274
95303
  status?: ("draft" | "inReview" | "published") | "all";
95304
+ /** @description Comma-separated owner UUIDs. */
95275
95305
  ownerIds?: string;
95276
95306
  listingCollectionIds?: string;
95277
95307
  recurringFeeIds?: string;
@@ -99305,15 +99335,19 @@ export interface operations {
99305
99335
  query?: {
99306
99336
  limit?: number;
99307
99337
  page?: number;
99338
+ /** @description Comma-separated ownership period UUIDs. */
99308
99339
  periodIds?: string;
99309
99340
  /** @description Year in format YYYY */
99310
99341
  year?: number;
99342
+ /** @description Comma-separated listing UUIDs. */
99311
99343
  listingIds?: string;
99344
+ /** @description Comma-separated statement UUIDs. */
99312
99345
  statementIds?: string;
99313
99346
  /** @description Month string in format `YYYY-MM`. */
99314
99347
  month?: string;
99315
99348
  search?: string;
99316
99349
  status?: ("draft" | "inReview" | "published") | "all";
99350
+ /** @description Comma-separated owner UUIDs. */
99317
99351
  ownerIds?: string;
99318
99352
  listingCollectionIds?: string;
99319
99353
  recurringFeeIds?: string;
@@ -99571,15 +99605,19 @@ export interface operations {
99571
99605
  query?: {
99572
99606
  limit?: number;
99573
99607
  page?: number;
99608
+ /** @description Comma-separated ownership period UUIDs. */
99574
99609
  periodIds?: string;
99575
99610
  /** @description Year in format YYYY */
99576
99611
  year?: number;
99612
+ /** @description Comma-separated listing UUIDs. */
99577
99613
  listingIds?: string;
99614
+ /** @description Comma-separated statement UUIDs. */
99578
99615
  statementIds?: string;
99579
99616
  /** @description Month string in format `YYYY-MM`. */
99580
99617
  month?: string;
99581
99618
  search?: string;
99582
99619
  status?: ("draft" | "inReview" | "published") | "all";
99620
+ /** @description Comma-separated owner UUIDs. */
99583
99621
  ownerIds?: string;
99584
99622
  listingCollectionIds?: string;
99585
99623
  recurringFeeIds?: string;
@@ -104529,9 +104567,9 @@ export interface operations {
104529
104567
  query: {
104530
104568
  /** @description Month string in format `YYYY-MM`. */
104531
104569
  month: string;
104532
- /** @description comma separated listings */
104570
+ /** @description Comma-separated listing UUIDs. */
104533
104571
  listingIds?: string;
104534
- /** @description comma separated owners */
104572
+ /** @description Comma-separated owner UUIDs. */
104535
104573
  ownerIds?: string;
104536
104574
  status?: ("draft" | "inReview" | "published") | "all";
104537
104575
  /** @description Currency in ISO 4217 format, will be converted to lowercase */