Stax · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for stax-api Team API
13 actions
13 updates
phrasing
extends
openapi/stax-team-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Stax's API. It is a proposal applied on top of the contract, not a document Stax publishes.
What the actions change
x-apievangelist-phrasing
Targets 13
$.info
$.paths['/team/options'].put
$.paths['/team/option/advanced_customizations'].put
$.paths['/team/user'].get
$.paths['/team/user'].post
$.paths['/team'].put
$.paths['/team'].post
$.paths['/team/user/{id}'].get
$.paths['/team/user/{id}'].put
$.paths['/team/registration'].get
$.paths['/team/registration'].put
$.paths['/team/apikey'].get
$.paths['/team/option/branding'].post
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for stax-api Team API
version: 1.0.0
extends: openapi/stax-team-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: 12
- target: $.paths['/team/options'].put
update:
x-apievangelist-phrasing:
intent: Add or update team settings
effect: write
questions:
- Can I change my merchant team's option settings?
- Where do I save team-level preferences for my merchant account?
instructions:
- text: Update my team settings.
- text: Save new merchant team options.
method: generated
generated: '2026-09-26'
- target: $.paths['/team/option/advanced_customizations'].put
update:
x-apievangelist-phrasing:
intent: Set an advanced customization field
effect: write
questions:
- Can I add a custom field to my team's checkout or invoice forms?
- Is it possible to make a custom field required and visible?
instructions:
- text: Add advanced customization field {id} named {name} of type {type}, option {option}, required {required}, visible {visible}.
slots:
id: requestBody.id
name: requestBody.name
type: requestBody.type
option: requestBody.option
required: requestBody.required
visible: requestBody.visible
- text: Set custom field {name} ({id}, {type}, {option}) with placeholder {placeholder}, required {required}, visible {visible}.
slots:
name: requestBody.name
id: requestBody.id
type: requestBody.type
option: requestBody.option
placeholder: requestBody.placeholder
required: requestBody.required
visible: requestBody.visible
method: generated
generated: '2026-09-26'
- target: $.paths['/team/user'].get
update:
x-apievangelist-phrasing:
intent: List my team's users
effect: read
questions:
- Who are the users on my merchant team?
- Can I see every login that has access to my team?
instructions:
- text: List the users on my merchant team.
- text: Show everyone who has access to my team.
method: generated
generated: '2026-09-26'
- target: $.paths['/team/user'].post
update:
x-apievangelist-phrasing:
intent: Add a new user to my team
effect: write
questions:
- How do I create a login for a new employee on my merchant team?
- Can I choose a team role and send a verification email when adding a team member?
instructions:
- text: Create team member {name} with email {email} and password {password} confirmed as {password_confirmation}.
slots:
name: query.name
email: query.email
password: query.password
password_confirmation: query.password_confirmation
- text: Add {name} ({email}) to my team as {team_role} with password {password}/{password_confirmation}.
slots:
name: query.name
email: query.email
team_role: query.team_role
password: query.password
password_confirmation: query.password_confirmation
method: generated
generated: '2026-09-26'
- target: $.paths['/team'].put
update:
x-apievangelist-phrasing:
intent: Edit my team's company details
effect: write
questions:
- Can I change the company name or contact email on my existing team?
- Is it possible to update my team's business address?
instructions:
- text: Change my team's company name to {company_name}.
slots:
company_name: query.company_name
- text: Update my team's contact to {contact_name} at {contact_email}, phone {contact_phone}.
slots:
contact_name: query.contact_name
contact_email: query.contact_email
contact_phone: query.contact_phone
method: generated
generated: '2026-09-26'
- target: $.paths['/team'].post
update:
x-apievangelist-phrasing:
intent: Create a new merchant team
effect: write
questions:
- Can I set up a brand-new merchant team?
- What details are required to create a team?
instructions:
- text: Create a new team for {company_name} with contact email {contact_email}.
slots:
company_name: query.company_name
contact_email: query.contact_email
- text: Set up team {company_name} ({contact_email}) located in {address_city}, {address_state}.
slots:
company_name: query.company_name
contact_email: query.contact_email
address_city: query.address_city
address_state: query.address_state
method: generated
generated: '2026-09-26'
- target: $.paths['/team/user/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a team member
effect: read
questions:
- What role and details does a specific person on my team have?
- Can I look up one team member by ID?
instructions:
- text: Get team member {id}.
slots:
id: path.id
- text: Show the role and details of team user {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/team/user/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update a team member
effect: write
questions:
- As a team admin, can I change another team member's information?
- Is it possible to edit a colleague's user record on my team?
instructions:
- text: Update team member {id}.
slots:
id: path.id
- text: Edit the user record of teammate {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/team/registration'].get
update:
x-apievangelist-phrasing:
intent: Get my team's registration
effect: read
questions:
- What onboarding registration is on file for my own merchant team?
- Can I review my team's underwriting application?
instructions:
- text: Show my team's registration record.
- text: Get the onboarding application tied to my team.
method: generated
generated: '2026-09-26'
- target: $.paths['/team/registration'].put
update:
x-apievangelist-phrasing:
intent: Update my team's registration
effect: write
questions:
- Can I fill in my own team's business details for underwriting?
- Is it possible to update the bank account on my team's registration?
instructions:
- text: Set my team registration's legal name to {business_legal_name} and DBA to {business_dba}.
slots:
business_legal_name: query.business_legal_name
business_dba: query.business_dba
- text: Update my team's registration bank routing {bank_routing_number} and account {bank_account_number}.
slots:
bank_routing_number: query.bank_routing_number
bank_account_number: query.bank_account_number
method: generated
generated: '2026-09-26'
- target: $.paths['/team/apikey'].get
update:
x-apievangelist-phrasing:
intent: List my team's API keys
effect: read
questions:
- Which API keys exist on my own team?
- Can I see the API-key users registered to my team?
instructions:
- text: List my team's API keys.
- text: Show the team members that are API keys.
method: generated
generated: '2026-09-26'
- target: $.paths['/team/option/branding'].post
update:
x-apievangelist-phrasing:
intent: Set my team's branding
effect: write
questions:
- Can I upload a logo so customers see my brand?
- Is it possible to set a brand name and image for my team?
instructions:
- text: Set my team branding name to {name} with image {image}.
slots:
name: query.name
image: query.image
- text: Use {image} as my team's brand logo.
slots:
image: query.image
method: generated
generated: '2026-09-26'