# 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 User Payment Profiles API
  version: 1.0.0
extends: openapi/optimizely-user-payment-profiles-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/UserPaymentProfiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved customer payment cards
      effect: read
      questions:
      - How can I see the saved payment cards on file for storefront users?
      - Can I filter saved payment profiles to one user profile?
      instructions:
      - text: List all user payment profiles.
      - text: Show saved payment profiles matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserPaymentProfiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a payment card to a user profile
      effect: write
      questions:
      - What card and billing address details are needed to save a payment profile?
      - Can I make a newly saved card the user's default?
      instructions:
      - text: Save a {cardType} card for {cardHolderName} ending in {maskedCardNumber} to user profile {userProfileId}.
        slots:
          cardType: requestBody.cardType
          cardHolderName: requestBody.cardHolderName
          maskedCardNumber: requestBody.maskedCardNumber
          userProfileId: requestBody.userProfileId
      - text: Add a payment profile with token {cardIdentifier} expiring {expirationDate}.
        slots:
          cardIdentifier: requestBody.cardIdentifier
          expirationDate: requestBody.expirationDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserPaymentProfiles({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one saved payment profile
      effect: read
      questions:
      - How do I look up one saved card by its payment profile id?
      - What billing address is stored on a saved payment profile?
      instructions:
      - text: Fetch user payment profile {id}.
        slots:
          id: path.id
      - text: Show the card and billing details on payment profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserPaymentProfiles({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a saved payment profile
      effect: write
      questions:
      - Can I overwrite every field of a saved card record at once?
      - Does replacing a payment profile require the full billing address again?
      instructions:
      - text: Replace payment profile {id} with card holder {cardHolderName} and postal code {postalCode}.
        slots:
          id: path.id
          cardHolderName: requestBody.cardHolderName
          postalCode: requestBody.postalCode
      - text: Overwrite the full saved card record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserPaymentProfiles({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a saved payment card
      effect: destructive
      questions:
      - How do I remove one saved card from a customer's account?
      - Can I delete a payment profile only if it hasn't been changed?
      instructions:
      - text: Delete payment profile {id}.
        slots:
          id: path.id
      - text: Remove saved card {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserPaymentProfiles({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a saved card's expiry or default flag
      effect: write
      questions:
      - Can I update just the expiration date on a saved card?
      - Is there a way to set an existing saved card as the default?
      instructions:
      - text: Change the expiration date of payment profile {id} to {expirationDate}.
        slots:
          id: path.id
          expirationDate: requestBody.expirationDate
      - text: Set the default flag on payment profile {id} to {isDefault}.
        slots:
          id: path.id
          isDefault: requestBody.isDefault
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserPaymentProfiles/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new payment profile
      effect: read
      questions:
      - What defaults does a new user payment profile start with?
      - Is there a blank payment profile template?
      instructions:
      - text: Get the default values for a new user payment profile.
      - text: Show the empty payment profile record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/userpaymentprofiles/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several saved payment profiles
      effect: destructive
      questions:
      - How do I bulk delete saved payment cards?
      - Can I remove multiple payment profiles by id at once?
      instructions:
      - text: Bulk delete user payment profiles {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every saved card in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/userpaymentprofiles({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a payment profile
      effect: read
      questions:
      - How do I read a custom property on a saved payment profile?
      - Can I fetch one custom field from a user payment profile?
      instructions:
      - text: Get custom property {custompropertyKey} of payment profile {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on user payment profile {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'