# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Auth0 Management Branding API
  version: 1.0.0
extends: openapi/auth0-branding-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 23
- target: $.paths['/branding'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tenant branding settings
      effect: read
      questions:
      - What logo, colors and favicon is my login page currently using?
      - Can I check the tenant-wide branding settings?
      instructions:
      - text: Show my tenant's branding settings.
      - text: Get the current logo and colors for login.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update tenant branding settings
      effect: write
      questions:
      - How do I change the logo shown on the hosted login page?
      - Can I set a custom font and favicon for my tenant branding?
      instructions:
      - text: Set the branding logo to {logo_url}.
        slots:
          logo_url: requestBody.logo_url
      - text: Change the favicon to {favicon_url}.
        slots:
          favicon_url: requestBody.favicon_url
      - text: Update branding colors to {colors}.
        slots:
          colors: requestBody.colors
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/phone/providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List configured phone providers
      effect: read
      questions:
      - Which SMS phone providers are configured for my tenant?
      - Can I list only the disabled phone messaging providers?
      instructions:
      - text: List my phone messaging providers.
      - text: List phone providers where disabled is {disabled}.
        slots:
          disabled: query.disabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/phone/providers'].post
  update:
    x-apievangelist-phrasing:
      intent: Configure a phone messaging provider
      effect: write
      questions:
      - How do I set up an SMS provider for MFA and passwordless texts?
      - What credentials does configuring a phone provider need?
      instructions:
      - text: Configure phone provider {name} with credentials {credentials}.
        slots:
          name: requestBody.name
          credentials: requestBody.credentials
      - text: Add {name} as my SMS provider using {credentials}, disabled for now as {disabled}.
        slots:
          name: requestBody.name
          credentials: requestBody.credentials
          disabled: requestBody.disabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/phone/providers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a phone provider's details
      effect: read
      questions:
      - Can I see the configuration of one phone provider by ID?
      - What settings does my configured SMS provider have?
      instructions:
      - text: Show phone provider {id}.
        slots:
          id: path.id
      - text: Get details for SMS provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/phone/providers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a phone provider
      effect: destructive
      questions:
      - How do I remove the configured SMS provider?
      - Can I delete a phone provider I no longer use?
      instructions:
      - text: Delete phone provider {id}.
        slots:
          id: path.id
      - text: Remove SMS provider {id} from the tenant.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/phone/providers/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a phone provider
      effect: write
      questions:
      - Can I rotate the credentials of my existing SMS provider?
      - How do I disable a phone provider without deleting it?
      instructions:
      - text: Update credentials of phone provider {id} to {credentials}.
        slots:
          id: path.id
          credentials: requestBody.credentials
      - text: Set disabled to {disabled} on phone provider {id}.
        slots:
          disabled: requestBody.disabled
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/phone/providers/{id}/try'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test message through a phone provider
      effect: write
      questions:
      - Can I send a test SMS to check my phone provider works?
      - Is there a way to test the phone provider by voice instead of text?
      instructions:
      - text: Send a test message from phone provider {id} to {to}.
        slots:
          id: path.id
          to: requestBody.to
      - text: Test provider {id} by sending to {to} via {delivery_method}.
        slots:
          id: path.id
          to: requestBody.to
          delivery_method: requestBody.delivery_method
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/phone/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List phone notification templates
      effect: read
      questions:
      - Which SMS notification templates exist in my tenant?
      - Can I see only the disabled phone templates?
      instructions:
      - text: List my phone notification templates.
      - text: List phone templates with disabled set to {disabled}.
        slots:
          disabled: query.disabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/phone/templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a phone notification template
      effect: write
      questions:
      - How do I create a custom SMS message template for verification codes?
      - Can I add a new phone notification template for a specific message type?
      instructions:
      - text: Create a {type} phone template with content {content}.
        slots:
          type: requestBody.type
          content: requestBody.content
      - text: Create a new phone notification template.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/phone/templates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a phone notification template
      effect: read
      questions:
      - What does a particular SMS template currently say?
      - Can I fetch one phone notification template by ID?
      instructions:
      - text: Show phone template {id}.
        slots:
          id: path.id
      - text: Get the content of SMS template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/phone/templates/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a phone notification template
      effect: destructive
      questions:
      - How do I delete a custom SMS template?
      - Can I remove a phone notification template I created?
      instructions:
      - text: Delete phone template {id}.
        slots:
          id: path.id
      - text: Remove SMS notification template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/phone/templates/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a phone notification template
      effect: write
      questions:
      - Can I change the wording of an existing SMS template?
      - How do I disable a phone notification template?
      instructions:
      - text: Update phone template {id} content to {content}.
        slots:
          id: path.id
          content: requestBody.content
      - text: Set disabled to {disabled} on phone template {id}.
        slots:
          disabled: requestBody.disabled
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/phone/templates/{id}/reset'].patch
  update:
    x-apievangelist-phrasing:
      intent: Reset a phone template to defaults
      effect: destructive
      questions:
      - Can I restore an SMS template to its default wording?
      - How do I undo my customizations to a phone template?
      instructions:
      - text: Reset phone template {id} to default values.
        slots:
          id: path.id
      - text: Restore the default content of SMS template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/phone/templates/{id}/try'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test message from a phone template
      effect: write
      questions:
      - Can I preview a phone template by sending myself a test message?
      - Is there a way to test a specific SMS template on my own number?
      instructions:
      - text: Send a test of phone template {id} to {to}.
        slots:
          id: path.id
          to: requestBody.to
      - text: Test template {id} by sending it to {to} via {delivery_method}.
        slots:
          id: path.id
          to: requestBody.to
          delivery_method: requestBody.delivery_method
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/templates/universal-login'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Universal Login page template
      effect: read
      questions:
      - What custom HTML template is my Universal Login page using?
      - Can I download the current Universal Login branding template?
      instructions:
      - text: Show the Universal Login page template.
      - text: Get my custom New Universal Login HTML.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/templates/universal-login'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the Universal Login page template
      effect: write
      questions:
      - How do I upload a custom HTML template for Universal Login?
      - Can I replace the Universal Login page layout with my own Liquid template?
      instructions:
      - text: Set my Universal Login template to the HTML I provide.
      - text: Replace the New Universal Login page template.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/templates/universal-login'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete the Universal Login template
      effect: destructive
      questions:
      - How do I go back to the default Universal Login page?
      - Can I remove my custom Universal Login template?
      instructions:
      - text: Delete the custom Universal Login template.
      - text: Revert Universal Login to the default page.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/themes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a branding theme
      effect: write
      questions:
      - How do I create a theme for the login widget with my own colors and fonts?
      - What do I need to define when creating a branding theme?
      instructions:
      - text: Create branding theme {displayName} with colors {colors}, fonts {fonts}, borders {borders}, background {page_background} and widget {widget}.
        slots:
          displayName: requestBody.displayName
          colors: requestBody.colors
          fonts: requestBody.fonts
          borders: requestBody.borders
          page_background: requestBody.page_background
          widget: requestBody.widget
      - text: Create a new login branding theme.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/themes/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default branding theme
      effect: read
      questions:
      - Which branding theme is the default for my login pages?
      - Can I see the default theme without knowing its ID?
      instructions:
      - text: Show the default branding theme.
      - text: Get my tenant's default login theme.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/themes/{themeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a branding theme by ID
      effect: read
      questions:
      - Can I look up a branding theme by its theme ID?
      - What colors and fonts does a specific theme use?
      instructions:
      - text: Show branding theme {themeId}.
        slots:
          themeId: path.themeId
      - text: Get the settings of theme {themeId}.
        slots:
          themeId: path.themeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/themes/{themeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a branding theme
      effect: destructive
      questions:
      - How do I delete a branding theme?
      - Can I remove a login theme I no longer need?
      instructions:
      - text: Delete branding theme {themeId}.
        slots:
          themeId: path.themeId
      - text: Remove login theme {themeId}.
        slots:
          themeId: path.themeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branding/themes/{themeId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a branding theme
      effect: write
      questions:
      - Can I change the colors of an existing branding theme?
      - How do I rename a login theme?
      instructions:
      - text: Update theme {themeId} colors to {colors}.
        slots:
          themeId: path.themeId
          colors: requestBody.colors
      - text: Rename theme {themeId} to {displayName}.
        slots:
          themeId: path.themeId
          displayName: requestBody.displayName
      method: generated
      generated: '2026-10-01'