Spade · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Spade Merchant Action Triggers API
17 actions
17 updates
phrasing
extends
openapi/spade-merchant-action-triggers-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Spade's API. It is a proposal applied on top of the contract, not a document Spade publishes.
What the actions change
x-apievangelist-phrasing
Targets 17 · first 16 shown; the file carries all of them
$.info
$.paths['/merchant-action-triggers'].get
$.paths['/merchant-action-triggers'].put
$.paths['/merchant-action-triggers'].delete
$.paths['/merchant-action-triggers'].patch
$.paths['/programs/{programId}/merchant-action-triggers'].get
$.paths['/programs/{programId}/merchant-action-triggers'].put
$.paths['/programs/{programId}/merchant-action-triggers'].delete
$.paths['/programs/{programId}/merchant-action-triggers'].patch
$.paths['/users/{userId}/merchant-action-triggers'].get
$.paths['/users/{userId}/merchant-action-triggers'].put
$.paths['/users/{userId}/merchant-action-triggers'].delete
$.paths['/users/{userId}/merchant-action-triggers'].patch
$.paths['/users/{userId}/cards/{cardId}/merchant-action-triggers'].get
$.paths['/users/{userId}/cards/{cardId}/merchant-action-triggers'].put
$.paths['/users/{userId}/cards/{cardId}/merchant-action-triggers'].delete
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 Spade Merchant Action Triggers API
version: 1.0.0
extends: openapi/spade-merchant-action-triggers-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: 16
- target: $.paths['/merchant-action-triggers'].get
update:
x-apievangelist-phrasing:
intent: Check account-wide merchant trigger status
effect: read
questions:
- Has my account-wide merchant trigger registration finished processing?
- Which version of merchant triggers applies to every user in my account?
instructions:
- text: Show the status and version of my account-level merchant triggers.
- text: Confirm the account-wide merchant trigger batch has succeeded.
method: generated
generated: '2026-10-01'
- target: $.paths['/merchant-action-triggers'].put
update:
x-apievangelist-phrasing:
intent: Replace account-wide merchant triggers
effect: write
questions:
- How do I flag transactions at specific merchants for all users in my Spade account?
- Do I need a website for a merchant trigger when I don't have its address or city?
- What happens when I register more than 100 merchant triggers at the account level?
instructions:
- text: Register these merchant triggers {merchantTriggers} for my entire account.
slots:
merchantTriggers: requestBody.merchantTriggers
- text: Overwrite the account-wide merchant trigger list with {merchantTriggers}.
slots:
merchantTriggers: requestBody.merchantTriggers
method: generated
generated: '2026-10-01'
- target: $.paths['/merchant-action-triggers'].delete
update:
x-apievangelist-phrasing:
intent: Clear all account-wide merchant triggers
effect: destructive
questions:
- How do I remove every merchant trigger registered at the account level?
- Does clearing account merchant triggers create a new empty version?
instructions:
- text: Remove all merchant action triggers at my account scope.
- text: Empty out the account-level merchant trigger list.
method: generated
generated: '2026-10-01'
- target: $.paths['/merchant-action-triggers'].patch
update:
x-apievangelist-phrasing:
intent: Add or remove individual account merchant triggers
effect: write
questions:
- Can I add a few merchants to my account triggers without resending the whole list?
- Is there a way to delete specific account-level merchant triggers by ID?
instructions:
- text: Add merchant triggers {merchantTriggers} to my account, keeping the existing ones ({operation}).
slots:
merchantTriggers: requestBody.merchantTriggers
operation: requestBody.operation
- text: Run a {operation} on account merchant triggers with IDs {triggerIds}.
slots:
operation: requestBody.operation
triggerIds: requestBody.triggerIds
method: generated
generated: '2026-10-01'
- target: $.paths['/programs/{programId}/merchant-action-triggers'].get
update:
x-apievangelist-phrasing:
intent: Check a program's merchant trigger status
effect: read
questions:
- Are the merchant triggers for one of my programs active yet?
- What version of merchant triggers is registered for a specific program?
instructions:
- text: Show the merchant trigger status for program {programId}.
slots:
programId: path.programId
- text: Check whether program {programId} merchant trigger registration succeeded.
slots:
programId: path.programId
method: generated
generated: '2026-10-01'
- target: $.paths['/programs/{programId}/merchant-action-triggers'].put
update:
x-apievangelist-phrasing:
intent: Replace a program's merchant triggers
effect: write
questions:
- How do I attach merchant actions only to transactions tagged with one program?
- Can each program have its own list of watched merchants?
instructions:
- text: Register merchant triggers {merchantTriggers} for program {programId}.
slots:
merchantTriggers: requestBody.merchantTriggers
programId: path.programId
- text: Overwrite program {programId}'s merchant trigger list with {merchantTriggers}.
slots:
programId: path.programId
merchantTriggers: requestBody.merchantTriggers
method: generated
generated: '2026-10-01'
- target: $.paths['/programs/{programId}/merchant-action-triggers'].delete
update:
x-apievangelist-phrasing:
intent: Clear a program's merchant triggers
effect: destructive
questions:
- How do I remove every merchant trigger from a single program?
- Can I reset one program's merchant actions without touching account-wide ones?
instructions:
- text: Clear all merchant triggers for program {programId}.
slots:
programId: path.programId
- text: Empty the merchant trigger list on program {programId}.
slots:
programId: path.programId
method: generated
generated: '2026-10-01'
- target: $.paths['/programs/{programId}/merchant-action-triggers'].patch
update:
x-apievangelist-phrasing:
intent: Add or remove a program's merchant triggers
effect: write
questions:
- How many merchant triggers can I add to a program in one incremental request?
- How do I drop specific merchant trigger IDs from one program?
instructions:
- text: Add merchant triggers {merchantTriggers} to program {programId} using operation {operation}.
slots:
merchantTriggers: requestBody.merchantTriggers
programId: path.programId
operation: requestBody.operation
- text: Apply {operation} to program {programId} merchant triggers {triggerIds}.
slots:
operation: requestBody.operation
programId: path.programId
triggerIds: requestBody.triggerIds
method: generated
generated: '2026-10-01'
- target: $.paths['/users/{userId}/merchant-action-triggers'].get
update:
x-apievangelist-phrasing:
intent: Check a user's merchant trigger status
effect: read
questions:
- Are the merchant triggers for one particular user registered successfully?
- What merchant trigger version applies to all cards of a given user?
instructions:
- text: Show the merchant trigger status for user {userId}.
slots:
userId: path.userId
- text: Check if user {userId}'s merchant triggers are active.
slots:
userId: path.userId
method: generated
generated: '2026-10-01'
- target: $.paths['/users/{userId}/merchant-action-triggers'].put
update:
x-apievangelist-phrasing:
intent: Replace a user's merchant triggers
effect: write
questions:
- How do I watch specific merchants for every card a single user holds?
- Is there a limit of 100 merchant triggers per request for a user?
instructions:
- text: Register merchant triggers {merchantTriggers} for user {userId}.
slots:
merchantTriggers: requestBody.merchantTriggers
userId: path.userId
- text: Overwrite user {userId}'s merchant trigger list with {merchantTriggers}.
slots:
userId: path.userId
merchantTriggers: requestBody.merchantTriggers
method: generated
generated: '2026-10-01'
- target: $.paths['/users/{userId}/merchant-action-triggers'].delete
update:
x-apievangelist-phrasing:
intent: Clear a user's merchant triggers
effect: destructive
questions:
- How do I wipe out all merchant triggers for one user?
- Can I reset a single user's merchant actions to nothing?
instructions:
- text: Clear all merchant triggers for user {userId}.
slots:
userId: path.userId
- text: Empty the merchant trigger list for user {userId}.
slots:
userId: path.userId
method: generated
generated: '2026-10-01'
- target: $.paths['/users/{userId}/merchant-action-triggers'].patch
update:
x-apievangelist-phrasing:
intent: Add or remove a user's merchant triggers
effect: write
questions:
- Can I add one merchant trigger for a user without replacing their others?
- How do I remove particular merchant trigger IDs for a single user?
instructions:
- text: Add merchant triggers {merchantTriggers} for user {userId} with operation {operation}.
slots:
merchantTriggers: requestBody.merchantTriggers
userId: path.userId
operation: requestBody.operation
- text: Apply {operation} to user {userId}'s merchant triggers {triggerIds}.
slots:
operation: requestBody.operation
userId: path.userId
triggerIds: requestBody.triggerIds
method: generated
generated: '2026-10-01'
- target: $.paths['/users/{userId}/cards/{cardId}/merchant-action-triggers'].get
update:
x-apievangelist-phrasing:
intent: Check a card's merchant trigger status
effect: read
questions:
- Are the merchant triggers on one specific card registered and active?
- Which merchant trigger version applies to a single card only?
instructions:
- text: Show the merchant trigger status for card {cardId} of user {userId}.
slots:
cardId: path.cardId
userId: path.userId
- text: Check whether card {cardId} belonging to {userId} has succeeded merchant triggers.
slots:
cardId: path.cardId
userId: path.userId
method: generated
generated: '2026-10-01'
- target: $.paths['/users/{userId}/cards/{cardId}/merchant-action-triggers'].put
update:
x-apievangelist-phrasing:
intent: Replace a card's merchant triggers
effect: write
questions:
- How do I watch certain merchants on one card but not the user's other cards?
- Can a single card carry its own merchant trigger list?
instructions:
- text: Register merchant triggers {merchantTriggers} on card {cardId} for user {userId}.
slots:
merchantTriggers: requestBody.merchantTriggers
cardId: path.cardId
userId: path.userId
- text: Overwrite the merchant triggers on user {userId}'s card {cardId} with {merchantTriggers}.
slots:
userId: path.userId
cardId: path.cardId
merchantTriggers: requestBody.merchantTriggers
method: generated
generated: '2026-10-01'
- target: $.paths['/users/{userId}/cards/{cardId}/merchant-action-triggers'].delete
update:
x-apievangelist-phrasing:
intent: Clear a card's merchant triggers
effect: destructive
questions:
- How do I remove every merchant trigger from one card?
- Can I clear a card's merchant actions while keeping the user-level ones?
instructions:
- text: Clear all merchant triggers on card {cardId} for user {userId}.
slots:
cardId: path.cardId
userId: path.userId
- text: Empty the merchant trigger list for user {userId}'s card {cardId}.
slots:
userId: path.userId
cardId: path.cardId
method: generated
generated: '2026-10-01'
- target: $.paths['/users/{userId}/cards/{cardId}/merchant-action-triggers'].patch
update:
x-apievangelist-phrasing:
intent: Add or remove a card's merchant triggers
effect: write
questions:
- Can I add a merchant trigger to just one card incrementally?
- How do I drop specific merchant trigger IDs from a single card?
instructions:
- text: Add merchant triggers {merchantTriggers} to card {cardId} of user {userId} via {operation}.
slots:
merchantTriggers: requestBody.merchantTriggers
cardId: path.cardId
userId: path.userId
operation: requestBody.operation
- text: Apply {operation} to card {cardId} (user {userId}) merchant triggers {triggerIds}.
slots:
operation: requestBody.operation
cardId: path.cardId
userId: path.userId
triggerIds: requestBody.triggerIds
method: generated
generated: '2026-10-01'