# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Square Vendors API
  version: 1.0.0
extends: openapi/square-vendors-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: 7
- target: $.paths['/v2/vendors/bulk-create'].post
  update:
    x-apievangelist-phrasing:
      intent: Add several suppliers at once
      effect: write
      questions:
      - How do I add a list of my suppliers as vendors in one call?
      - Can I create multiple vendor records in bulk?
      instructions:
      - text: 'Create these vendors: {vendors}.'
        slots:
          vendors: requestBody.vendors
      - text: Bulk add suppliers {vendors}.
        slots:
          vendors: requestBody.vendors
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/vendors/bulk-retrieve'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch several vendors by ID
      effect: read
      questions:
      - Can I look up multiple suppliers at once by their vendor IDs?
      - Is there a batch fetch for vendor records?
      instructions:
      - text: Get vendors {vendor_ids}.
        slots:
          vendor_ids: requestBody.vendor_ids
      - text: 'Retrieve these supplier records in one call: {vendor_ids}.'
        slots:
          vendor_ids: requestBody.vendor_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/vendors/bulk-update'].put
  update:
    x-apievangelist-phrasing:
      intent: Update several suppliers at once
      effect: write
      questions:
      - How do I update contact details for many vendors in one request?
      - Can I bulk edit existing supplier records?
      instructions:
      - text: Bulk update vendors {vendors}.
        slots:
          vendors: requestBody.vendors
      - text: 'Apply these changes to multiple suppliers: {vendors}.'
        slots:
          vendors: requestBody.vendors
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/vendors/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a supplier
      effect: write
      questions:
      - How do I add a single new supplier to my Square account?
      - What does it take to create one vendor record?
      instructions:
      - text: Create vendor {vendor}.
        slots:
          vendor: requestBody.vendor
      - text: 'Add a single supplier: {vendor}.'
        slots:
          vendor: requestBody.vendor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/vendors/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search suppliers
      effect: read
      questions:
      - How do I find a supplier by name or status?
      - Can I sort vendor search results?
      instructions:
      - text: Search vendors with filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Find suppliers matching {filter} sorted by {sort}.
        slots:
          filter: requestBody.filter
          sort: requestBody.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/vendors/{vendor_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a supplier
      effect: read
      questions:
      - What contact details do I have on file for a vendor?
      - How can I look up one supplier by its vendor ID?
      instructions:
      - text: Get vendor {vendor_id}.
        slots:
          vendor_id: path.vendor_id
      - text: Show supplier record {vendor_id}.
        slots:
          vendor_id: path.vendor_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/vendors/{vendor_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one supplier
      effect: write
      questions:
      - How do I edit the details of a single supplier?
      - Can I change one vendor's contacts without a bulk update?
      instructions:
      - text: 'Update vendor {vendor_id} with these supplier details: {vendor}.'
        slots:
          vendor_id: path.vendor_id
          vendor: requestBody.vendor
      - text: 'Save changes to one supplier record: {vendor}.'
        slots:
          vendor: requestBody.vendor
      method: generated
      generated: '2026-10-01'