API Evangelist conversational phrasing for Encharge Custom Objects API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Encharge Custom Objects API
  version: 1.0.0
extends: openapi/encharge-custom-objects-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: 18
- target: $.paths['/objects/{objectName}'].get
  update:
    x-apievangelist-phrasing:
      intent: List records of a custom object
      effect: read
      questions:
      - How do I list all my company records?
      - Can I page through custom object records sorted by a field?
      - Which attributes can I choose to return when listing custom object records?
      instructions:
      - text: List all {objectName} records.
        slots:
          objectName: path.objectName
      - text: List {limit} {objectName} records sorted by {sort}.
        slots:
          limit: query.limit
          objectName: path.objectName
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/{objectName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Upsert a custom object record
      effect: write
      questions:
      - How do I create a company record or update it if it already exists?
      - Can I upsert a custom object record by its external ID?
      instructions:
      - text: Upsert a {objectName} record with external ID {externalId}.
        slots:
          objectName: path.objectName
          externalId: requestBody.externalId
      - text: Create or update the {objectName} record {id}.
        slots:
          objectName: path.objectName
          id: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/{objectName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create new custom object records
      effect: write
      questions:
      - How do I add brand-new company records?
      - Can I create several new records of a custom object in one call?
      instructions:
      - text: Create new {objectName} records.
        slots:
          objectName: path.objectName
      - text: Add fresh records to the {objectName} object, insert only.
        slots:
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/{objectName}/segments/{segmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom object records in a segment
      effect: read
      questions:
      - How do I see which companies fall into a particular segment?
      - Can I page through the records of a segment of custom objects?
      instructions:
      - text: List the {objectName} records in segment {segmentId}.
        slots:
          objectName: path.objectName
          segmentId: path.segmentId
      - text: Show {limit} {objectName} records from segment {segmentId}.
        slots:
          limit: query.limit
          objectName: path.objectName
          segmentId: path.segmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/{objectName}/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count records of a custom object
      effect: read
      questions:
      - How many company records do I have in total?
      - What's the total number of records stored in a custom object?
      instructions:
      - text: Count all {objectName} records.
        slots:
          objectName: path.objectName
      - text: Tell me how many {objectName} records exist overall.
        slots:
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/{objectName}/segments/{segmentId}/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count custom object records in a segment
      effect: read
      questions:
      - How many companies are in a given segment?
      - What is the size of a custom object segment?
      instructions:
      - text: Count the {objectName} records in segment {segmentId}.
        slots:
          objectName: path.objectName
          segmentId: path.segmentId
      - text: Give me the size of segment {segmentId} for {objectName}.
        slots:
          segmentId: path.segmentId
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/{objectName}/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search custom object records
      effect: read
      questions:
      - How do I search my company records by name?
      - Can I restrict a custom object search to one segment?
      - Which fields does a custom object search look at?
      instructions:
      - text: Search {objectName} records for {query}.
        slots:
          objectName: path.objectName
          query: query.query
      - text: Search {objectName} records for {query} within segment {segmentId}.
        slots:
          objectName: path.objectName
          query: query.query
          segmentId: query.segmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/{objectName}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom object record by ID
      effect: read
      questions:
      - How do I fetch one company record by its Encharge ID?
      - Can I retrieve a single custom object record if I know its id?
      instructions:
      - text: Get {objectName} record {id}.
        slots:
          objectName: path.objectName
          id: path.id
      - text: Show me the details of {objectName} {id}.
        slots:
          objectName: path.objectName
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/{objectName}/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom object record by ID
      effect: destructive
      questions:
      - How do I remove a company record using its Encharge ID?
      - Can I delete one custom object record by id?
      instructions:
      - text: Delete {objectName} record {id}.
        slots:
          objectName: path.objectName
          id: path.id
      - text: Remove the {objectName} with Encharge ID {id}.
        slots:
          objectName: path.objectName
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/{objectName}/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom object record by ID
      effect: write
      questions:
      - How do I edit an existing company record I know the Encharge ID of?
      - Can I set an external ID on a custom object record after it's created?
      instructions:
      - text: Update {objectName} record {id}.
        slots:
          objectName: path.objectName
          id: path.id
      - text: Set external ID {externalId} on {objectName} record {id}.
        slots:
          externalId: requestBody.externalId
          objectName: path.objectName
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/{objectName}/externalId/{externalId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom object record by external ID
      effect: read
      questions:
      - How do I look up a company using the ID from my own system?
      - Can I fetch a custom object record by its external ID instead of the Encharge ID?
      instructions:
      - text: Get the {objectName} record with external ID {externalId}.
        slots:
          objectName: path.objectName
          externalId: path.externalId
      - text: Find {objectName} by my system's ID {externalId}.
        slots:
          objectName: path.objectName
          externalId: path.externalId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/{objectName}/externalId/{externalId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom object record by external ID
      effect: destructive
      questions:
      - How do I delete a company record using my own system's ID?
      - Can I remove a custom object record by external ID?
      instructions:
      - text: Delete the {objectName} record with external ID {externalId}.
        slots:
          objectName: path.objectName
          externalId: path.externalId
      - text: Remove {objectName} {externalId} using its external ID.
        slots:
          objectName: path.objectName
          externalId: path.externalId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/{objectName}/externalId/{externalId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom object record by external ID
      effect: write
      questions:
      - How do I update a company record when I only have my CRM's ID for it?
      - Can I patch a custom object record addressed by external ID?
      instructions:
      - text: Update the {objectName} record with external ID {externalId}.
        slots:
          objectName: path.objectName
          externalId: path.externalId
      - text: Patch {objectName} {externalId}, looked up by external ID.
        slots:
          objectName: path.objectName
          externalId: path.externalId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/{objectName}/{id}/associations/{associationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List records linked through one association
      effect: read
      questions:
      - How do I list the people who are employees of a specific company?
      - Can I get only the objects linked to a record through one particular association?
      instructions:
      - text: List objects linked to {objectName} {id} through association {associationId}.
        slots:
          objectName: path.objectName
          id: path.id
          associationId: path.associationId
      - text: Show {limit} records associated with {objectName} {id} via association {associationId}.
        slots:
          limit: query.limit
          objectName: path.objectName
          id: path.id
          associationId: path.associationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/{objectName}/{id}/associations'].get
  update:
    x-apievangelist-phrasing:
      intent: List everything associated with a record
      effect: read
      questions:
      - How do I see every object connected to a company, across all association types?
      - What records are linked to this custom object in any way?
      instructions:
      - text: List all objects associated in any way with {objectName} {id}.
        slots:
          objectName: path.objectName
          id: path.id
      - text: Show up to {limit} linked records of any kind for {objectName} {id}.
        slots:
          limit: query.limit
          objectName: path.objectName
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/{objectName}/{id}/associations/default/{targetObjectName}/{targetId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Link two records using the default association
      effect: write
      questions:
      - How do I link a contact to a company without knowing the association ID?
      - Can I connect two objects when there's only one association between their types?
      instructions:
      - text: Link {objectName} {id} to {targetObjectName} {targetId} using the default association.
        slots:
          objectName: path.objectName
          id: path.id
          targetObjectName: path.targetObjectName
          targetId: path.targetId
      - text: Attach person {id} to {targetObjectName} {targetId} with the default link, object type {objectName}.
        slots:
          id: path.id
          targetObjectName: path.targetObjectName
          targetId: path.targetId
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/{objectName}/{id}/associations/{associationId}/{targetId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Link two records through a specific association
      effect: write
      questions:
      - How do I associate two records using a named association like Owner or Manager?
      - Can I pick which association schema to use when linking two objects?
      instructions:
      - text: Link {objectName} {id} to {targetId} through association {associationId}.
        slots:
          objectName: path.objectName
          id: path.id
          targetId: path.targetId
          associationId: path.associationId
      - text: Associate {objectName} {id} with record {targetId} using association schema {associationId}.
        slots:
          objectName: path.objectName
          id: path.id
          targetId: path.targetId
          associationId: path.associationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/{objectName}/{id}/associations/{associationId}/{targetId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink two associated records
      effect: destructive
      questions:
      - How do I unlink a person from a company?
      - Can I remove the association between two records without deleting either one?
      instructions:
      - text: Unlink {objectName} {id} from {targetId} in association {associationId}.
        slots:
          objectName: path.objectName
          id: path.id
          targetId: path.targetId
          associationId: path.associationId
      - text: Remove association {associationId} between {objectName} {id} and record {targetId}.
        slots:
          associationId: path.associationId
          objectName: path.objectName
          id: path.id
          targetId: path.targetId
      method: generated
      generated: '2026-10-01'