# 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 Payment Methods API
  version: 1.0.0
extends: openapi/optimizely-payment-methods-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: 11
- target: $.paths['/api/v1/admin/PaymentMethods'].get
  update:
    x-apievangelist-phrasing:
      intent: List payment methods
      effect: read
      questions:
      - Which payment methods are configured for checkout?
      - Can I filter payment methods to only credit card types?
      instructions:
      - text: List all payment methods.
      - text: Show payment methods matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PaymentMethods'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a payment method
      effect: write
      questions:
      - How do I add a new payment option like buy now pay later?
      - Can I schedule a payment method to activate on a future date?
      instructions:
      - text: Create payment method {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      - text: Add credit card payment method {name}, {description}, active from {activateOn}.
        slots:
          name: requestBody.name
          description: requestBody.description
          activateOn: requestBody.activateOn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PaymentMethods({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a payment method
      effect: read
      questions:
      - Is a given payment method a credit card, eCheck or BNPL option?
      - Can I look up one payment method by its ID?
      instructions:
      - text: Get payment method {id}.
        slots:
          id: path.id
      - text: Show the type flags for payment method {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PaymentMethods({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a payment method entirely
      effect: write
      questions:
      - How do I overwrite every field of a payment method?
      - Can I fully replace a payment method record?
      instructions:
      - text: Replace payment method {id} with name {name} and description {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      - text: 'Overwrite all fields of payment method {id}: {name}, {description}.'
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PaymentMethods({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a payment method
      effect: destructive
      questions:
      - How do I permanently delete one payment method?
      - Does deleting a payment method honor an If-Match header?
      instructions:
      - text: Delete payment method {id}.
        slots:
          id: path.id
      - text: Remove payment method {id} if its ETag is {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PaymentMethods({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update some fields of a payment method
      effect: write
      questions:
      - How do I set a deactivation date on a payment method?
      - Can I rename a payment method without replacing it?
      instructions:
      - text: Set deactivate date {deactivateOn} on payment method {id} named {name} with description {description}.
        slots:
          id: path.id
          deactivateOn: requestBody.deactivateOn
          name: requestBody.name
          description: requestBody.description
      - text: Rename payment method {id} to {name} with description {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PaymentMethods/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new payment method
      effect: read
      questions:
      - What defaults does a new payment method start with?
      - Is there a blank payment method template?
      instructions:
      - text: Get the default field values for a new payment method.
      - text: Show a blank payment method record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PaymentMethods/Default.archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive payment methods via the archive action
      effect: write
      questions:
      - How do I archive payment methods with the POST archive action?
      - Can I retire payment methods without deleting them?
      instructions:
      - text: Archive payment methods {ids} with the archive action.
        slots:
          ids: query.ids
      - text: Run the POST archive action on payment methods {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/paymentmethods/archive'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive payment methods via the DELETE route
      effect: destructive
      questions:
      - Is there a DELETE archive endpoint for payment methods?
      - Which route archives payment methods using the DELETE method?
      instructions:
      - text: Archive payment methods {ids} through the DELETE archive route.
        slots:
          ids: query.ids
      - text: Call DELETE paymentmethods/archive for {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/paymentmethods/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several payment methods
      effect: destructive
      questions:
      - How do I bulk delete a list of payment methods permanently?
      - Can I delete many payment methods in one request?
      instructions:
      - text: Bulk delete payment methods {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every payment method in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/paymentmethods({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a payment method
      effect: read
      questions:
      - How do I read a custom property on a payment method?
      - Can I fetch one custom field value from a payment method?
      instructions:
      - text: Get custom property {custompropertyKey} of payment method {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on payment method {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'