# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Gainsight CS Success Plan Success Plans API
  version: 1.0.0
extends: openapi/gainsight-success-plans-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: 4
- target: $.paths['/successplans'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a success plan
      effect: write
      questions:
      - How do I create a success plan for a customer?
      - Can I set start and end dates when creating a success plan?
      instructions:
      - text: Create success plan {Name} of type {TypeId} for company {CompanyId}.
        slots:
          Name: requestBody.Name
          TypeId: requestBody.TypeId
          CompanyId: requestBody.CompanyId
      - text: Start plan {Name} ({TypeId}) for company {CompanyId} running {StartDate} to {EndDate}.
        slots:
          Name: requestBody.Name
          TypeId: requestBody.TypeId
          CompanyId: requestBody.CompanyId
          StartDate: requestBody.StartDate
          EndDate: requestBody.EndDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/successplans/{planId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a success plan
      effect: read
      questions:
      - What is the status of a customer's success plan?
      - Can I fetch one success plan by ID?
      instructions:
      - text: Get success plan {planId}.
        slots:
          planId: path.planId
      - text: Show the details of plan {planId}.
        slots:
          planId: path.planId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/successplans/{planId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a success plan
      effect: write
      questions:
      - Can I change a success plan's owner or end date?
      - How do I close out a success plan?
      instructions:
      - text: Update success plan {planId} to status {Status} (name {Name}, company {CompanyId}, type {TypeId}).
        slots:
          planId: path.planId
          Status: requestBody.Status
          Name: requestBody.Name
          CompanyId: requestBody.CompanyId
          TypeId: requestBody.TypeId
      - text: Extend plan {planId} to end {EndDate}, keeping name {Name}, company {CompanyId}, type {TypeId}.
        slots:
          planId: path.planId
          EndDate: requestBody.EndDate
          Name: requestBody.Name
          CompanyId: requestBody.CompanyId
          TypeId: requestBody.TypeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/successplans/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search success plans
      effect: read
      questions:
      - Which customers have active success plans?
      - Can I filter success plans by company or status?
      instructions:
      - text: Search success plans where {where}.
        slots:
          where: requestBody.where
      - text: Find up to {limit} success plans matching {where}.
        slots:
          limit: requestBody.limit
          where: requestBody.where
      method: generated
      generated: '2026-09-26'