API Evangelist conversational phrasing for Vendasta Marketplace API V1 Endpoints Account API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Vendasta Marketplace API V1 Endpoints Account API
  version: 1.0.0
extends: openapi/vendasta-account-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: 14
- target: $.paths['/account/'].get
  update:
    x-apievangelist-phrasing:
      intent: List business accounts
      effect: read
      questions:
      - Which business accounts can my app see on Vendasta?
      - How do I page through every account using a cursor?
      instructions:
      - text: List all business accounts I have access to.
      - text: Show the next {page_size} accounts after cursor {cursor}.
        slots:
          page_size: query.page_size
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/account/{account_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a business account
      effect: read
      questions:
      - What basic details does a single business account record hold?
      - Can I look up one account when I have its account ID?
      instructions:
      - text: Get the basic profile of account {account_id}.
        slots:
          account_id: path.account_id
      - text: Fetch business account {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/account/{account_id}/richdata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account's hours, images and extended data
      effect: read
      questions:
      - Where can I find a business's hours of operation and images?
      - Is there extended rich data for an account beyond the basic profile?
      instructions:
      - text: Get hours of operation and images for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show the rich data for business {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/account/{account_id}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account's market and branding settings
      effect: read
      questions:
      - Which market is an account assigned to, and what partner branding applies?
      - Can I read the platform branding settings for a specific account?
      instructions:
      - text: Get the settings and market for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show the partner branding platform settings for {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/account/{account_id}/session-transfer'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a session transfer URL for an account
      effect: read
      questions:
      - How do I send a user straight into an account's Business App session from my app?
      - Can I generate a session transfer link for a business?
      instructions:
      - text: Get a session transfer URL for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Create a handoff link into Business App for {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/account/{account_id}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List the users on an account
      effect: read
      questions:
      - Who are the users that belong to a particular business account?
      - Can I see every user attached to one account?
      instructions:
      - text: List the users of account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show who has user access to business {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/account/{account_id}/addons'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's activated addons
      effect: read
      questions:
      - Which marketplace addons has a business activated?
      - What addons are currently turned on for an account?
      instructions:
      - text: List activated addons for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show which addons business {account_id} has activated.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/account/{account_id}/file-group/'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's file groups
      effect: read
      questions:
      - What file groups have been shared with a business so far?
      - Can I page through all the file collections on an account?
      instructions:
      - text: List file groups for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show {page_size} file groups of {account_id} starting at cursor {cursor}.
        slots:
          page_size: query.page_size
          account_id: path.account_id
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/account/{account_id}/file-group/'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a new group of files with a business
      effect: write
      questions:
      - How do I deliver a set of files to a business so they can download them in Business App?
      - Does creating a file group post an alert to the business's activity stream?
      instructions:
      - text: Create a file group titled {title} on account {account_id} with files {files}.
        slots:
          title: requestBody.title
          account_id: path.account_id
          files: requestBody.files
      - text: Share files {files} with business {account_id} under the title {title} and description {description}.
        slots:
          files: requestBody.files
          account_id: path.account_id
          title: requestBody.title
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/account/{account_id}/file-group/{file_group_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one file group
      effect: read
      questions:
      - Can I see the files inside one specific file group?
      - What title and files does an existing file group contain?
      instructions:
      - text: Get file group {file_group_id} on account {account_id}.
        slots:
          file_group_id: path.file_group_id
          account_id: path.account_id
      - text: Show the contents of file group {file_group_id} for {account_id}.
        slots:
          file_group_id: path.file_group_id
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/account/{account_id}/file-group/{file_group_id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the contents of a file group
      effect: write
      questions:
      - If I update a file group, do I need to resend the files already in it?
      - Can I swap out the title and file list of an existing file group?
      instructions:
      - text: Replace file group {file_group_id} on {account_id} with title {title} and files {files}.
        slots:
          file_group_id: path.file_group_id
          account_id: path.account_id
          title: requestBody.title
          files: requestBody.files
      - text: Overwrite the files in group {file_group_id} of account {account_id} with {files}, titled {title}.
        slots:
          file_group_id: path.file_group_id
          account_id: path.account_id
          files: requestBody.files
          title: requestBody.title
      method: generated
      generated: '2026-10-01'
- target: $.paths['/account/{account_id}/file-group/{file_group_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a file group
      effect: destructive
      questions:
      - Can I remove a file group I shared with a business by mistake?
      - What's the way to delete a file collection from an account?
      instructions:
      - text: Delete file group {file_group_id} from account {account_id}.
        slots:
          file_group_id: path.file_group_id
          account_id: path.account_id
      - text: Remove the shared files group {file_group_id} on {account_id}.
        slots:
          file_group_id: path.file_group_id
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/activation/resolve/'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve or reject a pending addon activation
      effect: write
      questions:
      - How do I approve an activation request that's waiting on my app?
      - Do I have to give a reason when I reject a pending activation?
      instructions:
      - text: Approve activation {activation_id} for business {business_id}.
        slots:
          activation_id: requestBody.activation_id
          business_id: requestBody.business_id
      - text: Resolve activation {activation_id} for {business_id} with approved {approved} and reason {rejection_reason}.
        slots:
          activation_id: requestBody.activation_id
          business_id: requestBody.business_id
          approved: requestBody.approved
          rejection_reason: requestBody.rejection_reason
      method: generated
      generated: '2026-10-01'
- target: $.paths['/activation/list-pending/'].get
  update:
    x-apievangelist-phrasing:
      intent: List pending activations awaiting a decision
      effect: read
      questions:
      - Which activations are still waiting for my approval?
      - Can I filter pending activations to a single addon?
      instructions:
      - text: List pending activations awaiting approval.
      - text: Show pending activations for addon {addon_id}, {page_size} at a time.
        slots:
          addon_id: query.addon_id
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'