@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.
@@ -1825,7 +1825,7 @@ export interface paths {
1825
1825
  path?: never;
1826
1826
  cookie?: never;
1827
1827
  };
1828
- /** @description List booking channels for the icon management overview */
1828
+ /** @description List control-plane booking channels for the global icon management overview with page and limit pagination. Available to any authenticated user. */
1829
1829
  get: operations["getInternalBookingChannels"];
1830
1830
  put?: never;
1831
1831
  post?: never;
@@ -1844,7 +1844,7 @@ export interface paths {
1844
1844
  };
1845
1845
  get?: never;
1846
1846
  put?: never;
1847
- /** @description Generate icon candidates for many booking channels in one backend-owned bulk request */
1847
+ /** @description Generate icon candidates for many booking channels in one backend-owned bulk request. VRP-admin only. */
1848
1848
  post: operations["postInternalBookingChannelsBulkGenerateIconCandidates"];
1849
1849
  delete?: never;
1850
1850
  options?: never;
@@ -1861,7 +1861,7 @@ export interface paths {
1861
1861
  };
1862
1862
  get?: never;
1863
1863
  put?: never;
1864
- /** @description Copy the current selected icon or logo from one booking channel to many target booking channels */
1864
+ /** @description Copy the current selected icon or logo from one booking channel to many target booking channels. VRP-admin only. */
1865
1865
  post: operations["postInternalBookingChannelsBulkSetAssets"];
1866
1866
  delete?: never;
1867
1867
  options?: never;
@@ -1878,7 +1878,7 @@ export interface paths {
1878
1878
  };
1879
1879
  get?: never;
1880
1880
  put?: never;
1881
- /** @description Generate and persist booking channel icon candidates from uniqueRef */
1881
+ /** @description Generate and persist booking channel icon candidates from uniqueRef. VRP-admin only. */
1882
1882
  post: operations["postInternalBookingChannelsGenerateIconCandidates"];
1883
1883
  delete?: never;
1884
1884
  options?: never;
@@ -1893,10 +1893,10 @@ export interface paths {
1893
1893
  path?: never;
1894
1894
  cookie?: never;
1895
1895
  };
1896
- /** @description List icon candidates for a booking channel */
1896
+ /** @description List control-plane icon candidates for a booking channel with page and limit pagination. Available to any authenticated user. */
1897
1897
  get: operations["getInternalBookingChannelsByBookingChannelIdIconCandidates"];
1898
1898
  put?: never;
1899
- /** @description Upload or reference an icon asset, store it in Cloudflare Images, and create a manual booking channel icon candidate */
1899
+ /** @description Upload or reference an icon asset, store it in Cloudflare Images, and create a manual booking channel icon candidate. VRP-admin only. */
1900
1900
  post: operations["postInternalBookingChannelsByBookingChannelIdIconCandidates"];
1901
1901
  delete?: never;
1902
1902
  options?: never;
@@ -1912,10 +1912,10 @@ export interface paths {
1912
1912
  cookie?: never;
1913
1913
  };
1914
1914
  get?: never;
1915
- /** @description Update mutable booking channel icon candidate metadata */
1915
+ /** @description Update mutable booking channel icon candidate metadata. VRP-admin only. */
1916
1916
  put: operations["putInternalBookingChannelsByBookingChannelIdIconCandidatesByCandidateId"];
1917
1917
  post?: never;
1918
- /** @description Delete a booking channel icon candidate */
1918
+ /** @description Delete a booking channel icon candidate. VRP-admin only. */
1919
1919
  delete: operations["deleteInternalBookingChannelsByBookingChannelIdIconCandidatesByCandidateId"];
1920
1920
  options?: never;
1921
1921
  head?: never;
@@ -1930,7 +1930,7 @@ export interface paths {
1930
1930
  cookie?: never;
1931
1931
  };
1932
1932
  get?: never;
1933
- /** @description Set or clear the selected icon or logo candidate for a booking channel */
1933
+ /** @description Set or clear the global control-plane icon or logo selection for a booking channel. VRP-admin only. */
1934
1934
  put: operations["putInternalBookingChannelsByBookingChannelIdSelectedAsset"];
