Skip to content

Commit 7dcebbb

Browse files
feat: update bitgo-api-docs
This commit updates the BitGo API.
1 parent cda98c6 commit 7dcebbb

File tree

1 file changed

+113
-30
lines changed

1 file changed

+113
-30
lines changed

api.yaml

Lines changed: 113 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2738,6 +2738,7 @@ paths:
27382738
in: query
27392739
schema:
27402740
type: string
2741+
format: integer
27412742
- name: sortField
27422743
description: 'The field to sort results on. Possible values: - id: Sort by allocation ID. - updatedAt: Sort by the last updated timestamp. - quantity: Sort by the allocation amount quantity. - currency: Sort by the allocation currency code. Note: A finals sort is always applied on createdAt ascending and id ascending, regardless of the specified sortField. This ensures consistent ordering for items with the same primary sort value.'
27432744
in: query
@@ -2928,6 +2929,7 @@ paths:
29282929
in: query
29292930
schema:
29302931
type: string
2932+
format: integer
29312933
- name: connectionIds
29322934
description: 'Optional array of connection IDs to filter by. If provided: - Only balances for connections with these specific IDs will be returned. - Useful for monitoring specific trading relationships or connections. - Can be used to focus on particular allocation targets. If omitted, results will include data for all your connections subject to other filters.'
29332935
in: query
@@ -3034,6 +3036,7 @@ paths:
30343036
in: query
30353037
schema:
30363038
type: string
3039+
format: integer
30373040
- name: active
30383041
in: query
30393042
schema:
@@ -4034,6 +4037,7 @@ paths:
40344037
in: query
40354038
schema:
40364039
type: string
4040+
format: integer
40374041
- name: enterpriseId
40384042
description: The enterprise identifier of the client. This identifies the client enterprise that owns the allocation.
40394043
in: path
@@ -4133,6 +4137,7 @@ paths:
41334137
in: query
41344138
schema:
41354139
type: string
4140+
format: integer
41364141
- name: settlementIds
41374142
description: Filter by specific settlement IDs. When provided, only settlements matching these IDs will be returned.
41384143
in: query
@@ -4283,6 +4288,7 @@ paths:
42834288
in: query
42844289
schema:
42854290
type: string
4291+
format: integer
42864292
- name: enterpriseId
42874293
description: The enterprise identifier of the client. This identifies the client enterprise making the API request.
42884294
in: path
@@ -4664,6 +4670,7 @@ paths:
46644670
in: query
46654671
schema:
46664672
type: string
4673+
format: integer
46674674
- name: currencies
46684675
description: Optional array of currencies. If provided will only return settlement transfers with those currencies.
46694676
in: query
@@ -4821,6 +4828,7 @@ paths:
48214828
in: query
48224829
schema:
48234830
type: string
4831+
format: integer
48244832
- name: ids
48254833
description: Filter by specific partner IDs. When provided, only partners with these IDs will be returned.
48264834
in: query
@@ -5119,6 +5127,7 @@ paths:
51195127
in: query
51205128
schema:
51215129
type: string
5130+
format: integer
51225131
- name: sortField
51235132
description: 'The field to sort results on. Possible values: - id: Sort by allocation ID. - updatedAt: Sort by the last updated timestamp. - quantity: Sort by the allocation amount quantity. Note: A final sort is always applied on createdAt ascending and id ascending, regardless of the specified sortField. This ensures consistent ordering for items with the same primary sort value.'
51245133
in: query
@@ -5415,6 +5424,7 @@ paths:
54155424
in: query
54165425
schema:
54175426
type: string
5427+
format: integer
54185428
- name: partnerIds
54195429
description: 'Optional array of partner IDs to filter by. If provided: - Only balances for partners with these IDs will be returned. - Only connections to these partners will be included. - Useful when a partner has multiple partner entities and wants to filter results. If omitted, results will include data for all partners the requester has access to.'
54205430
in: query
@@ -5537,6 +5547,7 @@ paths:
55375547
in: query
55385548
schema:
55395549
type: string
5550+
format: integer
55405551
- name: active
55415552
in: query
55425553
schema:
@@ -5910,6 +5921,7 @@ paths:
59105921
in: query
59115922
schema:
59125923
type: string
5924+
format: integer
59135925
- name: settlementExternalIds
59145926
description: Optional array of settlement externalIds. If provided will only return disputes with a disputedSettlementId of a settlement with an externalId matching one of the provided settlementExternalIds.
59155927
in: query
@@ -6037,6 +6049,7 @@ paths:
60376049
in: query
60386050
schema:
60396051
type: string
6052+
format: integer
60406053
- name: settlementIds
60416054
description: Filter by specific settlement IDs. When provided, only settlements matching these IDs will be returned.
60426055
in: query
@@ -6436,6 +6449,7 @@ paths:
64366449
in: query
64376450
schema:
64386451
type: string
6452+
format: integer
64396453
- name: enterpriseId
64406454
description: The enterprise identifier of the partner. This identifies the partner enterprise making the API request.
64416455
in: path
@@ -63166,12 +63180,6 @@ components:
6316663180
items:
6316763181
type: string
6316863182
minLength: 1
63169-
PolicyResult:
63170-
title: PolicyResult
63171-
type: string
63172-
enum:
63173-
- approved
63174-
- rejected
6317563183
PolicyRule:
6317663184
type: object
6317763185
properties:
@@ -73447,6 +73455,20 @@ components:
7344773455
retriable:
7344873456
type: boolean
7344973457
description: Indicates whether or not the allocation/deallocation is retriable. When true, clients may retry the operation if it did not complete successfully. Retry can be performed by re-sending the same allocation request that was originally sent.
73458+
evaluationId:
73459+
type: string
73460+
description: The unique identifier of the policy evaluation for this allocation/deallocation. Present when policy evaluation was performed as part of the allocation flow.
73461+
minLength: 1
73462+
pendingApprovalId:
73463+
type: string
73464+
description: The unique identifier of the pending approval for this allocation/deallocation. Present when policy evaluation resulted in a PENDING status requiring manual approval.
73465+
minLength: 1
73466+
policyResult:
73467+
type: string
73468+
enum:
73469+
- approved
73470+
- rejected
73471+
description: 'The result of the policy evaluation for this allocation/deallocation. - ''approved'': Policy evaluation passed and the operation was allowed - ''rejected'': Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.'
7345073472
reason:
7345173473
nullable: true
7345273474
type: string
@@ -73540,6 +73562,20 @@ components:
7354073562
retriable:
7354173563
type: boolean
7354273564
description: Indicates whether or not the allocation/deallocation is retriable. When true, clients may retry the operation if it did not complete successfully. Retry can be performed by re-sending the same allocation request that was originally sent.
73565+
evaluationId:
73566+
type: string
73567+
description: The unique identifier of the policy evaluation for this allocation/deallocation. Present when policy evaluation was performed as part of the allocation flow.
73568+
minLength: 1
73569+
pendingApprovalId:
73570+
type: string
73571+
description: The unique identifier of the pending approval for this allocation/deallocation. Present when policy evaluation resulted in a PENDING status requiring manual approval.
73572+
minLength: 1
73573+
policyResult:
73574+
type: string
73575+
enum:
73576+
- approved
73577+
- rejected
73578+
description: 'The result of the policy evaluation for this allocation/deallocation. - ''approved'': Policy evaluation passed and the operation was allowed - ''rejected'': Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.'
7354373579
reason:
7354473580
nullable: true
7354573581
type: string
@@ -73581,8 +73617,6 @@ components:
7358173617
V1AllocationsReleasedWithErrorPostPayload:
7358273618
title: V1AllocationsReleasedWithErrorPostPayload
7358373619
allOf:
73584-
- type: object
73585-
properties: {}
7358673620
- $ref: '#/components/schemas/V1AllocationsReleasedPayload'
7358773621
- $ref: '#/components/schemas/V1ErrorPayload'
7358873622
V1AssignedDisputesWithClosureOutput:
@@ -73692,6 +73726,20 @@ components:
7369273726
enum:
7369373727
- false
7369473728
description: Indicates whether or not the allocation/deallocation is retriable. When true, clients may retry the operation if it did not complete successfully. Retry can be performed by re-sending the same allocation request that was originally sent.
73729+
evaluationId:
73730+
type: string
73731+
description: The unique identifier of the policy evaluation for this allocation/deallocation. Present when policy evaluation was performed as part of the allocation flow.
73732+
minLength: 1
73733+
pendingApprovalId:
73734+
type: string
73735+
description: The unique identifier of the pending approval for this allocation/deallocation. Present when policy evaluation resulted in a PENDING status requiring manual approval.
73736+
minLength: 1
73737+
policyResult:
73738+
type: string
73739+
enum:
73740+
- approved
73741+
- rejected
73742+
description: 'The result of the policy evaluation for this allocation/deallocation. - ''approved'': Policy evaluation passed and the operation was allowed - ''rejected'': Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.'
7369573743
status:
7369673744
type: string
7369773745
enum:
@@ -74067,17 +74115,19 @@ components:
7406774115
description: A nonce value used in the connection cryptographic operations. This provides additional security for connection operations.
7406874116
minLength: 1
7406974117
evaluationId:
74070-
nullable: true
7407174118
type: string
74119+
description: The unique identifier of the policy evaluation for this connection.
7407274120
minLength: 1
7407374121
pendingApprovalId:
74074-
nullable: true
7407574122
type: string
74123+
description: The unique identifier of the pending approval for this connection.
7407674124
minLength: 1
7407774125
policyResult:
74078-
nullable: true
74079-
allOf:
74080-
- $ref: '#/components/schemas/PolicyResult'
74126+
type: string
74127+
enum:
74128+
- approved
74129+
- rejected
74130+
description: 'The result of the policy evaluation for this connection. - ''approved'': Policy evaluation passed and the operation was allowed - ''rejected'': Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.'
7408174131
partnersConnectionId:
7408274132
nullable: true
7408374133
type: string
@@ -74102,9 +74152,6 @@ components:
7410274152
- active
7410374153
- proof
7410474154
- nonce
74105-
- evaluationId
74106-
- pendingApprovalId
74107-
- policyResult
7410874155
- partnersConnectionId
7410974156
- partnersClientId
7411074157
- initialized
@@ -74265,17 +74312,19 @@ components:
7426574312
description: A nonce value used in the connection cryptographic operations. This provides additional security for connection operations.
7426674313
minLength: 1
7426774314
evaluationId:
74268-
nullable: true
7426974315
type: string
74316+
description: The unique identifier of the policy evaluation for this connection.
7427074317
minLength: 1
7427174318
pendingApprovalId:
74272-
nullable: true
7427374319
type: string
74320+
description: The unique identifier of the pending approval for this connection.
7427474321
minLength: 1
7427574322
policyResult:
74276-
nullable: true
74277-
allOf:
74278-
- $ref: '#/components/schemas/PolicyResult'
74323+
type: string
74324+
enum:
74325+
- approved
74326+
- rejected
74327+
description: 'The result of the policy evaluation for this connection. - ''approved'': Policy evaluation passed and the operation was allowed - ''rejected'': Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.'
7427974328
partnersConnectionId:
7428074329
nullable: true
7428174330
type: string
@@ -74300,9 +74349,6 @@ components:
7430074349
- active
7430174350
- proof
7430274351
- nonce
74303-
- evaluationId
74304-
- pendingApprovalId
74305-
- policyResult
7430674352
- partnersConnectionId
7430774353
- partnersClientId
7430874354
- initialized
@@ -74336,8 +74382,6 @@ components:
7433674382
V1DeallocationReleasedWithErrorPostPayload:
7433774383
title: V1DeallocationReleasedWithErrorPostPayload
7433874384
allOf:
74339-
- type: object
74340-
properties: {}
7434174385
- $ref: '#/components/schemas/V1DeallocationReleasedPayload'
7434274386
- $ref: '#/components/schemas/V1ErrorPayload'
7434374387
V1DeleteBankAccountResponse:
@@ -75573,6 +75617,20 @@ components:
7557375617
enum:
7557475618
- false
7557575619
description: Indicates whether or not the allocation/deallocation is retriable. When true, clients may retry the operation if it did not complete successfully. Retry can be performed by re-sending the same allocation request that was originally sent.
75620+
evaluationId:
75621+
type: string
75622+
description: The unique identifier of the policy evaluation for this allocation/deallocation. Present when policy evaluation was performed as part of the allocation flow.
75623+
minLength: 1
75624+
pendingApprovalId:
75625+
type: string
75626+
description: The unique identifier of the pending approval for this allocation/deallocation. Present when policy evaluation resulted in a PENDING status requiring manual approval.
75627+
minLength: 1
75628+
policyResult:
75629+
type: string
75630+
enum:
75631+
- approved
75632+
- rejected
75633+
description: 'The result of the policy evaluation for this allocation/deallocation. - ''approved'': Policy evaluation passed and the operation was allowed - ''rejected'': Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.'
7557675634
status:
7557775635
type: string
7557875636
enum:
@@ -75666,6 +75724,20 @@ components:
7566675724
enum:
7566775725
- false
7566875726
description: Indicates whether or not the allocation/deallocation is retriable. When true, clients may retry the operation if it did not complete successfully. Retry can be performed by re-sending the same allocation request that was originally sent.
75727+
evaluationId:
75728+
type: string
75729+
description: The unique identifier of the policy evaluation for this allocation/deallocation. Present when policy evaluation was performed as part of the allocation flow.
75730+
minLength: 1
75731+
pendingApprovalId:
75732+
type: string
75733+
description: The unique identifier of the pending approval for this allocation/deallocation. Present when policy evaluation resulted in a PENDING status requiring manual approval.
75734+
minLength: 1
75735+
policyResult:
75736+
type: string
75737+
enum:
75738+
- approved
75739+
- rejected
75740+
description: 'The result of the policy evaluation for this allocation/deallocation. - ''approved'': Policy evaluation passed and the operation was allowed - ''rejected'': Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.'
7566975741
reason:
7567075742
type: string
7567175743
description: The reason that the allocation/deallocation is not cleared. Provides a descriptive explanation for why the allocation is in the reserved state. Will not be defined if the allocation is cleared.
@@ -75744,6 +75816,20 @@ components:
7574475816
enum:
7574575817
- true
7574675818
description: Indicates whether or not the allocation/deallocation is retriable. When true, clients may retry the operation if it did not complete successfully. Retry can be performed by re-sending the same allocation request that was originally sent.
75819+
evaluationId:
75820+
type: string
75821+
description: The unique identifier of the policy evaluation for this allocation/deallocation. Present when policy evaluation was performed as part of the allocation flow.
75822+
minLength: 1
75823+
pendingApprovalId:
75824+
type: string
75825+
description: The unique identifier of the pending approval for this allocation/deallocation. Present when policy evaluation resulted in a PENDING status requiring manual approval.
75826+
minLength: 1
75827+
policyResult:
75828+
type: string
75829+
enum:
75830+
- approved
75831+
- rejected
75832+
description: 'The result of the policy evaluation for this allocation/deallocation. - ''approved'': Policy evaluation passed and the operation was allowed - ''rejected'': Policy evaluation failed and the operation was denied Not present if no policy evaluation was performed or if evaluation is still pending.'
7574775833
reason:
7574875834
type: string
7574975835
description: The reason that the allocation/deallocation is not cleared. Provides a descriptive explanation for why the allocation is in the reserved state. Will not be defined if the allocation is cleared.
@@ -75805,10 +75891,7 @@ components:
7580575891
additionalProperties:
7580675892
type: array
7580775893
items:
75808-
allOf:
75809-
- type: object
75810-
properties: {}
75811-
- $ref: '#/components/schemas/BNMetadata'
75894+
$ref: '#/components/schemas/BNMetadata'
7581275895
V1UpdateBankAccountResponse:
7581375896
title: V1UpdateBankAccountResponse
7581475897
allOf:

0 commit comments

Comments
 (0)