# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Overview Shipper Accounts API
  version: 1.0.0
extends: openapi/aftership-shipper-accounts-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: 7
- target: $.paths['/shipper-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipper accounts
      effect: read
      questions:
      - Which carrier shipper accounts do I have set up?
      - Can I list only my shipper accounts for one carrier?
      instructions:
      - text: List my shipper accounts.
      - text: Show my shipper accounts for {slug}.
        slots:
          slug: query.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shipper-accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a carrier shipper account
      effect: write
      questions:
      - How do I connect a new carrier account for shipping labels?
      - What credentials do I need to create a shipper account?
      instructions:
      - text: Create a {slug} shipper account with credentials {credentials}.
        slots:
          slug: requestBody.slug
          credentials: requestBody.credentials
      - text: Add shipper account {description} for {slug} at address {address}.
        slots:
          description: requestBody.description
          slug: requestBody.slug
          address: requestBody.address
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shipper-accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipper account by ID
      effect: read
      questions:
      - What are the details of a specific shipper account?
      - Can I look up one shipper account by its ID?
      instructions:
      - text: Show shipper account {id}.
        slots:
          id: path.id
      - text: Get the details of shipper account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shipper-accounts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shipper account
      effect: destructive
      questions:
      - How do I remove a carrier account I no longer ship with?
      - Can I delete a shipper account permanently?
      instructions:
      - text: Delete shipper account {id}.
        slots:
          id: path.id
      - text: Remove carrier account {id} from my shipper accounts.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shipper-accounts/{id}/info'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a shipper account's address or description
      effect: write
      questions:
      - How do I change the address on a shipper account?
      - Can I update a shipper account's timezone or description without touching credentials?
      instructions:
      - text: Update shipper account {id} address to {address}.
        slots:
          id: path.id
          address: requestBody.address
      - text: Set the description of shipper account {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shipper-accounts/{id}/credentials'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a shipper account's credentials
      effect: write
      questions:
      - How do I update the carrier password on a shipper account?
      - Can I change the account number linked to a shipper account?
      instructions:
      - text: Update the credentials of shipper account {id} with account number {account_number}.
        slots:
          id: path.id
          account_number: requestBody.account_number
      - text: Change the password on shipper account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shipper-accounts/{id}/settings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a FedEx shipper account's settings
      effect: write
      questions:
      - Can I turn on electronic trade documents for my FedEx shipper account?
      - How do I set a commercial invoice letterhead and signature?
      instructions:
      - text: Enable electronic trade documents on shipper account {id}.
        slots:
          id: path.id
      - text: Set the commercial invoice signature on shipper account {id} to {commercial_invoice_signature}.
        slots:
          id: path.id
          commercial_invoice_signature: requestBody.commercial_invoice_signature
      method: generated
      generated: '2026-09-26'