# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bindbee Connector API
  version: 1.0.0
extends: openapi/bindbee-connector-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: 8
- target: $.paths['/api/hris/v1/connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List HRIS connectors
      effect: read
      questions:
      - Which HR system connections have my customers linked?
      - Can I list only the active HRIS connectors?
      instructions:
      - text: List HRIS connectors where active is {is_active}.
        slots:
          is_active: query.is_active
      - text: Find the HRIS connector for origin id {origin_id}.
        slots:
          origin_id: query.origin_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/connectors/{connector_id}/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an HRIS connector
      effect: destructive
      questions:
      - How do I disconnect a customer's linked HR system?
      - Can I remove an HRIS connection I no longer need?
      instructions:
      - text: Delete HRIS connector {connector_id}.
        slots:
          connector_id: path.connector_id
      - text: Remove the HR system connection {connector_id}.
        slots:
          connector_id: path.connector_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List ATS connectors
      effect: read
      questions:
      - Which applicant tracking system connections are linked to my account?
      - Can I look up the ATS connector behind a given end-user origin id?
      instructions:
      - text: List ATS connectors where active is {is_active}.
        slots:
          is_active: query.is_active
      - text: Find the ATS connector for origin id {origin_id}.
        slots:
          origin_id: query.origin_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/connectors/{connector_id}/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an ATS connector
      effect: destructive
      questions:
      - How do I unlink a customer's applicant tracking system?
      - Can I delete an ATS connection that was set up by mistake?
      instructions:
      - text: Delete ATS connector {connector_id}.
        slots:
          connector_id: path.connector_id
      - text: Disconnect the recruiting system connection {connector_id}.
        slots:
          connector_id: path.connector_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lms/v1/connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List LMS connectors
      effect: read
      questions:
      - Which learning management system connections are active?
      - Can I find the LMS connector for a specific connector token?
      instructions:
      - text: List LMS connectors where active is {is_active}.
        slots:
          is_active: query.is_active
      - text: Find the LMS connector with token {connector_token}.
        slots:
          connector_token: query.connector_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lms/v1/connectors/{connector_id}/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an LMS connector
      effect: destructive
      questions:
      - How do I remove a linked learning platform connection?
      - Can I delete an LMS connector for a churned customer?
      instructions:
      - text: Delete LMS connector {connector_id}.
        slots:
          connector_id: path.connector_id
      - text: Disconnect the learning system connection {connector_id}.
        slots:
          connector_id: path.connector_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/embedded/v1/connectors/connector_token/{temporary_token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Exchange a temporary token for a connector token
      effect: read
      questions:
      - After a user finishes the embedded link flow, how do I get the permanent connector token?
      - Can I swap the temporary token from the link widget for a connector token?
      instructions:
      - text: Exchange temporary token {temporary_token} for its connector token.
        slots:
          temporary_token: path.temporary_token
      - text: Get the connector token behind temporary token {temporary_token}.
        slots:
          temporary_token: path.temporary_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/embedded/v1/connectors/resync'].post
  update:
    x-apievangelist-phrasing:
      intent: Force a connector to resync
      effect: write
      questions:
      - How do I trigger a fresh data sync for a linked account right now?
      - Can I force a resync when a connector's data looks stale?
      instructions:
      - text: Force a resync for connector {connector}.
        slots:
          connector: header.x-connector-token
      - text: Kick off an immediate data resync on connector {connector}.
        slots:
          connector: header.x-connector-token
      method: generated
      generated: '2026-09-26'