# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Punch Out Setup Requests API
  version: 1.0.0
extends: openapi/optimizely-punch-out-setup-requests-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: 9
- target: $.paths['/api/v1/admin/PunchOutSetupRequests'].get
  update:
    x-apievangelist-phrasing:
      intent: List PunchOut setup requests
      effect: read
      questions:
      - Which cXML PunchOut setup requests have procurement systems sent to my store?
      - Can I filter PunchOut setup requests by the IP address they came from?
      - How many PunchOut setup requests have been logged?
      instructions:
      - text: List all PunchOut setup requests.
      - text: Find PunchOut setup requests matching {filter}, newest first by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutSetupRequests'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a PunchOut setup request
      effect: write
      questions:
      - How do I store a new cXML PunchOut setup request with its response?
      - Can I log which PunchOut session and IP a setup request belongs to?
      instructions:
      - text: Record a PunchOut setup request from IP {ipAddress} with cXML {punchOutSetupRequestCXml} and response {setupRequestResponse}.
        slots:
          ipAddress: requestBody.ipAddress
          punchOutSetupRequestCXml: requestBody.punchOutSetupRequestCXml
          setupRequestResponse: requestBody.setupRequestResponse
      - text: Log a setup request for PunchOut session {punchOutSessionId}.
        slots:
          punchOutSessionId: requestBody.punchOutSessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutSetupRequests({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one PunchOut setup request
      effect: read
      questions:
      - What cXML and response were recorded for a specific PunchOut setup request?
      - How do I look up a single PunchOut setup request by ID?
      instructions:
      - text: Get PunchOut setup request {id}.
        slots:
          id: path.id
      - text: Show the cXML of PunchOut setup request {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutSetupRequests({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a PunchOut setup request record
      effect: write
      questions:
      - How do I overwrite a stored PunchOut setup request entirely?
      - Can I fully replace the cXML and response saved for a setup request?
      instructions:
      - text: Replace PunchOut setup request {id} with cXML {punchOutSetupRequestCXml}.
        slots:
          id: path.id
          punchOutSetupRequestCXml: requestBody.punchOutSetupRequestCXml
      - text: Overwrite the whole PunchOut setup request record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutSetupRequests({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a PunchOut setup request
      effect: destructive
      questions:
      - How do I remove one logged PunchOut setup request?
      - Can I delete a setup request only if its ETag still matches?
      instructions:
      - text: Delete PunchOut setup request {id}.
        slots:
          id: path.id
      - text: Delete setup request {id} if the ETag is {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutSetupRequests({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a PunchOut setup request
      effect: write
      questions:
      - Can I change only the response stored on a PunchOut setup request?
      - How do I attach a setup request to a different PunchOut session?
      instructions:
      - text: Update the response of setup request {id} to {setupRequestResponse}.
        slots:
          id: path.id
          setupRequestResponse: requestBody.setupRequestResponse
      - text: Link setup request {id} to PunchOut session {punchOutSessionId}.
        slots:
          id: path.id
          punchOutSessionId: requestBody.punchOutSessionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutSetupRequests/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default PunchOut setup request template
      effect: read
      questions:
      - What default values does a new PunchOut setup request record start with?
      - Is there a blank PunchOut setup request template?
      instructions:
      - text: Fetch the default PunchOut setup request template.
      - text: Get default values for a new setup request record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/punchoutsetuprequests/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete PunchOut setup requests
      effect: destructive
      questions:
      - How do I purge many PunchOut setup requests in one call?
      - Can I delete several setup requests by listing their IDs?
      instructions:
      - text: Bulk delete PunchOut setup requests {ids}.
        slots:
          ids: query.ids
      - text: 'Remove all these setup requests at once: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/punchoutsetuprequests({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a PunchOut setup request
      effect: read
      questions:
      - How do I read a custom property on a PunchOut setup request?
      - Can I fetch one custom field from a setup request record?
      instructions:
      - text: Get custom property {custompropertyKey} of setup request {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show custom field {custompropertyKey} on PunchOut setup request {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'