# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for 2026-07 Workflows API
  version: 1.0.0
extends: openapi/lightspeed-workflows-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 12
- target: $.paths['/workflows/custom_fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for an entity
      effect: read
      questions:
      - What custom fields are defined on sales or products in my store?
      - Which custom field definitions exist for a given entity type?
      instructions:
      - text: List the custom field definitions for entity type {entity}.
        slots:
          entity: query.entity
      - text: Show me every custom field defined on {entity} records.
        slots:
          entity: query.entity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows/custom_fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new custom field
      effect: write
      questions:
      - How do I add a new custom field to products or customers?
      - Can a new custom field be printed on the receipt?
      instructions:
      - text: Define a custom field named {name} titled {title} of type {type} on {entity}.
        slots:
          name: requestBody.name
          title: requestBody.title
          type: requestBody.type
          entity: requestBody.entity
      - text: 'Create a {type} custom field {name} with title {title} on {entity} and print it on receipts: {print_on_receipt}.'
        slots:
          type: requestBody.type
          name: requestBody.name
          title: requestBody.title
          entity: requestBody.entity
          print_on_receipt: requestBody.print_on_receipt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows/custom_fields/values'].get
  update:
    x-apievangelist-phrasing:
      intent: Get custom field values on a record
      effect: read
      questions:
      - What custom field values are stored on a specific sale or customer?
      - How do I read the custom data attached to one record?
      instructions:
      - text: Get the custom field values on {entity} {entity_id}.
        slots:
          entity: query.entity
          entity_id: query.entity_id
      - text: Show the stored custom data for {entity} record {entity_id}.
        slots:
          entity: query.entity
          entity_id: query.entity_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows/custom_fields/values'].post
  update:
    x-apievangelist-phrasing:
      intent: Set custom field values on a record
      effect: write
      questions:
      - How do I save custom field values onto a particular customer or sale?
      - Can I set several custom field values on one record at once?
      instructions:
      - text: Set custom field values {values} on {entity} {entity_id}.
        slots:
          values: requestBody.values
          entity: requestBody.entity
          entity_id: requestBody.entity_id
      - text: 'Write these custom values to {entity} record {entity_id}: {values}.'
        slots:
          entity: requestBody.entity
          entity_id: requestBody.entity_id
          values: requestBody.values
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows/custom_fields/{customFieldId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom field definition
      effect: write
      questions:
      - Can I rename the title of an existing custom field?
      - How do I hide a custom field from the UI or stop it printing on receipts?
      instructions:
      - text: Change the title of custom field {customFieldId} to {title}.
        slots:
          customFieldId: path.customFieldId
          title: requestBody.title
      - text: Set custom field {customFieldId} visible in the UI to {visible_in_ui}.
        slots:
          customFieldId: path.customFieldId
          visible_in_ui: requestBody.visible_in_ui
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows/custom_fields/{customFieldId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom field and its values
      effect: destructive
      questions:
      - What happens to stored values when I delete a custom field?
      - How do I remove a custom field definition I no longer need?
      instructions:
      - text: Delete custom field {customFieldId} and all its stored values.
        slots:
          customFieldId: path.customFieldId
      - text: Remove the custom field definition {customFieldId}.
        slots:
          customFieldId: path.customFieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows/remote_rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered remote rules
      effect: read
      questions:
      - Which remote rule URLs are registered on my retailer account?
      - How can I see the external rule endpoints my store calls out to?
      instructions:
      - text: List the remote rules registered for my retailer.
      - text: Show every remote rule URL currently registered.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows/remote_rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a remote rule URL
      effect: write
      questions:
      - How do I register my own service URL as a remote business rule?
      - Can I point the store at an external endpoint that evaluates rules?
      instructions:
      - text: Register a remote rule at URL {url}.
        slots:
          url: requestBody.url
      - text: Add {url} as a new remote rule endpoint for my retailer.
        slots:
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows/remote_rules/{remoteRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a remote rule
      effect: destructive
      questions:
      - How do I unregister a remote rule endpoint?
      - Can I delete a remote rule I registered by mistake?
      instructions:
      - text: Delete remote rule {remoteRuleId}.
        slots:
          remoteRuleId: path.remoteRuleId
      - text: Unregister the remote rule endpoint with ID {remoteRuleId}.
        slots:
          remoteRuleId: path.remoteRuleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List business rules
      effect: read
      questions:
      - Which business rules are wired to events in my store?
      - What event types currently trigger a remote rule?
      instructions:
      - text: List the business rules for my retailer.
      - text: Show which events are mapped to remote rules in business rules.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a remote rule to an event
      effect: write
      questions:
      - How do I make a remote rule fire on a specific event type?
      - Can I link an event like adding a product to my remote rule?
      instructions:
      - text: Create a business rule that calls remote rule {remote_rule_id} on event {event_type}.
        slots:
          remote_rule_id: requestBody.remote_rule_id
          event_type: requestBody.event_type
      - text: Trigger remote rule {remote_rule_id} whenever {event_type} happens.
        slots:
          remote_rule_id: requestBody.remote_rule_id
          event_type: requestBody.event_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows/rules/{ruleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a business rule
      effect: destructive
      questions:
      - How do I stop an event from triggering its business rule?
      - Can I delete a business rule without removing the remote rule endpoint?
      instructions:
      - text: Delete business rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Remove the event-to-remote-rule mapping {ruleId}.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-09-26'