1935
1935
  post?: never;
1936
1936
  delete?: never;
@@ -1947,7 +1947,7 @@ export interface paths {
1947
1947
  cookie?: never;
1948
1948
  };
1949
1949
  get?: never;
1950
- /** @description Update the nullable color for a booking channel */
1950
+ /** @description Update the nullable color for a booking channel. VRP-admin only. */
1951
1951
  put: operations["putInternalBookingChannelsById"];
1952
1952
  post?: never;
1953
1953
  delete?: never;
@@ -1997,10 +1997,10 @@ export interface paths {
1997
1997
  path?: never;
1998
1998
  cookie?: never;
1999
1999
  };
2000
- /** @description List feature flags with team and user assignments. Omitted status returns testing and ready flags. Sorting defaults to createdAt desc. VRP-admin only. */
2000
+ /** @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. */
2001
2001
  get: operations["getInternalFeatureFlags"];
2002
2002
  put?: never;
2003
- /** @description Create a feature flag. Team enablement and testers are managed via the teams and users sub-resources. VRP-admin only. */
2003
+ /** @description Create a global control-plane feature flag. Team enablement and testers are managed via the teams and users sub-resources. VRP-admin only. */
2004
2004
  post: operations["postInternalFeatureFlags"];
2005
2005
  delete?: never;
2006
2006
  options?: never;
@@ -2035,7 +2035,7 @@ export interface paths {
2035
2035
  };
2036
2036
  /** @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. */
2037
2037
  get: operations["getInternalFeatureFlagsByIdTeams"];
2038
- /** @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. */
2038
+ /** @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. */
2039
2039
  put: operations["putInternalFeatureFlagsByIdTeams"];
2040
2040
  post?: never;
2041
2041
  delete?: never;
@@ -2086,7 +2086,7 @@ export interface paths {
2086
2086
  path?: never;
2087
2087
  cookie?: never;
2088
2088
  };
2089
- /** @description List global issue-message overwrites with case-insensitive search across patterns and replacement messages. VRP-admin only. */
2089
+ /** @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. */
2090
2090
  get: operations["getInternalMessageOverwrites"];
2091
2091
  put?: never;
2092
2092
  /** @description Create a global issue-message overwrite from a non-empty glob pattern and replacement message. VRP-admin only. */
@@ -5402,7 +5402,7 @@ export interface paths {
5402
5402
  get: operations["getTeams"];
5403
5403
  put?: never;
5404
5404
  /**
5405
- * @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.
5405
+ * @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.
5406
5406
  *
5407
5407
  * Required scope: teams:provision
5408
5408
  */
@@ -39810,7 +39810,11 @@ export interface operations {
39810
39810
  };
39811
39811
  getInternalBookingChannels: {
39812
39812
  parameters: {
39813
- query?: never;
39813
+ query?: {
39814
+ limit?: number;
39815
+ page?: number;
39816
+ offset?: number;
39817
+ };
39814
39818
  header?: never;
39815
39819
  path?: never;
39816
39820
  cookie?: never;
@@ -39840,6 +39844,15 @@ export interface operations {
39840
39844
  selectedBookingChannelIconCandidateId: string | null;
39841
39845
  selectedBookingChannelLogoCandidateId: string | null;
39842
39846
  }[];
39847
+ pagination: {
39848
+ /** @default 100 */
39849
+ limit: number;
39850
+ /** @default 1 */
39851
+ page: number;
39852
+ total: number;
39853
+ totalPage: number;
39854
+ nextPage?: number;
39855
+ };
39843
39856
  };
39844
39857
  };
39845
39858
  };
@@ -40897,7 +40910,11 @@ export interface operations {
40897
40910
  };
