# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lytics Account API
  version: 1.0.0
extends: openapi/lytics-account-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/api/account/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one account's details
      effect: read
      questions:
      - Can I look up a single Lytics account by its id?
      - What details come back when I fetch one account?
      instructions:
      - text: Show me the details of account {id}.
        slots:
          id: path.id
      - text: Fetch account {id} so I can check its settings.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or update an account
      effect: write
      questions:
      - Can I change the name of an existing account?
      - How do I update fields on an account I already have?
      instructions:
      - text: Rename account {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update the fields on account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account'].get
  update:
    x-apievangelist-phrasing:
      intent: List all accounts I can access
      effect: read
      questions:
      - Which accounts does my API token have access to?
      - Can I see every account, including child accounts, in one list?
      instructions:
      - text: List all my accounts.
      - text: Show every account this token can reach.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a child account
      effect: write
      questions:
      - Can I create a child account under my parent account?
      - What do I need to supply to set up a new sub-account for a domain?
      instructions:
      - text: Create a child account named {name} for domain {domain}.
        slots:
          name: requestBody.name
          domain: requestBody.domain
      - text: Set up a new child account called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/account'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a child account with full profile
      effect: write
      questions:
      - Can I set a timezone, contact email and packages when creating a child account?
      - What fields can a new child account carry besides its name and domain?
      instructions:
      - text: Create child account {name} on domain {domain} in timezone {timezone}.
        slots:
          name: requestBody.name
          domain: requestBody.domain
          timezone: requestBody.timezone
      - text: Open a child account named {name} with contact email {email} and packages {packages}.
        slots:
          name: requestBody.name
          email: requestBody.email
          packages: requestBody.packages
      method: generated
      generated: '2026-10-02'
- target: $.paths['/account/setup/jobalerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn job failure email alerts on or off
      effect: write
      questions:
      - Can I get an email whenever an import or export job fails?
      - How do I stop the failed-job alert emails for my account?
      instructions:
      - text: Set failed import/export job email alerts to {enable}.
        slots:
          enable: query.enable
      - text: Turn job failure alerts {enable} for account {account_id}.
        slots:
          enable: query.enable
          account_id: query.account_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/account/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account with its user roles
      effect: read
      questions:
      - Can I fetch an account and include the roles users hold on it?
      - Where do I see an account's record on the newer account endpoint?
      instructions:
      - text: Get account {id} including roles {roles}.
        slots:
          id: path.id
          roles: query.roles
      - text: Look up the account record for {id} on the current account endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/account/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an account's settings, tags or billing
      effect: write
      questions:
      - Can I add tags or change settings on an existing account?
      - Is it possible to move an account to a different billing organization?
      instructions:
      - text: Change the timezone of account {id} to {timezone}.
        slots:
          id: path.id
          timezone: requestBody.timezone
      - text: Add tags {tags} to account {id} and remove tags {tags_delete}.
        slots:
          id: path.id
          tags: requestBody.tags
          tags_delete: requestBody.tags_delete
      - text: Assign account {id} to billing organization {billing_organization_id}.
        slots:
          id: path.id
          billing_organization_id: requestBody.billing_organization_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/register'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a brand-new top-level account
      effect: write
      questions:
      - How do I register a new standalone account rather than a child of mine?
      - Can I choose features, login methods and data retention at registration?
      instructions:
      - text: Register a new account named {name} for domain {domain} with admin email {email}.
        slots:
          name: requestBody.name
          domain: requestBody.domain
          email: requestBody.email
      - text: Register account {name} under organization {organization_id} with features {features}.
        slots:
          name: requestBody.name
          organization_id: requestBody.organization_id
          features: requestBody.features
      method: generated
      generated: '2026-10-02'