# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara AvaTax Firm Client Linkages API
  version: 1.0.0
extends: openapi/avalara-firmclientlinkages-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: 9
- target: $.paths['/api/v2/firmclientlinkages/{id}/approve'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve a firm's link request
      effect: write
      questions:
      - How does a client account accept a firm's request to link?
      - Can an account admin approve a pending firm linkage?
      instructions:
      - text: Approve firm-client linkage {id}.
        slots:
          id: path.id
      - text: Accept the firm's link request {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/firmclientlinkages/createandlinkclient'].post
  update:
    x-apievangelist-phrasing:
      intent: Create and link a new firm client account
      effect: write
      questions:
      - Can a firm create an account for a client it manages returns for?
      - How do firms set up a client who does not use AvaTax?
      instructions:
      - text: Create a new client account and link it to my firm.
      - text: Set up a firm-managed client account with a product subscription.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/firmclientlinkages'].get
  update:
    x-apievangelist-phrasing:
      intent: List firm-client linkages
      effect: read
      questions:
      - Which firms or clients is my account linked to?
      - Can I see all pending and approved linkages?
      instructions:
      - text: List my firm-client linkages.
      - text: Show every firm and client link on my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/firmclientlinkages'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a link to an existing client
      effect: write
      questions:
      - How does a firm ask to link with an existing client account?
      - Can a firm user request access to a client's account?
      instructions:
      - text: Request a linkage between my firm and an existing client account.
      - text: Send a firm-client link request to a client.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/firmclientlinkages/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one firm-client linkage
      effect: read
      questions:
      - What is the status of a specific firm-client linkage?
      - Can I look up one linkage by its ID?
      instructions:
      - text: Get firm-client linkage {id}.
        slots:
          id: path.id
      - text: Show the status of linkage {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/firmclientlinkages/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a firm-client linkage
      effect: destructive
      questions:
      - How does a firm remove a link to a client entirely?
      - Can a linkage be marked deleted?
      instructions:
      - text: Delete firm-client linkage {id}.
        slots:
          id: path.id
      - text: Mark linkage {id} as deleted.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/firmclientlinkages/{id}/reject'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject a firm's link request
      effect: write
      questions:
      - How does a client decline a firm's link request?
      - Can an account admin turn down a pending firm linkage?
      instructions:
      - text: Reject firm-client linkage request {id}.
        slots:
          id: path.id
      - text: Decline the firm's pending link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/firmclientlinkages/{id}/reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a firm's link request
      effect: write
      questions:
      - Can a firm admin restart a linkage request it created earlier?
      - How do I reset a link request that was rejected?
      instructions:
      - text: Reset firm-client linkage {id}.
        slots:
          id: path.id
      - text: Restart the link request {id} from my firm.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/firmclientlinkages/{id}/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke an approved firm link
      effect: destructive
      questions:
      - How does a client cut off a firm it previously approved?
      - Can I withdraw a firm's access after approving the link?
      instructions:
      - text: Revoke approved firm-client linkage {id}.
        slots:
          id: path.id
      - text: Withdraw the firm's access granted by linkage {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'