# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Workfront Rate API
  version: 1.0.0
extends: openapi/adobe-suite-rate-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: 16
- target: $.paths['/rate/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single billing rate
      effect: read
      questions:
      - How do I look up one billing rate by its ID?
      - Can I limit which fields are returned for a single rate?
      instructions:
      - text: Show me rate {id}.
        slots:
          id: path.id
      - text: Fetch rate {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rate/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a single billing rate
      effect: write
      questions:
      - How can I change the value of one existing rate?
      - Is editing a rate by ID supported in Workfront?
      instructions:
      - text: Edit rate {id}.
        slots:
          id: path.id
      - text: Update rate {id} and return {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rate/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single billing rate
      effect: destructive
      questions:
      - How do I delete one rate that is no longer valid?
      - Can I force the deletion of a rate?
      instructions:
      - text: Delete rate {id}.
        slots:
          id: path.id
      - text: Force delete rate {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rate'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several rates by ID at once
      effect: read
      questions:
      - Can I fetch multiple rates in one call by listing their IDs?
      - What's the fastest way to load a known set of rates?
      instructions:
      - text: Get rates {id}.
        slots:
          id: query.id
      - text: Bulk fetch rates {id} returning {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rate'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit many rates in one request
      effect: write
      questions:
      - Is there a bulk edit for rates?
      - Can I update a batch of rate records together?
      instructions:
      - text: Bulk edit the rates I send.
      - text: Apply edits to multiple rates and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rate'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a billing rate
      effect: write
      questions:
      - How do I add a new billing rate record?
      - Can I create a rate and choose which fields come back?
      instructions:
      - text: Create a new rate.
      - text: Create a rate and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rate'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several rates at once
      effect: destructive
      questions:
      - Can I bulk delete rates by passing a list of IDs?
      - Does bulk rate deletion support a force option?
      instructions:
      - text: Delete rates {id} in bulk.
        slots:
          id: query.id
      - text: Bulk force-delete rates {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rate/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count rates matching a filter
      effect: read
      questions:
      - How many rate records do we have?
      - Can I count only rates that match a filter?
      instructions:
      - text: Count all rates.
      - text: Count rates matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rate/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search rates with filters
      effect: read
      questions:
      - How do I search for rates by role or value?
      - Can I page through rate search results?
      instructions:
      - text: Search rates where {filters}.
        slots:
          filters: query.filters
      - text: Find rates matching {filters} with {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rate/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on rates
      effect: read
      questions:
      - Can I get aggregated report data about rates?
      - What does a rate report look like with filters applied?
      instructions:
      - text: Run a rate report.
      - text: Report on rates filtered by {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rate/createRates'].put
  update:
    x-apievangelist-phrasing:
      intent: Create multiple rates in one action
      effect: write
      questions:
      - Can I create several rates at once from a list?
      - Is there an action that adds a batch of rates in one go?
      instructions:
      - text: 'Create these rates: {rates}.'
        slots:
          rates: query.rates
      - text: Use the createRates action to add {rates}.
        slots:
          rates: query.rates
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rate/deleteRateForRole'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove a role's rate from a rate card or project
      effect: destructive
      questions:
      - How do I delete the rate a job role has on a specific project or rate card?
      - Can I remove one role rate from an attachable object?
      instructions:
      - text: Delete rate {rateID} from {attachableObjCode} {attachableID}.
        slots:
          rateID: query.rateID
          attachableObjCode: query.attachableObjCode
          attachableID: query.attachableID
      - text: Remove role rate {rateID} attached to {attachableID}.
        slots:
          rateID: query.rateID
          attachableID: query.attachableID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rate/editRatesForRole'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a job role's rates on an object
      effect: write
      questions:
      - How do I change the rates for a job role on a rate card or project?
      - Can I edit a role's rates and change their currency at the same time?
      instructions:
      - text: Edit rates for role {roleID} on {attachableObjCode} {attachableID} to {rates}.
        slots:
          roleID: query.roleID
          attachableObjCode: query.attachableObjCode
          attachableID: query.attachableID
          rates: query.rates
      - text: Update role {roleID} rates on {attachableID} in currency {currencyCode}.
        slots:
          roleID: query.roleID
          attachableID: query.attachableID
          currencyCode: query.currencyCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rate/getUsedClassifierIds'].put
  update:
    x-apievangelist-phrasing:
      intent: List classifier IDs used by a role's rates
      effect: read
      questions:
      - Which classifiers are already used by rates for a role on a rate card?
      - Can I see the classifier IDs in use for a role on a given object?
      instructions:
      - text: Get classifier IDs used on rate card {rateCardID} for role {roleID}.
        slots:
          rateCardID: query.rateCardID
          roleID: query.roleID
      - text: Show used classifier IDs for role {roleID} on {objCode} {objID}.
        slots:
          roleID: query.roleID
          objCode: query.objCode
          objID: query.objID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rate/setRatesForObject'].put
  update:
    x-apievangelist-phrasing:
      intent: Set all rates on a project or rate card
      effect: write
      questions:
      - How do I set the full list of rates on a project?
      - Can I overwrite every rate attached to an object in one call?
      instructions:
      - text: Set rates {rates} on {attachableObjCode} {attachableID}.
        slots:
          rates: query.rates
          attachableObjCode: query.attachableObjCode
          attachableID: query.attachableID
      - text: Replace the rates on object {attachableID} with {rates}.
        slots:
          attachableID: query.attachableID
          rates: query.rates
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rate/setRatesForRole'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a job role's rates on an object
      effect: write
      questions:
      - How do I assign new rates to a job role on a rate card?
      - Can I set a role's rates with a specific classifier and currency?
      instructions:
      - text: Set rates {rates} for role {roleID} on {attachableObjCode} {attachableID}.
        slots:
          rates: query.rates
          roleID: query.roleID
          attachableObjCode: query.attachableObjCode
          attachableID: query.attachableID
      - text: Give role {roleID} rates in {currencyCode} with classifier {classifierID}.
        slots:
          roleID: query.roleID
          currencyCode: query.currencyCode
          classifierID: query.classifierID
      method: generated
      generated: '2026-09-26'