Skip to content

Commit c12f489

Browse files
feat: update bitgo-api-docs
This commit updates the BitGo API.
1 parent 6459ce9 commit c12f489

File tree

1 file changed

+161
-0
lines changed

1 file changed

+161
-0
lines changed

api.yaml

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11410,6 +11410,58 @@ paths:
1141011410
application/json:
1141111411
schema:
1141211412
type: object
11413+
/api/notifications/v1/mute/wallet:
11414+
put:
11415+
tags:
11416+
- User Management Notification
11417+
summary: Mute wallet notifications
11418+
description: Mutes notifications from a specific wallet for the authenticated user. Uses PUT as this operation creates or updates existing mute settings.
11419+
operationId: muteWallet
11420+
parameters:
11421+
- name: request-id
11422+
in: header
11423+
required: false
11424+
schema:
11425+
type: string
11426+
requestBody:
11427+
content:
11428+
application/json:
11429+
schema:
11430+
$ref: '#/components/schemas/MuteWalletRequest'
11431+
required: true
11432+
responses:
11433+
'200':
11434+
description: Wallet notifications muted successfully
11435+
content:
11436+
application/json:
11437+
schema:
11438+
$ref: '#/components/schemas/MuteResponse'
11439+
/api/notifications/v1/mute/enterprise:
11440+
put:
11441+
tags:
11442+
- User Management Notification
11443+
summary: Mute enterprise notifications
11444+
description: Mutes notifications from a specific enterprise for the authenticated user. Uses PUT as this operation creates or updates existing mute settings.
11445+
operationId: muteEnterprise
11446+
parameters:
11447+
- name: request-id
11448+
in: header
11449+
required: false
11450+
schema:
11451+
type: string
11452+
requestBody:
11453+
content:
11454+
application/json:
11455+
schema:
11456+
$ref: '#/components/schemas/MuteEnterpriseRequest'
11457+
required: true
11458+
responses:
11459+
'200':
11460+
description: Enterprise notifications muted successfully
11461+
content:
11462+
application/json:
11463+
schema:
11464+
$ref: '#/components/schemas/MuteResponse'
1141311465
/api/notifications/v1/tokens:
1141411466
post:
1141511467
tags:
@@ -11436,6 +11488,26 @@ paths:
1143611488
application/json:
1143711489
schema:
1143811490
$ref: '#/components/schemas/AddDeviceTokenResponse'
11491+
/api/notifications/v1/mute:
11492+
get:
11493+
tags:
11494+
- User Management Notification
11495+
summary: Get notification mute settings
11496+
description: Retrieves the current notification mute settings for the authenticated user.
11497+
operationId: getMuteSettings
11498+
parameters:
11499+
- name: request-id
11500+
in: header
11501+
required: false
11502+
schema:
11503+
type: string
11504+
responses:
11505+
'200':
11506+
description: Mute settings retrieved successfully
11507+
content:
11508+
application/json:
11509+
schema:
11510+
$ref: '#/components/schemas/MuteResponse'
1143911511
/api/notifications/v1/categories:
1144011512
get:
1144111513
tags:
@@ -11481,6 +11553,56 @@ paths:
1148111553
application/json:
1148211554
schema:
1148311555
$ref: '#/components/schemas/DeleteDeviceTokenResponse'
11556+
/api/notifications/v1/mute/wallet/{walletId}:
11557+
delete:
11558+
tags:
11559+
- User Management Notification
11560+
summary: Unmute wallet notifications
11561+
description: Unmutes notifications from a specific wallet for the authenticated user.
11562+
operationId: unmuteWallet
11563+
parameters:
11564+
- name: walletId
11565+
in: path
11566+
required: true
11567+
schema:
11568+
type: string
11569+
- name: request-id
11570+
in: header
11571+
required: false
11572+
schema:
11573+
type: string
11574+
responses:
11575+
'202':
11576+
description: Wallet notifications unmuted successfully
11577+
content:
11578+
application/json:
11579+
schema:
11580+
$ref: '#/components/schemas/MuteResponse'
11581+
/api/notifications/v1/mute/enterprise/{enterpriseId}:
11582+
delete:
11583+
tags:
11584+
- User Management Notification
11585+
summary: Unmute enterprise notifications
11586+
description: Unmutes notifications from a specific enterprise for the authenticated user.
11587+
operationId: unmuteEnterprise
11588+
parameters:
11589+
- name: enterpriseId
11590+
in: path
11591+
required: true
11592+
schema:
11593+
type: string
11594+
- name: request-id
11595+
in: header
11596+
required: false
11597+
schema:
11598+
type: string
11599+
responses:
11600+
'202':
11601+
description: Enterprise notifications unmuted successfully
11602+
content:
11603+
application/json:
11604+
schema:
11605+
$ref: '#/components/schemas/MuteResponse'
1148411606
/api/org/enterprise/{enterpriseId}:
1148511607
get:
1148611608
operationId: org.enterprise
@@ -58819,6 +58941,45 @@ components:
5881958941
enum:
5882058942
- managed
5882158943
- permanent
58944+
MuteEnterpriseRequest:
58945+
required:
58946+
- enterpriseId
58947+
type: object
58948+
properties:
58949+
enterpriseId:
58950+
maxLength: 100
58951+
minLength: 0
58952+
type: string
58953+
MuteResponse:
58954+
required:
58955+
- message
58956+
- success
58957+
- userId
58958+
type: object
58959+
properties:
58960+
userId:
58961+
type: string
58962+
success:
58963+
type: boolean
58964+
message:
58965+
type: string
58966+
mutedEnterpriseIds:
58967+
type: array
58968+
items:
58969+
type: string
58970+
mutedWalletIds:
58971+
type: array
58972+
items:
58973+
type: string
58974+
MuteWalletRequest:
58975+
required:
58976+
- walletId
58977+
type: object
58978+
properties:
58979+
walletId:
58980+
maxLength: 100
58981+
minLength: 0
58982+
type: string
5882258983
Name:
5882358984
type: object
5882458985
properties:

0 commit comments

Comments
 (0)