40898
40911
  getInternalBookingChannelsByBookingChannelIdIconCandidates: {
40899
40912
  parameters: {
40900
- query?: never;
40913
+ query?: {
40914
+ limit?: number;
40915
+ page?: number;
40916
+ offset?: number;
40917
+ };
40901
40918
  header?: never;
40902
40919
  path: {
40903
40920
  bookingChannelId: string;
@@ -40943,6 +40960,15 @@ export interface operations {
40943
40960
  */
40944
40961
  updatedAt: string;
40945
40962
  }[];
40963
+ pagination: {
40964
+ /** @default 100 */
40965
+ limit: number;
40966
+ /** @default 1 */
40967
+ page: number;
40968
+ total: number;
40969
+ totalPage: number;
40970
+ nextPage?: number;
40971
+ };
40946
40972
  };
40947
40973
  };
40948
40974
  };
@@ -95262,15 +95288,19 @@ export interface operations {
95262
95288
  query?: {
95263
95289
  limit?: number;
95264
95290
  page?: number;
95291
+ /** @description Comma-separated ownership period UUIDs. */
95265
95292
  periodIds?: string;
95266
95293
  /** @description Year in format YYYY */
95267
95294
  year?: number;
95295
+ /** @description Comma-separated listing UUIDs. */
95268
95296
  listingIds?: string;
95297
+ /** @description Comma-separated statement UUIDs. */
95269
95298
  statementIds?: string;
95270
95299
  /** @description Month string in format `YYYY-MM`. */
95271
95300
  month?: string;
95272
95301
  search?: string;
95273
95302
  status?: ("draft" | "inReview" | "published") | "all";
95303
+ /** @description Comma-separated owner UUIDs. */
95274
95304
  ownerIds?: string;
95275
95305
  listingCollectionIds?: string;
95276
95306
  recurringFeeIds?: string;
@@ -99304,15 +99334,19 @@ export interface operations {
99304
99334
  query?: {
99305
99335
  limit?: number;
99306
99336
  page?: number;
99337
+ /** @description Comma-separated ownership period UUIDs. */
99307
99338
  periodIds?: string;
99308
99339
  /** @description Year in format YYYY */
99309
99340
  year?: number;
99341
+ /** @description Comma-separated listing UUIDs. */
99310
99342
  listingIds?: string;
99343
+ /** @description Comma-separated statement UUIDs. */
99311
99344
  statementIds?: string;
99312
99345
  /** @description Month string in format `YYYY-MM`. */
99313
99346
  month?: string;
99314
99347
  search?: string;
99315
99348
  status?: ("draft" | "inReview" | "published") | "all";
99349
+ /** @description Comma-separated owner UUIDs. */
99316
99350
  ownerIds?: string;
99317
99351
  listingCollectionIds?: string;
99318
99352
  recurringFeeIds?: string;
@@ -99570,15 +99604,19 @@ export interface operations {
99570
99604
  query?: {
99571
99605
  limit?: number;
99572
99606
  page?: number;
99607
+ /** @description Comma-separated ownership period UUIDs. */
99573
99608
  periodIds?: string;
99574
99609
  /** @description Year in format YYYY */
99575
99610
  year?: number;
99611
+ /** @description Comma-separated listing UUIDs. */
99576
99612
  listingIds?: string;
99613
+ /** @description Comma-separated statement UUIDs. */
99577
99614
  statementIds?: string;
99578
99615
  /** @description Month string in format `YYYY-MM`. */
99579
99616
  month?: string;
99580
99617
  search?: string;
99581
99618
  status?: ("draft" | "inReview" | "published") | "all";
99619
+ /** @description Comma-separated owner UUIDs. */
99582
99620
  ownerIds?: string;
99583
99621
  listingCollectionIds?: string;
99584
99622
  recurringFeeIds?: string;
@@ -104528,9 +104566,9 @@ export interface operations {
104528
104566
  query: {
104529
104567
  /** @description Month string in format `YYYY-MM`. */
104530
104568
  month: string;
104531
- /** @description comma separated listings */
104569
+ /** @description Comma-separated listing UUIDs. */
104532
104570
  listingIds?: string;
104533
- /** @description comma separated owners */
104571
+ /** @description Comma-separated owner UUIDs. */
104534
104572
  ownerIds?: string;
104535
104573
  status?: ("draft" | "inReview" | "published") | "all";
104536
104574
  /** @description Currency in ISO 4217 format, will be converted to lowercase */