# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Gainsight Companies API
  version: 1.0.0
extends: openapi/gainsight-companies-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: 10
- target: $.paths['/data/objects/Company'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update company records by key
      effect: write
      questions:
      - How do I update up to 50 company records at once, matched on a key field?
      - Which field does the bulk company update use to match existing records?
      instructions:
      - text: 'Update these company records matched on {keys}: {records}.'
        slots:
          keys: query.keys
          records: requestBody.records
      - text: Bulk-edit company data {records}, matching on key field {keys}.
        slots:
          records: requestBody.records
          keys: query.keys
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/objects/Company'].post
  update:
    x-apievangelist-phrasing:
      intent: Insert company records in bulk
      effect: write
      questions:
      - Can I load a batch of new companies into the Company object?
      - How many company records can I insert in one call?
      instructions:
      - text: 'Insert these new company records: {records}.'
        slots:
          records: requestBody.records
      - text: 'Add a batch of up to 50 companies to the Company object: {records}.'
        slots:
          records: requestBody.records
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/objects/Company/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search company records
      effect: read
      questions:
      - Which companies have ARR over a threshold and renew this quarter?
      - Can I query the Company object with filters, ordering and up to 5000 results?
      instructions:
      - text: Search company records where {where}.
        slots:
          where: requestBody.where
      - text: Find companies matching {where}, ordered by {orderBy}.
        slots:
          where: requestBody.where
          orderBy: requestBody.orderBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/objects/Company/{recordId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company from the Company object
      effect: read
      questions:
      - How do I read a company record from the data objects API by its Gainsight ID?
      - Can I fetch a Company object record by GSID?
      instructions:
      - text: Get Company object record {recordId}.
        slots:
          recordId: path.recordId
      - text: Read the data-object company with GSID {recordId}.
        slots:
          recordId: path.recordId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/objects/Company/{recordId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a company from the Company object
      effect: destructive
      questions:
      - Can I delete a company record through the data objects API?
      - How is a Company object record removed by GSID?
      instructions:
      - text: Delete Company object record {recordId}.
        slots:
          recordId: path.recordId
      - text: Remove the data-object company with GSID {recordId}.
        slots:
          recordId: path.recordId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/companies'].get
  update:
    x-apievangelist-phrasing:
      intent: List companies
      effect: read
      questions:
      - What companies are in Gainsight?
      - Can I page through the company list with page numbers?
      instructions:
      - text: List companies, page {pageNumber}.
        slots:
          pageNumber: query.pageNumber
      - text: Show all company records, {pageSize} per page.
        slots:
          pageSize: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/companies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a company
      effect: write
      questions:
      - How do I add a single new customer company with its ARR and lifecycle stage?
      - Can I set the renewal date when creating a company?
      instructions:
      - text: Create a company named {Name}.
        slots:
          Name: requestBody.Name
      - text: Add company {Name} in industry {Industry} with ARR {ARR}.
        slots:
          Name: requestBody.Name
          Industry: requestBody.Industry
          ARR: requestBody.ARR
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/companies/{companyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company
      effect: read
      questions:
      - What is a company's ARR, status and renewal date?
      - How do I look up a company by its company ID?
      instructions:
      - text: Get company {companyId}.
        slots:
          companyId: path.companyId
      - text: Show the lifecycle stage and ARR of company {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/companies/{companyId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a company
      effect: write
      questions:
      - Can I change a company's lifecycle stage or renewal date?
      - How do I edit one company's details by company ID?
      instructions:
      - text: Update company {companyId} with name {Name} and status {Status}.
        slots:
          companyId: path.companyId
          Name: requestBody.Name
          Status: requestBody.Status
      - text: Set the renewal date of company {companyId} ({Name}) to {RenewalDate}.
        slots:
          companyId: path.companyId
          Name: requestBody.Name
          RenewalDate: requestBody.RenewalDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/companies/{companyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a company
      effect: destructive
      questions:
      - How do I delete a company by its company ID?
      - Can a churned company be removed from the company list?
      instructions:
      - text: Delete company {companyId}.
        slots:
          companyId: path.companyId
      - text: Remove company {companyId} from Gainsight.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-09-26'