# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Platform REST Sales Accounts API
  version: 1.0.0
extends: openapi/vendasta-sales-accounts-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: 10
- target: $.paths['/salesAccounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a partner's sales accounts
      effect: read
      questions:
      - Which business locations does my partner account have on record?
      - Can I look up a sales account by my own customer identifier?
      - How many sales accounts can I page through at once?
      instructions:
      - text: List the sales accounts for partner {partner}.
        slots:
          partner: query.filter[businessPartner.id]
      - text: Find the sales account for partner {partner} with customer identifier {customer}.
        slots:
          partner: query.filter[businessPartner.id]
          customer: query.filter[customerIdentifier]
      - text: Show {limit} sales accounts for partner {partner} sorted by {sort}.
        slots:
          limit: query.page[limit]
          partner: query.filter[businessPartner.id]
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/salesAccounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sales account for a new location
      effect: write
      questions:
      - How do I add a new business location as a sales account?
      - What fields are mandatory when creating a sales account, like name and country?
      instructions:
      - text: Create a sales account {data} for a new business location.
        slots:
          data: requestBody.data
      - text: Add a new location as a sales account under my partner with details {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/salesAccounts'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on the sales accounts list
      effect: read
      questions:
      - Which HTTP verbs does the sales accounts collection endpoint accept for CORS?
      - What does a preflight request to the salesAccounts collection return?
      instructions:
      - text: Send an OPTIONS preflight to the salesAccounts collection.
      - text: List the allowed methods on the sales accounts collection endpoint.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/salesAccounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one sales account
      effect: read
      questions:
      - What basic data is stored on a single sales account?
      - Can I limit which sales account fields come back?
      instructions:
      - text: Get sales account {id}.
        slots:
          id: path.id
      - text: Show only the fields {fields} of sales account {id}.
        slots:
          fields: query.fields[salesAccounts]
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/salesAccounts/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a sales account's details
      effect: write
      questions:
      - Can I change a business location's address without resending every field?
      - What happens to fields I leave out when updating a sales account?
      instructions:
      - text: Update sales account {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Change the name or address on sales account {id} to {data}.
        slots:
          id: path.id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/salesAccounts/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on a single sales account
      effect: read
      questions:
      - Which methods can a browser use against one sales account's URL?
      - Does a single sales account resource allow PATCH for cross-origin calls?
      instructions:
      - text: Run a CORS preflight against sales account {id}.
        slots:
          id: path.id
      - text: Show the permitted verbs for the sales account {id} resource.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/salesAccounts/{id}/relationships/customFields'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the custom fields reference of a sales account
      effect: read
      questions:
      - What is the ID of the custom field record linked to a sales account?
      - Can I get just the relationship pointer to a sales account's custom data?
      instructions:
      - text: Get the custom fields relationship ID for sales account {id}.
        slots:
          id: path.id
      - text: Return only the reference to the custom metadata of sales account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/salesAccounts/{id}/relationships/customFields'].options
  update:
    x-apievangelist-phrasing:
      intent: Check methods on the custom fields relationship
      effect: read
      questions:
      - Which verbs are allowed on the relationships/customFields link of a sales account?
      - What CORS headers come back for a sales account's custom field relationship path?
      instructions:
      - text: Preflight the relationships/customFields link on sales account {id}.
        slots:
          id: path.id
      - text: List allowed HTTP methods for the custom field relationship pointer of account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/salesAccounts/{id}/customFields'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sales account's custom field values
      effect: read
      questions:
      - What custom field values are set on a given sales account?
      - Can I read a location's custom attributes straight from the sales account path?
      instructions:
      - text: Show the custom field values on sales account {id}.
        slots:
          id: path.id
      - text: Get the custom attributes attached to sales account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/salesAccounts/{id}/customFields'].options
  update:
    x-apievangelist-phrasing:
      intent: Check methods on a sales account's custom fields
      effect: read
      questions:
      - What HTTP methods does the customFields values path under a sales account support?
      - Can a browser call a sales account's custom field values endpoint cross-origin?
      instructions:
      - text: Send an OPTIONS request to the customFields values path of sales account {id}.
        slots:
          id: path.id
      - text: Check which verbs the custom field values endpoint for account {id} allows.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'