# 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 Subscription Assignments API
  version: 1.0.0
extends: openapi/vendasta-subscription-assignments-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: 8
- target: $.paths['/subscriptionAssignments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a location's subscription assignments
      effect: read
      questions:
      - Which product subscriptions are assigned to a business location?
      - Do multi-activatable products show up as separate subscription records?
      instructions:
      - text: List subscription assignments for business location {location}.
        slots:
          location: query.filter[businessLocationId]
      - text: Show every product subscription active at location {location}.
        slots:
          location: query.filter[businessLocationId]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptionAssignments'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on subscription assignments
      effect: read
      questions:
      - Which HTTP verbs does the subscriptionAssignments collection allow for browsers?
      - What does a CORS preflight to the subscription assignments list return?
      instructions:
      - text: Send an OPTIONS preflight to subscriptionAssignments for location {location}.
        slots:
          location: query.filter[businessLocationId]
      - text: List the permitted verbs on the subscription assignments collection.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptionAssignments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one subscription assignment
      effect: read
      questions:
      - What are the details of a single subscription assignment?
      - Can I look up a subscription assignment by its ID?
      instructions:
      - text: Get subscription assignment {id}.
        slots:
          id: path.id
      - text: Show the details of assignment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptionAssignments/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check methods on one subscription assignment
      effect: read
      questions:
      - Which verbs can a browser use on a single subscription assignment URL?
      - Does one subscription assignment resource respond to CORS preflights?
      instructions:
      - text: Run a CORS preflight on subscription assignment {id}.
        slots:
          id: path.id
      - text: Show allowed HTTP methods for the assignment {id} resource.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptionAssignments/{id}/actions/requestCancellation'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a product subscription assignment
      effect: destructive
      questions:
      - How do I cancel a customer's product subscription?
      - Does cancelling stop the product immediately or at the anniversary date?
      - Can I record a reason and comments when cancelling a subscription?
      instructions:
      - text: Cancel subscription assignment {id}.
        slots:
          id: path.id
      - text: Cancel subscription {id} because {reason}, noting {comments}.
        slots:
          id: path.id
          reason: requestBody.reason
          comments: requestBody.comments
      - text: Cancel assignment {id} with deactivation type {type}.
        slots:
          id: path.id
          type: requestBody.deactivationType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptionAssignments/{id}/actions/requestCancellation'].options
  update:
    x-apievangelist-phrasing:
      intent: Check methods on the cancel subscription action
      effect: read
      questions:
      - Which verbs does the requestCancellation action endpoint accept cross-origin?
      - What does a preflight to a subscription's cancellation action return?
      instructions:
      - text: Preflight the requestCancellation action for assignment {id}.
        slots:
          id: path.id
      - text: List allowed methods on the cancel action of subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptionAssignments/{id}/actions/undoCancellation'].post
  update:
    x-apievangelist-phrasing:
      intent: Undo a subscription cancellation
      effect: write
      questions:
      - Can I reverse a subscription cancellation before it takes effect?
      - What's the way to restore a canceled product subscription?
      instructions:
      - text: Restore canceled subscription assignment {id}.
        slots:
          id: path.id
      - text: Undo the cancellation on subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptionAssignments/{id}/actions/undoCancellation'].options
  update:
    x-apievangelist-phrasing:
      intent: Check methods on the undo cancellation action
      effect: read
      questions:
      - Which verbs does the undoCancellation action endpoint accept from a browser?
      - What CORS headers come back for a subscription's undo cancellation action?
      instructions:
      - text: Preflight the undoCancellation action for assignment {id}.
        slots:
          id: path.id
      - text: List allowed methods on the restore action of subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'