API Evangelist conversational phrasing for DocuSign Rooms API - v2 Offices API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DocuSign Rooms API - v2 Offices API
  version: 1.0.0
extends: openapi/docusign-offices-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v2/accounts/{accountId}/offices'].get
  update:
    x-apievangelist-phrasing:
      intent: List offices
      effect: read
      questions:
      - Which offices are set up in my Rooms account?
      - Can I search offices by name or see only ones I can access?
      instructions:
      - text: List offices in account {account}.
        slots:
          account: path.accountId
      - text: Find offices in account {account} matching {search}.
        slots:
          account: path.accountId
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/offices'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an office
      effect: write
      questions:
      - How do I add a new office to a Rooms account?
      - What can I set when creating an office — region, address, time zone?
      instructions:
      - text: Create an office named {name} in account {account}.
        slots:
          name: requestBody.name
          account: path.accountId
      - text: Add office {name} in region {region} to account {account}.
        slots:
          name: requestBody.name
          region: requestBody.regionId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/offices/{officeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an office
      effect: read
      questions:
      - How do I get the details of one office?
      - Where can I see an office's address and phone number?
      instructions:
      - text: Get office {office} in account {account}.
        slots:
          office: path.officeId
          account: path.accountId
      - text: Show details for office {office} on account {account}.
        slots:
          office: path.officeId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/offices/{officeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an office
      effect: destructive
      questions:
      - Can I delete an office from my Rooms account?
      - Why might deleting an office fail?
      instructions:
      - text: Delete office {office} from account {account}.
        slots:
          office: path.officeId
          account: path.accountId
      - text: Remove the office {office} in account {account}.
        slots:
          office: path.officeId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/offices/{officeId}/reference_counts'].get
  update:
    x-apievangelist-phrasing:
      intent: Count objects that reference an office
      effect: read
      questions:
      - What is still referencing an office I want to delete?
      - How many objects of each type point at a given office?
      instructions:
      - text: Show reference counts for office {office} in account {account}.
        slots:
          office: path.officeId
          account: path.accountId
      - text: Check what objects still reference office {office} on account {account}.
        slots:
          office: path.officeId
          account: path.accountId
      method: generated
      generated: '2026-10-01'