@vrplatform/api 1.3.1-stage.4584 → 1.3.1-stage.4597

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.
@@ -3800,7 +3800,7 @@ export interface paths {
3800
3800
  get: operations["getStatements"];
3801
3801
  put?: never;
3802
3802
  /**
3803
- * @description Create an owner statement for an ownership period and month. Freezes the statement layout, and creating with a finalized status (inReview or published) attaches the period journal entries to the statement, locking them against further changes. Statements with blocking issues cannot be created in a non-draft status, and publishing out of month order is rejected. Supports dryRun. See https://docs.vrplatform.app/guides/build/statements.
3803
+ * @description Create an owner statement for an ownership period and month. Freezes the statement layout, and creating with a finalized status (inReview or published) attaches the period journal entries to the statement, locking them against further changes. Statements with blocking issues cannot be created in a non-draft status, and publishing out of month order is rejected. Exactly one listingPeriodIds entry is required. Re-creating an existing statement regenerates it, but a published statement can never be moved away from published this way — that returns 409; use the update endpoint for status transitions. Supports dryRun. See https://docs.vrplatform.app/guides/build/statements.
3804
3804
  *
3805
3805
  * Required scope: statements:write
3806
3806
  */
@@ -4106,7 +4106,7 @@ export interface paths {
4106
4106
  */
4107
4107
  get: operations["getStatementsById"];
4108
4108
  /**
4109
- * @description Update an owner statement status (draft, inReview, published). Moving to a finalized status attaches the period journal entries to the statement and locks writes that reference the same ownership period; moving back to draft detaches them again. Transitions are rejected when the statement has blocking issues, when a later statement for the period is already finalized, or when a prior month is still unfinalized. Publishing can optionally email owners via emailDelivery. Supports dryRun. See https://docs.vrplatform.app/guides/build/statements#status-transitions.
4109
+ * @description Update an owner statement status (draft, inReview, published). Moving to a finalized status attaches the period journal entries to the statement and locks writes that reference the same ownership period; moving back to draft detaches them again. Transitions are rejected when the statement has blocking issues, when a later statement for the period is already finalized, or when a prior month is still unfinalized. For scoped API credentials, both publishing and moving a published statement away from published require the statements:publish scope. Publishing can optionally email owners via emailDelivery. Supports dryRun. See https://docs.vrplatform.app/guides/build/statements#status-transitions.
4110
4110
  *
4111
4111
  * Required scope: statements:write
4112
4112
  */
@@ -4548,7 +4548,7 @@ export interface paths {
4548
4548
  get: operations["getTeams"];
4549
4549
  put?: never;
4550
4550
  /**
4551
- * @description Create team
4551
+ * @description Create team. 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.
4552
4552
  *
4553
4553
  * Required scope: teams:provision
4554
4554
  */