@aws-sdk/client-bedrock-agentcore 3.1049.0 → 3.1051.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/models/errors.js +15 -15
- package/dist-es/models/errors.js +13 -13
- package/dist-types/commands/CreatePaymentInstrumentCommand.d.ts +1 -1
- package/dist-types/commands/CreatePaymentSessionCommand.d.ts +1 -1
- package/dist-types/commands/DeletePaymentInstrumentCommand.d.ts +1 -19
- package/dist-types/commands/DeletePaymentSessionCommand.d.ts +1 -15
- package/dist-types/commands/GetPaymentInstrumentBalanceCommand.d.ts +1 -1
- package/dist-types/commands/GetPaymentInstrumentCommand.d.ts +1 -1
- package/dist-types/commands/GetPaymentSessionCommand.d.ts +1 -1
- package/dist-types/commands/GetResourcePaymentTokenCommand.d.ts +1 -1
- package/dist-types/commands/InvokeAgentRuntimeCommand.d.ts +3 -0
- package/dist-types/commands/ListPaymentInstrumentsCommand.d.ts +1 -1
- package/dist-types/commands/ListPaymentSessionsCommand.d.ts +1 -1
- package/dist-types/commands/ProcessPaymentCommand.d.ts +1 -1
- package/dist-types/commands/StopRuntimeSessionCommand.d.ts +3 -0
- package/dist-types/models/enums.d.ts +5 -5
- package/dist-types/models/errors.d.ts +13 -13
- package/dist-types/models/models_0.d.ts +38 -40
- package/dist-types/models/models_1.d.ts +187 -210
- package/dist-types/ts3.4/models/errors.d.ts +8 -8
- package/package.json +1 -1
|
@@ -37,12 +37,12 @@ export interface RetrieveMemoryRecordsInput {
|
|
|
37
37
|
*/
|
|
38
38
|
memoryId: string | undefined;
|
|
39
39
|
/**
|
|
40
|
-
* <p>The namespace prefix to filter memory records by. Searches for memory records in namespaces that start with the provided prefix.</p>
|
|
40
|
+
* <p>The namespace prefix to filter memory records by. Searches for memory records in namespaces that start with the provided prefix. Either <code>namespace</code> or <code>namespacePath</code> is required.</p>
|
|
41
41
|
* @public
|
|
42
42
|
*/
|
|
43
43
|
namespace?: string | undefined;
|
|
44
44
|
/**
|
|
45
|
-
* <p>Use namespacePath for hierarchical retrievals. Return all memory records where namespace falls under the same parent hierarchy.</p>
|
|
45
|
+
* <p>Use namespacePath for hierarchical retrievals. Return all memory records where namespace falls under the same parent hierarchy. Either <code>namespace</code> or <code>namespacePath</code> is required.</p>
|
|
46
46
|
* @public
|
|
47
47
|
*/
|
|
48
48
|
namespacePath?: string | undefined;
|
|
@@ -119,66 +119,60 @@ export interface StartMemoryExtractionJobOutput {
|
|
|
119
119
|
jobId: string | undefined;
|
|
120
120
|
}
|
|
121
121
|
/**
|
|
122
|
-
* Authentication method using JWT with key ID and subject claims
|
|
122
|
+
* <p>Authentication method using JWT with key ID and subject claims.</p>
|
|
123
123
|
* @public
|
|
124
124
|
*/
|
|
125
125
|
export interface LinkedAccountDeveloperJwt {
|
|
126
126
|
/**
|
|
127
|
-
* The key ID (kid) from the JWT header.
|
|
128
|
-
* Identifies which key was used to sign the JWT.
|
|
127
|
+
* <p>The key ID (kid) from the JWT header. Identifies which key was used to sign the JWT.</p>
|
|
129
128
|
* @public
|
|
130
129
|
*/
|
|
131
130
|
kid: string | undefined;
|
|
132
131
|
/**
|
|
133
|
-
* The subject (sub) claim from the JWT payload.
|
|
134
|
-
* Identifies the principal that is the subject of the JWT.
|
|
132
|
+
* <p>The subject (sub) claim from the JWT payload. Identifies the principal that is the subject of the JWT.</p>
|
|
135
133
|
* @public
|
|
136
134
|
*/
|
|
137
135
|
sub: string | undefined;
|
|
138
136
|
}
|
|
139
137
|
/**
|
|
140
|
-
*
|
|
138
|
+
* <p>Linked account using an email address.</p>
|
|
141
139
|
* @public
|
|
142
140
|
*/
|
|
143
141
|
export interface LinkedAccountEmail {
|
|
144
142
|
/**
|
|
145
|
-
* The email address used for
|
|
146
|
-
* Must be a valid email format.
|
|
143
|
+
* <p>The email address used for the linked account. Must be a valid email format.</p>
|
|
147
144
|
* @public
|
|
148
145
|
*/
|
|
149
146
|
emailAddress: string | undefined;
|
|
150
147
|
}
|
|
151
148
|
/**
|
|
152
|
-
* OAuth2 authentication information for third-party providers
|
|
153
|
-
* Supports Google, Apple, X, Telegram, and GitHub providers.
|
|
149
|
+
* <p>OAuth2 authentication information for third-party providers.</p>
|
|
154
150
|
* @public
|
|
155
151
|
*/
|
|
156
152
|
export interface OAuth2Authentication {
|
|
157
153
|
/**
|
|
158
|
-
* The subject (sub) claim from the OAuth2 provider.
|
|
159
|
-
* Uniquely identifies the user at the provider.
|
|
154
|
+
* <p>The subject (sub) claim from the OAuth2 provider. Uniquely identifies the user at the provider.</p>
|
|
160
155
|
* @public
|
|
161
156
|
*/
|
|
162
157
|
sub: string | undefined;
|
|
163
158
|
/**
|
|
164
|
-
* The email address from the OAuth2 provider
|
|
159
|
+
* <p>The email address from the OAuth2 provider.</p>
|
|
165
160
|
* @public
|
|
166
161
|
*/
|
|
167
162
|
emailAddress?: string | undefined;
|
|
168
163
|
/**
|
|
169
|
-
* The user's name from the OAuth2 provider
|
|
164
|
+
* <p>The user's name from the OAuth2 provider.</p>
|
|
170
165
|
* @public
|
|
171
166
|
*/
|
|
172
167
|
name?: string | undefined;
|
|
173
168
|
/**
|
|
174
|
-
* The username from the OAuth2 provider
|
|
169
|
+
* <p>The username from the OAuth2 provider.</p>
|
|
175
170
|
* @public
|
|
176
171
|
*/
|
|
177
172
|
username?: string | undefined;
|
|
178
173
|
}
|
|
179
174
|
/**
|
|
180
|
-
* Authentication method using OAuth2 providers.
|
|
181
|
-
* Supports Google, Apple, X, Telegram, and GitHub providers.
|
|
175
|
+
* <p>Authentication method using OAuth2 providers. Supports Google, Apple, X, Telegram, and GitHub providers.</p>
|
|
182
176
|
* @public
|
|
183
177
|
*/
|
|
184
178
|
export type LinkedAccountOAuth2 = LinkedAccountOAuth2.AppleMember | LinkedAccountOAuth2.GithubMember | LinkedAccountOAuth2.GoogleMember | LinkedAccountOAuth2.TelegramMember | LinkedAccountOAuth2.XMember | LinkedAccountOAuth2.$UnknownMember;
|
|
@@ -187,7 +181,7 @@ export type LinkedAccountOAuth2 = LinkedAccountOAuth2.AppleMember | LinkedAccoun
|
|
|
187
181
|
*/
|
|
188
182
|
export declare namespace LinkedAccountOAuth2 {
|
|
189
183
|
/**
|
|
190
|
-
* Google OAuth2 authentication
|
|
184
|
+
* <p>Google OAuth2 authentication.</p>
|
|
191
185
|
* @public
|
|
192
186
|
*/
|
|
193
187
|
interface GoogleMember {
|
|
@@ -199,7 +193,7 @@ export declare namespace LinkedAccountOAuth2 {
|
|
|
199
193
|
$unknown?: never;
|
|
200
194
|
}
|
|
201
195
|
/**
|
|
202
|
-
* Apple OAuth2 authentication
|
|
196
|
+
* <p>Apple OAuth2 authentication.</p>
|
|
203
197
|
* @public
|
|
204
198
|
*/
|
|
205
199
|
interface AppleMember {
|
|
@@ -211,7 +205,7 @@ export declare namespace LinkedAccountOAuth2 {
|
|
|
211
205
|
$unknown?: never;
|
|
212
206
|
}
|
|
213
207
|
/**
|
|
214
|
-
* X (formerly Twitter) OAuth2 authentication
|
|
208
|
+
* <p>X (formerly Twitter) OAuth2 authentication.</p>
|
|
215
209
|
* @public
|
|
216
210
|
*/
|
|
217
211
|
interface XMember {
|
|
@@ -223,7 +217,7 @@ export declare namespace LinkedAccountOAuth2 {
|
|
|
223
217
|
$unknown?: never;
|
|
224
218
|
}
|
|
225
219
|
/**
|
|
226
|
-
* Telegram OAuth2 authentication
|
|
220
|
+
* <p>Telegram OAuth2 authentication.</p>
|
|
227
221
|
* @public
|
|
228
222
|
*/
|
|
229
223
|
interface TelegramMember {
|
|
@@ -235,7 +229,7 @@ export declare namespace LinkedAccountOAuth2 {
|
|
|
235
229
|
$unknown?: never;
|
|
236
230
|
}
|
|
237
231
|
/**
|
|
238
|
-
* GitHub OAuth2 authentication
|
|
232
|
+
* <p>GitHub OAuth2 authentication.</p>
|
|
239
233
|
* @public
|
|
240
234
|
*/
|
|
241
235
|
interface GithubMember {
|
|
@@ -271,20 +265,18 @@ export declare namespace LinkedAccountOAuth2 {
|
|
|
271
265
|
}
|
|
272
266
|
}
|
|
273
267
|
/**
|
|
274
|
-
*
|
|
268
|
+
* <p>Linked account using a phone number in E.164 format.</p>
|
|
275
269
|
* @public
|
|
276
270
|
*/
|
|
277
271
|
export interface LinkedAccountSms {
|
|
278
272
|
/**
|
|
279
|
-
* The phone number in E.164 format (e.g., +1234567890)
|
|
280
|
-
* Must be a valid E.164 formatted phone number starting with + and containing 1-15 digits.
|
|
273
|
+
* <p>The phone number in E.164 format (e.g., +1234567890).</p>
|
|
281
274
|
* @public
|
|
282
275
|
*/
|
|
283
276
|
phoneNumber: string | undefined;
|
|
284
277
|
}
|
|
285
278
|
/**
|
|
286
|
-
* Represents different
|
|
287
|
-
* This union supports multiple linkedAccount approaches: email, SMS, JWT, and OAuth2.
|
|
279
|
+
* <p>Represents different linked accounts that can be linked to an embedded wallet. Supports email, SMS, JWT, and OAuth2 approaches.</p>
|
|
288
280
|
* @public
|
|
289
281
|
*/
|
|
290
282
|
export type LinkedAccount = LinkedAccount.DeveloperJwtMember | LinkedAccount.EmailMember | LinkedAccount.OAuth2Member | LinkedAccount.SmsMember | LinkedAccount.$UnknownMember;
|
|
@@ -293,7 +285,7 @@ export type LinkedAccount = LinkedAccount.DeveloperJwtMember | LinkedAccount.Ema
|
|
|
293
285
|
*/
|
|
294
286
|
export declare namespace LinkedAccount {
|
|
295
287
|
/**
|
|
296
|
-
* Email-based
|
|
288
|
+
* <p>Email-based linked account.</p>
|
|
297
289
|
* @public
|
|
298
290
|
*/
|
|
299
291
|
interface EmailMember {
|
|
@@ -304,7 +296,7 @@ export declare namespace LinkedAccount {
|
|
|
304
296
|
$unknown?: never;
|
|
305
297
|
}
|
|
306
298
|
/**
|
|
307
|
-
* SMS-based
|
|
299
|
+
* <p>SMS-based linked account using phone number.</p>
|
|
308
300
|
* @public
|
|
309
301
|
*/
|
|
310
302
|
interface SmsMember {
|
|
@@ -315,7 +307,7 @@ export declare namespace LinkedAccount {
|
|
|
315
307
|
$unknown?: never;
|
|
316
308
|
}
|
|
317
309
|
/**
|
|
318
|
-
* Developer JWT
|
|
310
|
+
* <p>Developer JWT linked account with key ID and subject.</p>
|
|
319
311
|
* @public
|
|
320
312
|
*/
|
|
321
313
|
interface DeveloperJwtMember {
|
|
@@ -326,7 +318,7 @@ export declare namespace LinkedAccount {
|
|
|
326
318
|
$unknown?: never;
|
|
327
319
|
}
|
|
328
320
|
/**
|
|
329
|
-
* OAuth2 provider
|
|
321
|
+
* <p>OAuth2 provider linked account (Google, Apple, X, Telegram, GitHub).</p>
|
|
330
322
|
* @public
|
|
331
323
|
*/
|
|
332
324
|
interface OAuth2Member {
|
|
@@ -359,37 +351,33 @@ export declare namespace LinkedAccount {
|
|
|
359
351
|
}
|
|
360
352
|
}
|
|
361
353
|
/**
|
|
362
|
-
* Embedded
|
|
354
|
+
* <p>Embedded crypto wallet instrument details.</p>
|
|
363
355
|
* @public
|
|
364
356
|
*/
|
|
365
357
|
export interface EmbeddedCryptoWallet {
|
|
366
358
|
/**
|
|
367
|
-
* The blockchain network for this embedded crypto wallet.
|
|
368
|
-
* Supported networks: ETHEREUM, SOLANA
|
|
359
|
+
* <p>The blockchain network for this embedded crypto wallet. Supported networks: ETHEREUM, SOLANA.</p>
|
|
369
360
|
* @public
|
|
370
361
|
*/
|
|
371
362
|
network: CryptoWalletNetwork | undefined;
|
|
372
363
|
/**
|
|
373
|
-
* List of
|
|
374
|
-
* Each linkedAccount represents a way the end user can authenticate to this wallet.
|
|
375
|
-
* Can be empty when adding a new linkedAccount to an existing wallet.
|
|
364
|
+
* <p>List of linked accounts linked to this wallet. Each represents a way the end user can authenticate to this wallet.</p>
|
|
376
365
|
* @public
|
|
377
366
|
*/
|
|
378
367
|
linkedAccounts: LinkedAccount[] | undefined;
|
|
379
368
|
/**
|
|
380
|
-
* The wallet address on the specified blockchain network
|
|
369
|
+
* <p>The wallet address on the specified blockchain network.</p>
|
|
381
370
|
* @public
|
|
382
371
|
*/
|
|
383
372
|
walletAddress?: string | undefined;
|
|
384
373
|
/**
|
|
385
|
-
* URL for the end user to complete a provider-specific action
|
|
386
|
-
* Returned by the payment connector during instrument creation.
|
|
374
|
+
* <p>URL for the end user to complete a provider-specific action such as wallet linking or onboarding.</p>
|
|
387
375
|
* @public
|
|
388
376
|
*/
|
|
389
377
|
redirectUrl?: string | undefined;
|
|
390
378
|
}
|
|
391
379
|
/**
|
|
392
|
-
* Details specific to the instrument type
|
|
380
|
+
* <p>Details specific to the instrument type.</p>
|
|
393
381
|
* @public
|
|
394
382
|
*/
|
|
395
383
|
export type PaymentInstrumentDetails = PaymentInstrumentDetails.EmbeddedCryptoWalletMember | PaymentInstrumentDetails.$UnknownMember;
|
|
@@ -398,7 +386,7 @@ export type PaymentInstrumentDetails = PaymentInstrumentDetails.EmbeddedCryptoWa
|
|
|
398
386
|
*/
|
|
399
387
|
export declare namespace PaymentInstrumentDetails {
|
|
400
388
|
/**
|
|
401
|
-
* Embedded crypto wallet managed directly by end user
|
|
389
|
+
* <p>Embedded crypto wallet managed directly by end user.</p>
|
|
402
390
|
* @public
|
|
403
391
|
*/
|
|
404
392
|
interface EmbeddedCryptoWalletMember {
|
|
@@ -422,690 +410,679 @@ export declare namespace PaymentInstrumentDetails {
|
|
|
422
410
|
}
|
|
423
411
|
}
|
|
424
412
|
/**
|
|
425
|
-
* Request structure for creating a payment instrument
|
|
413
|
+
* <p>Request structure for creating a payment instrument.</p>
|
|
426
414
|
* @public
|
|
427
415
|
*/
|
|
428
416
|
export interface CreatePaymentInstrumentRequest {
|
|
429
417
|
/**
|
|
430
|
-
* The user ID associated with this payment instrument
|
|
418
|
+
* <p>The user ID associated with this payment instrument.</p>
|
|
431
419
|
* @public
|
|
432
420
|
*/
|
|
433
421
|
userId?: string | undefined;
|
|
434
422
|
/**
|
|
435
|
-
* The agent name associated with this request, used for observability
|
|
423
|
+
* <p>The agent name associated with this request, used for observability.</p>
|
|
436
424
|
* @public
|
|
437
425
|
*/
|
|
438
426
|
agentName?: string | undefined;
|
|
439
427
|
/**
|
|
440
|
-
* The ARN of the payment manager that owns this payment instrument
|
|
428
|
+
* <p>The ARN of the payment manager that owns this payment instrument.</p>
|
|
441
429
|
* @public
|
|
442
430
|
*/
|
|
443
431
|
paymentManagerArn: string | undefined;
|
|
444
432
|
/**
|
|
445
|
-
* The ID of the payment connector to use for this instrument
|
|
433
|
+
* <p>The ID of the payment connector to use for this instrument.</p>
|
|
446
434
|
* @public
|
|
447
435
|
*/
|
|
448
436
|
paymentConnectorId: string | undefined;
|
|
449
437
|
/**
|
|
450
|
-
* The type of payment instrument being created
|
|
438
|
+
* <p>The type of payment instrument being created.</p>
|
|
451
439
|
* @public
|
|
452
440
|
*/
|
|
453
441
|
paymentInstrumentType: PaymentInstrumentType | undefined;
|
|
454
442
|
/**
|
|
455
|
-
* The details of the payment instrument
|
|
443
|
+
* <p>The details of the payment instrument.</p>
|
|
456
444
|
* @public
|
|
457
445
|
*/
|
|
458
446
|
paymentInstrumentDetails: PaymentInstrumentDetails | undefined;
|
|
459
447
|
/**
|
|
460
|
-
*
|
|
448
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
|
|
461
449
|
* @public
|
|
462
450
|
*/
|
|
463
451
|
clientToken?: string | undefined;
|
|
464
452
|
}
|
|
465
453
|
/**
|
|
466
|
-
* Represents a payment instrument
|
|
454
|
+
* <p>Represents a payment instrument.</p>
|
|
467
455
|
* @public
|
|
468
456
|
*/
|
|
469
457
|
export interface PaymentInstrument {
|
|
470
458
|
/**
|
|
471
|
-
* The unique identifier for this payment instrument
|
|
459
|
+
* <p>The unique identifier for this payment instrument.</p>
|
|
472
460
|
* @public
|
|
473
461
|
*/
|
|
474
462
|
paymentInstrumentId: string | undefined;
|
|
475
463
|
/**
|
|
476
|
-
* The ARN of the payment manager that owns this payment instrument
|
|
464
|
+
* <p>The ARN of the payment manager that owns this payment instrument.</p>
|
|
477
465
|
* @public
|
|
478
466
|
*/
|
|
479
467
|
paymentManagerArn: string | undefined;
|
|
480
468
|
/**
|
|
481
|
-
* The ID of the payment connector associated with this instrument
|
|
469
|
+
* <p>The ID of the payment connector associated with this instrument.</p>
|
|
482
470
|
* @public
|
|
483
471
|
*/
|
|
484
472
|
paymentConnectorId: string | undefined;
|
|
485
473
|
/**
|
|
486
|
-
* The user ID associated with this payment instrument
|
|
474
|
+
* <p>The user ID associated with this payment instrument.</p>
|
|
487
475
|
* @public
|
|
488
476
|
*/
|
|
489
477
|
userId: string | undefined;
|
|
490
478
|
/**
|
|
491
|
-
* The type of payment instrument (e.g., EMBEDDED_CRYPTO_WALLET)
|
|
479
|
+
* <p>The type of payment instrument (e.g., EMBEDDED_CRYPTO_WALLET).</p>
|
|
492
480
|
* @public
|
|
493
481
|
*/
|
|
494
482
|
paymentInstrumentType: PaymentInstrumentType | undefined;
|
|
495
483
|
/**
|
|
496
|
-
* The details specific to the payment instrument type
|
|
484
|
+
* <p>The details specific to the payment instrument type.</p>
|
|
497
485
|
* @public
|
|
498
486
|
*/
|
|
499
487
|
paymentInstrumentDetails: PaymentInstrumentDetails | undefined;
|
|
500
488
|
/**
|
|
501
|
-
* The timestamp when this payment instrument was created
|
|
489
|
+
* <p>The timestamp when this payment instrument was created.</p>
|
|
502
490
|
* @public
|
|
503
491
|
*/
|
|
504
492
|
createdAt: Date | undefined;
|
|
505
493
|
/**
|
|
506
|
-
* The current status of this payment instrument
|
|
494
|
+
* <p>The current status of this payment instrument.</p>
|
|
507
495
|
* @public
|
|
508
496
|
*/
|
|
509
497
|
status: PaymentInstrumentStatus | undefined;
|
|
510
498
|
/**
|
|
511
|
-
* The timestamp when this payment instrument was last updated
|
|
499
|
+
* <p>The timestamp when this payment instrument was last updated.</p>
|
|
512
500
|
* @public
|
|
513
501
|
*/
|
|
514
502
|
updatedAt: Date | undefined;
|
|
515
503
|
}
|
|
516
504
|
/**
|
|
517
|
-
* Response structure for creating a payment instrument
|
|
505
|
+
* <p>Response structure for creating a payment instrument.</p>
|
|
518
506
|
* @public
|
|
519
507
|
*/
|
|
520
508
|
export interface CreatePaymentInstrumentResponse {
|
|
521
509
|
/**
|
|
522
|
-
*
|
|
510
|
+
* <p>The created payment instrument.</p>
|
|
523
511
|
* @public
|
|
524
512
|
*/
|
|
525
513
|
paymentInstrument: PaymentInstrument | undefined;
|
|
526
514
|
}
|
|
527
515
|
/**
|
|
528
|
-
* Request structure for deleting a payment instrument
|
|
529
|
-
*
|
|
530
|
-
* All fields are required and must match the instrument owner's identifiers for authorization to succeed.
|
|
516
|
+
* <p>Request structure for deleting a payment instrument.</p>
|
|
531
517
|
* @public
|
|
532
518
|
*/
|
|
533
519
|
export interface DeletePaymentInstrumentRequest {
|
|
534
520
|
/**
|
|
535
|
-
* The user ID making the delete request. Must match the instrument's userId
|
|
521
|
+
* <p>The user ID making the delete request. Must match the instrument's userId.</p>
|
|
536
522
|
* @public
|
|
537
523
|
*/
|
|
538
524
|
userId?: string | undefined;
|
|
539
525
|
/**
|
|
540
|
-
* The payment manager ARN. Must match the instrument's paymentManagerArn
|
|
526
|
+
* <p>The payment manager ARN. Must match the instrument's paymentManagerArn.</p>
|
|
541
527
|
* @public
|
|
542
528
|
*/
|
|
543
529
|
paymentManagerArn: string | undefined;
|
|
544
530
|
/**
|
|
545
|
-
* The payment connector ID. Must match the instrument's paymentConnectorId
|
|
531
|
+
* <p>The payment connector ID. Must match the instrument's paymentConnectorId.</p>
|
|
546
532
|
* @public
|
|
547
533
|
*/
|
|
548
534
|
paymentConnectorId: string | undefined;
|
|
549
535
|
/**
|
|
550
|
-
* The payment instrument ID to delete
|
|
536
|
+
* <p>The payment instrument ID to delete.</p>
|
|
551
537
|
* @public
|
|
552
538
|
*/
|
|
553
539
|
paymentInstrumentId: string | undefined;
|
|
554
540
|
}
|
|
555
541
|
/**
|
|
556
|
-
* Response structure for deleting a payment instrument
|
|
557
|
-
*
|
|
558
|
-
* Returns the deletion status with HTTP 200 OK status code on successful soft deletion.
|
|
542
|
+
* <p>Response structure for deleting a payment instrument.</p>
|
|
559
543
|
* @public
|
|
560
544
|
*/
|
|
561
545
|
export interface DeletePaymentInstrumentResponse {
|
|
562
546
|
/**
|
|
563
|
-
* The status of the instrument after deletion. Always DELETED for successful soft delete
|
|
547
|
+
* <p>The status of the instrument after deletion. Always DELETED for successful soft delete.</p>
|
|
564
548
|
* @public
|
|
565
549
|
*/
|
|
566
550
|
status: PaymentInstrumentStatus | undefined;
|
|
567
551
|
}
|
|
568
552
|
/**
|
|
569
|
-
* Request structure for getting a payment instrument
|
|
553
|
+
* <p>Request structure for getting a payment instrument.</p>
|
|
570
554
|
* @public
|
|
571
555
|
*/
|
|
572
556
|
export interface GetPaymentInstrumentRequest {
|
|
573
557
|
/**
|
|
574
|
-
* The user ID associated with this payment instrument
|
|
558
|
+
* <p>The user ID associated with this payment instrument.</p>
|
|
575
559
|
* @public
|
|
576
560
|
*/
|
|
577
561
|
userId?: string | undefined;
|
|
578
562
|
/**
|
|
579
|
-
* The agent name associated with this request, used for observability
|
|
563
|
+
* <p>The agent name associated with this request, used for observability.</p>
|
|
580
564
|
* @public
|
|
581
565
|
*/
|
|
582
566
|
agentName?: string | undefined;
|
|
583
567
|
/**
|
|
584
|
-
* The ARN of the payment manager that owns this payment instrument
|
|
568
|
+
* <p>The ARN of the payment manager that owns this payment instrument.</p>
|
|
585
569
|
* @public
|
|
586
570
|
*/
|
|
587
571
|
paymentManagerArn: string | undefined;
|
|
588
572
|
/**
|
|
589
|
-
* The ID of the payment connector
|
|
573
|
+
* <p>The ID of the payment connector.</p>
|
|
590
574
|
* @public
|
|
591
575
|
*/
|
|
592
576
|
paymentConnectorId?: string | undefined;
|
|
593
577
|
/**
|
|
594
|
-
* The ID of the payment instrument to retrieve
|
|
578
|
+
* <p>The ID of the payment instrument to retrieve.</p>
|
|
595
579
|
* @public
|
|
596
580
|
*/
|
|
597
581
|
paymentInstrumentId: string | undefined;
|
|
598
582
|
}
|
|
599
583
|
/**
|
|
600
|
-
* Response structure for getting a payment instrument
|
|
584
|
+
* <p>Response structure for getting a payment instrument.</p>
|
|
601
585
|
* @public
|
|
602
586
|
*/
|
|
603
587
|
export interface GetPaymentInstrumentResponse {
|
|
604
588
|
/**
|
|
605
|
-
*
|
|
589
|
+
* <p>The payment instrument details.</p>
|
|
606
590
|
* @public
|
|
607
591
|
*/
|
|
608
592
|
paymentInstrument: PaymentInstrument | undefined;
|
|
609
593
|
}
|
|
610
594
|
/**
|
|
611
|
-
* Request structure for getting payment instrument balance
|
|
595
|
+
* <p>Request structure for getting payment instrument balance.</p>
|
|
612
596
|
* @public
|
|
613
597
|
*/
|
|
614
598
|
export interface GetPaymentInstrumentBalanceRequest {
|
|
615
599
|
/**
|
|
616
|
-
* The user ID associated with this payment instrument
|
|
600
|
+
* <p>The user ID associated with this payment instrument.</p>
|
|
617
601
|
* @public
|
|
618
602
|
*/
|
|
619
603
|
userId?: string | undefined;
|
|
620
604
|
/**
|
|
621
|
-
* The agent name associated with this request, used for observability
|
|
605
|
+
* <p>The agent name associated with this request, used for observability.</p>
|
|
622
606
|
* @public
|
|
623
607
|
*/
|
|
624
608
|
agentName?: string | undefined;
|
|
625
609
|
/**
|
|
626
|
-
* The ARN of the payment manager that owns this payment instrument
|
|
610
|
+
* <p>The ARN of the payment manager that owns this payment instrument.</p>
|
|
627
611
|
* @public
|
|
628
612
|
*/
|
|
629
613
|
paymentManagerArn: string | undefined;
|
|
630
614
|
/**
|
|
631
|
-
* The ID of the payment connector associated with this instrument
|
|
615
|
+
* <p>The ID of the payment connector associated with this instrument.</p>
|
|
632
616
|
* @public
|
|
633
617
|
*/
|
|
634
618
|
paymentConnectorId: string | undefined;
|
|
635
619
|
/**
|
|
636
|
-
* The ID of the payment instrument to query balance for
|
|
620
|
+
* <p>The ID of the payment instrument to query balance for.</p>
|
|
637
621
|
* @public
|
|
638
622
|
*/
|
|
639
623
|
paymentInstrumentId: string | undefined;
|
|
640
624
|
/**
|
|
641
|
-
* The specific blockchain chain to query balance on.
|
|
642
|
-
* Required because balances are chain-specific — the same wallet address may hold
|
|
643
|
-
* different token balances on different chains.
|
|
625
|
+
* <p>The specific blockchain chain to query balance on. Required because balances are chain-specific.</p>
|
|
644
626
|
* @public
|
|
645
627
|
*/
|
|
646
628
|
chain: BlockchainChainId | undefined;
|
|
647
629
|
/**
|
|
648
|
-
* The token to query balance for.
|
|
649
|
-
* Required to specify which supported token's balance to return.
|
|
630
|
+
* <p>The token to query balance for. Only tokens supported for X402 payments are returned.</p>
|
|
650
631
|
* @public
|
|
651
632
|
*/
|
|
652
633
|
token: InstrumentBalanceToken | undefined;
|
|
653
634
|
}
|
|
654
635
|
/**
|
|
655
|
-
* A single token balance entry
|
|
636
|
+
* <p>A single token balance entry.</p>
|
|
656
637
|
* @public
|
|
657
638
|
*/
|
|
658
639
|
export interface TokenBalance {
|
|
659
640
|
/**
|
|
660
|
-
* Raw balance in the smallest denomination (e.g., USDC base units where 1 USDC = 1000000)
|
|
641
|
+
* <p>Raw balance in the smallest denomination (e.g., USDC base units where 1 USDC = 1000000).</p>
|
|
661
642
|
* @public
|
|
662
643
|
*/
|
|
663
644
|
amount: string | undefined;
|
|
664
645
|
/**
|
|
665
|
-
* Number of decimal places for the token (e.g., 6 for USDC)
|
|
646
|
+
* <p>Number of decimal places for the token (e.g., 6 for USDC).</p>
|
|
666
647
|
* @public
|
|
667
648
|
*/
|
|
668
649
|
decimals: number | undefined;
|
|
669
650
|
/**
|
|
670
|
-
* The supported token for this balance
|
|
651
|
+
* <p>The supported token for this balance.</p>
|
|
671
652
|
* @public
|
|
672
653
|
*/
|
|
673
654
|
token: InstrumentBalanceToken | undefined;
|
|
674
655
|
/**
|
|
675
|
-
* The blockchain network family (ETHEREUM or SOLANA)
|
|
656
|
+
* <p>The blockchain network family (ETHEREUM or SOLANA).</p>
|
|
676
657
|
* @public
|
|
677
658
|
*/
|
|
678
659
|
network: CryptoWalletNetwork | undefined;
|
|
679
660
|
/**
|
|
680
|
-
* The specific blockchain chain
|
|
661
|
+
* <p>The specific blockchain chain.</p>
|
|
681
662
|
* @public
|
|
682
663
|
*/
|
|
683
664
|
chain: BlockchainChainId | undefined;
|
|
684
665
|
}
|
|
685
666
|
/**
|
|
686
|
-
* Response structure for getting payment instrument balance
|
|
667
|
+
* <p>Response structure for getting payment instrument balance.</p>
|
|
687
668
|
* @public
|
|
688
669
|
*/
|
|
689
670
|
export interface GetPaymentInstrumentBalanceResponse {
|
|
690
671
|
/**
|
|
691
|
-
* The ID of the payment instrument
|
|
672
|
+
* <p>The ID of the payment instrument.</p>
|
|
692
673
|
* @public
|
|
693
674
|
*/
|
|
694
675
|
paymentInstrumentId: string | undefined;
|
|
695
676
|
/**
|
|
696
|
-
* The balance of the supported token on the requested chain
|
|
677
|
+
* <p>The balance of the supported token on the requested chain.</p>
|
|
697
678
|
* @public
|
|
698
679
|
*/
|
|
699
680
|
tokenBalance: TokenBalance | undefined;
|
|
700
681
|
}
|
|
701
682
|
/**
|
|
702
|
-
* Request structure for listing payment instruments
|
|
683
|
+
* <p>Request structure for listing payment instruments.</p>
|
|
703
684
|
* @public
|
|
704
685
|
*/
|
|
705
686
|
export interface ListPaymentInstrumentsRequest {
|
|
706
687
|
/**
|
|
707
|
-
* The user ID associated with the payment instruments
|
|
688
|
+
* <p>The user ID associated with the payment instruments.</p>
|
|
708
689
|
* @public
|
|
709
690
|
*/
|
|
710
691
|
userId?: string | undefined;
|
|
711
692
|
/**
|
|
712
|
-
* The agent name associated with this request, used for observability
|
|
693
|
+
* <p>The agent name associated with this request, used for observability.</p>
|
|
713
694
|
* @public
|
|
714
695
|
*/
|
|
715
696
|
agentName?: string | undefined;
|
|
716
697
|
/**
|
|
717
|
-
* The ARN of the payment manager that owns the payment instruments
|
|
698
|
+
* <p>The ARN of the payment manager that owns the payment instruments.</p>
|
|
718
699
|
* @public
|
|
719
700
|
*/
|
|
720
701
|
paymentManagerArn: string | undefined;
|
|
721
702
|
/**
|
|
722
|
-
* The ID of the payment connector to filter by
|
|
703
|
+
* <p>The ID of the payment connector to filter by.</p>
|
|
723
704
|
* @public
|
|
724
705
|
*/
|
|
725
706
|
paymentConnectorId?: string | undefined;
|
|
726
707
|
/**
|
|
727
|
-
* Token for pagination to retrieve the next set of results
|
|
708
|
+
* <p>Token for pagination to retrieve the next set of results.</p>
|
|
728
709
|
* @public
|
|
729
710
|
*/
|
|
730
711
|
nextToken?: string | undefined;
|
|
731
712
|
/**
|
|
732
|
-
* Maximum number of results to return in a single response
|
|
713
|
+
* <p>Maximum number of results to return in a single response.</p>
|
|
733
714
|
* @public
|
|
734
715
|
*/
|
|
735
716
|
maxResults?: number | undefined;
|
|
736
717
|
}
|
|
737
718
|
/**
|
|
738
|
-
* Summary of a payment instrument for list operations
|
|
719
|
+
* <p>Summary of a payment instrument for list operations.</p>
|
|
739
720
|
* @public
|
|
740
721
|
*/
|
|
741
722
|
export interface PaymentInstrumentSummary {
|
|
742
723
|
/**
|
|
743
|
-
* The unique identifier for this payment instrument
|
|
724
|
+
* <p>The unique identifier for this payment instrument.</p>
|
|
744
725
|
* @public
|
|
745
726
|
*/
|
|
746
727
|
paymentInstrumentId: string | undefined;
|
|
747
728
|
/**
|
|
748
|
-
* The ARN of the payment manager that owns this payment instrument
|
|
729
|
+
* <p>The ARN of the payment manager that owns this payment instrument.</p>
|
|
749
730
|
* @public
|
|
750
731
|
*/
|
|
751
732
|
paymentManagerArn: string | undefined;
|
|
752
733
|
/**
|
|
753
|
-
* The ID of the payment connector associated with this instrument
|
|
734
|
+
* <p>The ID of the payment connector associated with this instrument.</p>
|
|
754
735
|
* @public
|
|
755
736
|
*/
|
|
756
737
|
paymentConnectorId: string | undefined;
|
|
757
738
|
/**
|
|
758
|
-
* The user ID associated with this payment instrument
|
|
739
|
+
* <p>The user ID associated with this payment instrument.</p>
|
|
759
740
|
* @public
|
|
760
741
|
*/
|
|
761
742
|
userId: string | undefined;
|
|
762
743
|
/**
|
|
763
|
-
* The type of payment instrument (e.g., EMBEDDED_CRYPTO_WALLET)
|
|
744
|
+
* <p>The type of payment instrument (e.g., EMBEDDED_CRYPTO_WALLET).</p>
|
|
764
745
|
* @public
|
|
765
746
|
*/
|
|
766
747
|
paymentInstrumentType: PaymentInstrumentType | undefined;
|
|
767
748
|
/**
|
|
768
|
-
* The current status of this payment instrument
|
|
749
|
+
* <p>The current status of this payment instrument.</p>
|
|
769
750
|
* @public
|
|
770
751
|
*/
|
|
771
752
|
status: PaymentInstrumentStatus | undefined;
|
|
772
753
|
/**
|
|
773
|
-
* The timestamp when this payment instrument was created
|
|
754
|
+
* <p>The timestamp when this payment instrument was created.</p>
|
|
774
755
|
* @public
|
|
775
756
|
*/
|
|
776
757
|
createdAt: Date | undefined;
|
|
777
758
|
/**
|
|
778
|
-
* The timestamp when this payment instrument was last updated
|
|
759
|
+
* <p>The timestamp when this payment instrument was last updated.</p>
|
|
779
760
|
* @public
|
|
780
761
|
*/
|
|
781
762
|
updatedAt: Date | undefined;
|
|
782
763
|
}
|
|
783
764
|
/**
|
|
784
|
-
* Response structure for listing payment instruments
|
|
765
|
+
* <p>Response structure for listing payment instruments.</p>
|
|
785
766
|
* @public
|
|
786
767
|
*/
|
|
787
768
|
export interface ListPaymentInstrumentsResponse {
|
|
788
769
|
/**
|
|
789
|
-
* List of payment instrument summaries matching the request criteria
|
|
770
|
+
* <p>List of payment instrument summaries matching the request criteria.</p>
|
|
790
771
|
* @public
|
|
791
772
|
*/
|
|
792
773
|
paymentInstruments: PaymentInstrumentSummary[] | undefined;
|
|
793
774
|
/**
|
|
794
|
-
* Token for pagination to retrieve the next set of results
|
|
775
|
+
* <p>Token for pagination to retrieve the next set of results.</p>
|
|
795
776
|
* @public
|
|
796
777
|
*/
|
|
797
778
|
nextToken?: string | undefined;
|
|
798
779
|
}
|
|
799
780
|
/**
|
|
800
|
-
*
|
|
781
|
+
* <p>Represents a monetary amount with a currency.</p>
|
|
801
782
|
* @public
|
|
802
783
|
*/
|
|
803
784
|
export interface Amount {
|
|
804
785
|
/**
|
|
805
|
-
* The numeric value of the amount
|
|
786
|
+
* <p>The numeric value of the amount.</p>
|
|
806
787
|
* @public
|
|
807
788
|
*/
|
|
808
789
|
value: string | undefined;
|
|
809
790
|
/**
|
|
810
|
-
* The currency code for
|
|
791
|
+
* <p>The currency code for the amount.</p>
|
|
811
792
|
* @public
|
|
812
793
|
*/
|
|
813
794
|
currency: Currency | undefined;
|
|
814
795
|
}
|
|
815
796
|
/**
|
|
816
|
-
*
|
|
797
|
+
* <p>The spending limits configuration for a payment session.</p>
|
|
817
798
|
* @public
|
|
818
799
|
*/
|
|
819
800
|
export interface SessionLimits {
|
|
820
801
|
/**
|
|
821
|
-
* The maximum amount that can be spent in
|
|
802
|
+
* <p>The maximum amount that can be spent in the session.</p>
|
|
822
803
|
* @public
|
|
823
804
|
*/
|
|
824
805
|
maxSpendAmount: Amount | undefined;
|
|
825
806
|
}
|
|
826
807
|
/**
|
|
827
|
-
* Request structure for creating a payment session
|
|
808
|
+
* <p>Request structure for creating a payment session.</p>
|
|
828
809
|
* @public
|
|
829
810
|
*/
|
|
830
811
|
export interface CreatePaymentSessionRequest {
|
|
831
812
|
/**
|
|
832
|
-
* The user ID associated with this payment session
|
|
813
|
+
* <p>The user ID associated with this payment session.</p>
|
|
833
814
|
* @public
|
|
834
815
|
*/
|
|
835
816
|
userId?: string | undefined;
|
|
836
817
|
/**
|
|
837
|
-
* The agent name associated with this request, used for observability
|
|
818
|
+
* <p>The agent name associated with this request, used for observability.</p>
|
|
838
819
|
* @public
|
|
839
820
|
*/
|
|
840
821
|
agentName?: string | undefined;
|
|
841
822
|
/**
|
|
842
|
-
* The ARN of the payment manager that owns this session
|
|
823
|
+
* <p>The ARN of the payment manager that owns this session.</p>
|
|
843
824
|
* @public
|
|
844
825
|
*/
|
|
845
826
|
paymentManagerArn: string | undefined;
|
|
846
827
|
/**
|
|
847
|
-
* The spending limits for this payment session
|
|
828
|
+
* <p>The spending limits for this payment session.</p>
|
|
848
829
|
* @public
|
|
849
830
|
*/
|
|
850
831
|
limits?: SessionLimits | undefined;
|
|
851
832
|
/**
|
|
852
|
-
* The session expiry time in minutes. Must be between 15 and 480 minutes
|
|
833
|
+
* <p>The session expiry time in minutes. Must be between 15 and 480 minutes.</p>
|
|
853
834
|
* @public
|
|
854
835
|
*/
|
|
855
836
|
expiryTimeInMinutes: number | undefined;
|
|
856
837
|
/**
|
|
857
|
-
*
|
|
838
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
|
|
858
839
|
* @public
|
|
859
840
|
*/
|
|
860
841
|
clientToken?: string | undefined;
|
|
861
842
|
}
|
|
862
843
|
/**
|
|
863
|
-
*
|
|
844
|
+
* <p>The available spending limits for a payment session.</p>
|
|
864
845
|
* @public
|
|
865
846
|
*/
|
|
866
847
|
export interface AvailableLimits {
|
|
867
848
|
/**
|
|
868
|
-
* The available
|
|
849
|
+
* <p>The remaining available amount that can be spent.</p>
|
|
869
850
|
* @public
|
|
870
851
|
*/
|
|
871
852
|
availableSpendAmount?: Amount | undefined;
|
|
872
853
|
/**
|
|
873
|
-
* The timestamp when the available limits were last updated
|
|
854
|
+
* <p>The timestamp when the available limits were last updated.</p>
|
|
874
855
|
* @public
|
|
875
856
|
*/
|
|
876
857
|
updatedAt?: Date | undefined;
|
|
877
858
|
}
|
|
878
859
|
/**
|
|
879
|
-
*
|
|
860
|
+
* <p>A payment session for managing payment transactions.</p>
|
|
880
861
|
* @public
|
|
881
862
|
*/
|
|
882
863
|
export interface PaymentSession {
|
|
883
864
|
/**
|
|
884
|
-
* The unique identifier
|
|
865
|
+
* <p>The unique identifier of the payment session.</p>
|
|
885
866
|
* @public
|
|
886
867
|
*/
|
|
887
868
|
paymentSessionId: string | undefined;
|
|
888
869
|
/**
|
|
889
|
-
* The ARN of the payment manager that owns this session
|
|
870
|
+
* <p>The ARN of the payment manager that owns this session.</p>
|
|
890
871
|
* @public
|
|
891
872
|
*/
|
|
892
873
|
paymentManagerArn: string | undefined;
|
|
893
874
|
/**
|
|
894
|
-
* The spending limits for
|
|
875
|
+
* <p>The spending limits for the payment session.</p>
|
|
895
876
|
* @public
|
|
896
877
|
*/
|
|
897
878
|
limits?: SessionLimits | undefined;
|
|
898
879
|
/**
|
|
899
|
-
* The user ID associated with this
|
|
880
|
+
* <p>The user ID associated with this session.</p>
|
|
900
881
|
* @public
|
|
901
882
|
*/
|
|
902
883
|
userId: string | undefined;
|
|
903
884
|
/**
|
|
904
|
-
* The session expiry time in minutes
|
|
885
|
+
* <p>The session expiry time in minutes.</p>
|
|
905
886
|
* @public
|
|
906
887
|
*/
|
|
907
888
|
expiryTimeInMinutes: number | undefined;
|
|
908
889
|
/**
|
|
909
|
-
* The timestamp when
|
|
890
|
+
* <p>The timestamp when the session was created.</p>
|
|
910
891
|
* @public
|
|
911
892
|
*/
|
|
912
893
|
createdAt: Date | undefined;
|
|
913
894
|
/**
|
|
914
|
-
* The available limits
|
|
895
|
+
* <p>The current available spending limits.</p>
|
|
915
896
|
* @public
|
|
916
897
|
*/
|
|
917
898
|
availableLimits?: AvailableLimits | undefined;
|
|
918
899
|
/**
|
|
919
|
-
* The timestamp when
|
|
900
|
+
* <p>The timestamp when the session was last updated.</p>
|
|
920
901
|
* @public
|
|
921
902
|
*/
|
|
922
903
|
updatedAt: Date | undefined;
|
|
923
904
|
}
|
|
924
905
|
/**
|
|
925
|
-
* Response structure for creating a payment session
|
|
906
|
+
* <p>Response structure for creating a payment session.</p>
|
|
926
907
|
* @public
|
|
927
908
|
*/
|
|
928
909
|
export interface CreatePaymentSessionResponse {
|
|
929
910
|
/**
|
|
930
|
-
*
|
|
911
|
+
* <p>The created payment session.</p>
|
|
931
912
|
* @public
|
|
932
913
|
*/
|
|
933
914
|
paymentSession: PaymentSession | undefined;
|
|
934
915
|
}
|
|
935
916
|
/**
|
|
936
|
-
* Request structure for deleting a payment session
|
|
937
|
-
*
|
|
938
|
-
* All fields are required and must match the session owner's identifiers for authorization to succeed.
|
|
917
|
+
* <p>Request structure for deleting a payment session.</p>
|
|
939
918
|
* @public
|
|
940
919
|
*/
|
|
941
920
|
export interface DeletePaymentSessionRequest {
|
|
942
921
|
/**
|
|
943
|
-
* The user ID making the delete request. Must match the session's userId
|
|
922
|
+
* <p>The user ID making the delete request. Must match the session's userId.</p>
|
|
944
923
|
* @public
|
|
945
924
|
*/
|
|
946
925
|
userId?: string | undefined;
|
|
947
926
|
/**
|
|
948
|
-
* The payment manager ARN. Must match the session's paymentManagerArn
|
|
927
|
+
* <p>The payment manager ARN. Must match the session's paymentManagerArn.</p>
|
|
949
928
|
* @public
|
|
950
929
|
*/
|
|
951
930
|
paymentManagerArn: string | undefined;
|
|
952
931
|
/**
|
|
953
|
-
* The payment session ID to delete
|
|
932
|
+
* <p>The payment session ID to delete.</p>
|
|
954
933
|
* @public
|
|
955
934
|
*/
|
|
956
935
|
paymentSessionId: string | undefined;
|
|
957
936
|
}
|
|
958
937
|
/**
|
|
959
|
-
* Response structure for deleting a payment session
|
|
960
|
-
*
|
|
961
|
-
* Returns the deletion status with HTTP 200 status code on successful deletion.
|
|
938
|
+
* <p>Response structure for deleting a payment session.</p>
|
|
962
939
|
* @public
|
|
963
940
|
*/
|
|
964
941
|
export interface DeletePaymentSessionResponse {
|
|
965
942
|
/**
|
|
966
|
-
* The status of the deletion. Always DELETED for successful hard delete
|
|
943
|
+
* <p>The status of the deletion. Always DELETED for successful hard delete.</p>
|
|
967
944
|
* @public
|
|
968
945
|
*/
|
|
969
946
|
status: PaymentSessionStatus | undefined;
|
|
970
947
|
}
|
|
971
948
|
/**
|
|
972
|
-
* Request structure for getting a payment session
|
|
949
|
+
* <p>Request structure for getting a payment session.</p>
|
|
973
950
|
* @public
|
|
974
951
|
*/
|
|
975
952
|
export interface GetPaymentSessionRequest {
|
|
976
953
|
/**
|
|
977
|
-
* The user ID associated with this payment session
|
|
954
|
+
* <p>The user ID associated with this payment session.</p>
|
|
978
955
|
* @public
|
|
979
956
|
*/
|
|
980
957
|
userId?: string | undefined;
|
|
981
958
|
/**
|
|
982
|
-
* The agent name associated with this request, used for observability
|
|
959
|
+
* <p>The agent name associated with this request, used for observability.</p>
|
|
983
960
|
* @public
|
|
984
961
|
*/
|
|
985
962
|
agentName?: string | undefined;
|
|
986
963
|
/**
|
|
987
|
-
* The ARN of the payment manager that owns this session
|
|
964
|
+
* <p>The ARN of the payment manager that owns this session.</p>
|
|
988
965
|
* @public
|
|
989
966
|
*/
|
|
990
967
|
paymentManagerArn: string | undefined;
|
|
991
968
|
/**
|
|
992
|
-
* The ID of the payment session to retrieve
|
|
969
|
+
* <p>The ID of the payment session to retrieve.</p>
|
|
993
970
|
* @public
|
|
994
971
|
*/
|
|
995
972
|
paymentSessionId: string | undefined;
|
|
996
973
|
}
|
|
997
974
|
/**
|
|
998
|
-
* Response structure for getting a payment session
|
|
975
|
+
* <p>Response structure for getting a payment session.</p>
|
|
999
976
|
* @public
|
|
1000
977
|
*/
|
|
1001
978
|
export interface GetPaymentSessionResponse {
|
|
1002
979
|
/**
|
|
1003
|
-
*
|
|
980
|
+
* <p>The payment session details.</p>
|
|
1004
981
|
* @public
|
|
1005
982
|
*/
|
|
1006
983
|
paymentSession: PaymentSession | undefined;
|
|
1007
984
|
}
|
|
1008
985
|
/**
|
|
1009
|
-
* Request structure for listing payment sessions
|
|
986
|
+
* <p>Request structure for listing payment sessions.</p>
|
|
1010
987
|
* @public
|
|
1011
988
|
*/
|
|
1012
989
|
export interface ListPaymentSessionsRequest {
|
|
1013
990
|
/**
|
|
1014
|
-
* The user ID associated with the payment sessions
|
|
991
|
+
* <p>The user ID associated with the payment sessions.</p>
|
|
1015
992
|
* @public
|
|
1016
993
|
*/
|
|
1017
994
|
userId?: string | undefined;
|
|
1018
995
|
/**
|
|
1019
|
-
* The agent name associated with this request, used for observability
|
|
996
|
+
* <p>The agent name associated with this request, used for observability.</p>
|
|
1020
997
|
* @public
|
|
1021
998
|
*/
|
|
1022
999
|
agentName?: string | undefined;
|
|
1023
1000
|
/**
|
|
1024
|
-
* The ARN of the payment manager that owns the sessions
|
|
1001
|
+
* <p>The ARN of the payment manager that owns the sessions.</p>
|
|
1025
1002
|
* @public
|
|
1026
1003
|
*/
|
|
1027
1004
|
paymentManagerArn: string | undefined;
|
|
1028
1005
|
/**
|
|
1029
|
-
* Token for pagination to retrieve the next set of results
|
|
1006
|
+
* <p>Token for pagination to retrieve the next set of results.</p>
|
|
1030
1007
|
* @public
|
|
1031
1008
|
*/
|
|
1032
1009
|
nextToken?: string | undefined;
|
|
1033
1010
|
/**
|
|
1034
|
-
* Maximum number of results to return in a single response
|
|
1011
|
+
* <p>Maximum number of results to return in a single response.</p>
|
|
1035
1012
|
* @public
|
|
1036
1013
|
*/
|
|
1037
1014
|
maxResults?: number | undefined;
|
|
1038
1015
|
}
|
|
1039
1016
|
/**
|
|
1040
|
-
* Summary
|
|
1017
|
+
* <p>Summary information about a payment session.</p>
|
|
1041
1018
|
* @public
|
|
1042
1019
|
*/
|
|
1043
1020
|
export interface PaymentSessionSummary {
|
|
1044
1021
|
/**
|
|
1045
|
-
* The unique identifier
|
|
1022
|
+
* <p>The unique identifier of the payment session.</p>
|
|
1046
1023
|
* @public
|
|
1047
1024
|
*/
|
|
1048
1025
|
paymentSessionId: string | undefined;
|
|
1049
1026
|
/**
|
|
1050
|
-
* The ARN of the payment manager that owns this session
|
|
1027
|
+
* <p>The ARN of the payment manager that owns this session.</p>
|
|
1051
1028
|
* @public
|
|
1052
1029
|
*/
|
|
1053
1030
|
paymentManagerArn: string | undefined;
|
|
1054
1031
|
/**
|
|
1055
|
-
* The user ID associated with this
|
|
1032
|
+
* <p>The user ID associated with this session.</p>
|
|
1056
1033
|
* @public
|
|
1057
1034
|
*/
|
|
1058
1035
|
userId: string | undefined;
|
|
1059
1036
|
/**
|
|
1060
|
-
* The session expiry time in minutes
|
|
1037
|
+
* <p>The session expiry time in minutes.</p>
|
|
1061
1038
|
* @public
|
|
1062
1039
|
*/
|
|
1063
1040
|
expiryTimeInMinutes: number | undefined;
|
|
1064
1041
|
/**
|
|
1065
|
-
* The timestamp when
|
|
1042
|
+
* <p>The timestamp when the session was created.</p>
|
|
1066
1043
|
* @public
|
|
1067
1044
|
*/
|
|
1068
1045
|
createdAt: Date | undefined;
|
|
1069
1046
|
/**
|
|
1070
|
-
* The timestamp when
|
|
1047
|
+
* <p>The timestamp when the session was last updated.</p>
|
|
1071
1048
|
* @public
|
|
1072
1049
|
*/
|
|
1073
1050
|
updatedAt: Date | undefined;
|
|
1074
1051
|
}
|
|
1075
1052
|
/**
|
|
1076
|
-
* Response structure for listing payment sessions
|
|
1053
|
+
* <p>Response structure for listing payment sessions.</p>
|
|
1077
1054
|
* @public
|
|
1078
1055
|
*/
|
|
1079
1056
|
export interface ListPaymentSessionsResponse {
|
|
1080
1057
|
/**
|
|
1081
|
-
* List of payment session summaries matching the request criteria
|
|
1058
|
+
* <p>List of payment session summaries matching the request criteria.</p>
|
|
1082
1059
|
* @public
|
|
1083
1060
|
*/
|
|
1084
1061
|
paymentSessions: PaymentSessionSummary[] | undefined;
|
|
1085
1062
|
/**
|
|
1086
|
-
* Token for pagination to retrieve the next set of results
|
|
1063
|
+
* <p>Token for pagination to retrieve the next set of results.</p>
|
|
1087
1064
|
* @public
|
|
1088
1065
|
*/
|
|
1089
1066
|
nextToken?: string | undefined;
|
|
1090
1067
|
}
|
|
1091
1068
|
/**
|
|
1092
|
-
* X402 payment
|
|
1069
|
+
* <p>The input for a crypto X402 payment.</p>
|
|
1093
1070
|
* @public
|
|
1094
1071
|
*/
|
|
1095
1072
|
export interface CryptoX402PaymentInput {
|
|
1096
1073
|
/**
|
|
1097
|
-
* The
|
|
1074
|
+
* <p>The version of the X402 protocol.</p>
|
|
1098
1075
|
* @public
|
|
1099
1076
|
*/
|
|
1100
1077
|
version: string | undefined;
|
|
1101
1078
|
/**
|
|
1102
|
-
*
|
|
1079
|
+
* <p>The X402 payment payload.</p>
|
|
1103
1080
|
* @public
|
|
1104
1081
|
*/
|
|
1105
1082
|
payload: __DocumentType | undefined;
|
|
1106
1083
|
}
|
|
1107
1084
|
/**
|
|
1108
|
-
*
|
|
1085
|
+
* <p>The payment input details, which vary by payment type.</p>
|
|
1109
1086
|
* @public
|
|
1110
1087
|
*/
|
|
1111
1088
|
export type PaymentInput = PaymentInput.CryptoX402Member | PaymentInput.$UnknownMember;
|
|
@@ -1114,7 +1091,7 @@ export type PaymentInput = PaymentInput.CryptoX402Member | PaymentInput.$Unknown
|
|
|
1114
1091
|
*/
|
|
1115
1092
|
export declare namespace PaymentInput {
|
|
1116
1093
|
/**
|
|
1117
|
-
* X402 payment
|
|
1094
|
+
* <p>Input for a crypto X402 payment.</p>
|
|
1118
1095
|
* @public
|
|
1119
1096
|
*/
|
|
1120
1097
|
interface CryptoX402Member {
|
|
@@ -1138,69 +1115,69 @@ export declare namespace PaymentInput {
|
|
|
1138
1115
|
}
|
|
1139
1116
|
}
|
|
1140
1117
|
/**
|
|
1141
|
-
* Request structure for processing a payment
|
|
1118
|
+
* <p>Request structure for processing a payment.</p>
|
|
1142
1119
|
* @public
|
|
1143
1120
|
*/
|
|
1144
1121
|
export interface ProcessPaymentRequest {
|
|
1145
1122
|
/**
|
|
1146
|
-
* The user ID associated with this payment
|
|
1123
|
+
* <p>The user ID associated with this payment.</p>
|
|
1147
1124
|
* @public
|
|
1148
1125
|
*/
|
|
1149
1126
|
userId?: string | undefined;
|
|
1150
1127
|
/**
|
|
1151
|
-
* The agent name associated with this request, used for observability
|
|
1128
|
+
* <p>The agent name associated with this request, used for observability.</p>
|
|
1152
1129
|
* @public
|
|
1153
1130
|
*/
|
|
1154
1131
|
agentName?: string | undefined;
|
|
1155
1132
|
/**
|
|
1156
|
-
* The ARN of the payment manager
|
|
1133
|
+
* <p>The ARN of the payment manager.</p>
|
|
1157
1134
|
* @public
|
|
1158
1135
|
*/
|
|
1159
1136
|
paymentManagerArn: string | undefined;
|
|
1160
1137
|
/**
|
|
1161
|
-
* The ID of the payment session
|
|
1138
|
+
* <p>The ID of the payment session.</p>
|
|
1162
1139
|
* @public
|
|
1163
1140
|
*/
|
|
1164
1141
|
paymentSessionId: string | undefined;
|
|
1165
1142
|
/**
|
|
1166
|
-
* The ID of the payment instrument to use
|
|
1143
|
+
* <p>The ID of the payment instrument to use.</p>
|
|
1167
1144
|
* @public
|
|
1168
1145
|
*/
|
|
1169
1146
|
paymentInstrumentId: string | undefined;
|
|
1170
1147
|
/**
|
|
1171
|
-
* The type of payment
|
|
1148
|
+
* <p>The type of payment to process.</p>
|
|
1172
1149
|
* @public
|
|
1173
1150
|
*/
|
|
1174
1151
|
paymentType: PaymentType | undefined;
|
|
1175
1152
|
/**
|
|
1176
|
-
* The payment input details specific to the payment type
|
|
1153
|
+
* <p>The payment input details specific to the payment type.</p>
|
|
1177
1154
|
* @public
|
|
1178
1155
|
*/
|
|
1179
1156
|
paymentInput: PaymentInput | undefined;
|
|
1180
1157
|
/**
|
|
1181
|
-
*
|
|
1158
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
|
|
1182
1159
|
* @public
|
|
1183
1160
|
*/
|
|
1184
1161
|
clientToken?: string | undefined;
|
|
1185
1162
|
}
|
|
1186
1163
|
/**
|
|
1187
|
-
* X402 payment
|
|
1164
|
+
* <p>The output from a crypto X402 payment.</p>
|
|
1188
1165
|
* @public
|
|
1189
1166
|
*/
|
|
1190
1167
|
export interface CryptoX402PaymentOutput {
|
|
1191
1168
|
/**
|
|
1192
|
-
* The
|
|
1169
|
+
* <p>The version of the X402 protocol.</p>
|
|
1193
1170
|
* @public
|
|
1194
1171
|
*/
|
|
1195
1172
|
version: string | undefined;
|
|
1196
1173
|
/**
|
|
1197
|
-
*
|
|
1174
|
+
* <p>The X402 payment response payload.</p>
|
|
1198
1175
|
* @public
|
|
1199
1176
|
*/
|
|
1200
1177
|
payload: __DocumentType | undefined;
|
|
1201
1178
|
}
|
|
1202
1179
|
/**
|
|
1203
|
-
*
|
|
1180
|
+
* <p>The payment output details, which vary by payment type.</p>
|
|
1204
1181
|
* @public
|
|
1205
1182
|
*/
|
|
1206
1183
|
export type PaymentOutput = PaymentOutput.CryptoX402Member | PaymentOutput.$UnknownMember;
|
|
@@ -1209,7 +1186,7 @@ export type PaymentOutput = PaymentOutput.CryptoX402Member | PaymentOutput.$Unkn
|
|
|
1209
1186
|
*/
|
|
1210
1187
|
export declare namespace PaymentOutput {
|
|
1211
1188
|
/**
|
|
1212
|
-
* X402 payment
|
|
1189
|
+
* <p>Output from a crypto X402 payment.</p>
|
|
1213
1190
|
* @public
|
|
1214
1191
|
*/
|
|
1215
1192
|
interface CryptoX402Member {
|
|
@@ -1233,52 +1210,52 @@ export declare namespace PaymentOutput {
|
|
|
1233
1210
|
}
|
|
1234
1211
|
}
|
|
1235
1212
|
/**
|
|
1236
|
-
* Response structure for processing a payment
|
|
1213
|
+
* <p>Response structure for processing a payment.</p>
|
|
1237
1214
|
* @public
|
|
1238
1215
|
*/
|
|
1239
1216
|
export interface ProcessPaymentResponse {
|
|
1240
1217
|
/**
|
|
1241
|
-
* The unique
|
|
1218
|
+
* <p>The unique identifier of the processed payment.</p>
|
|
1242
1219
|
* @public
|
|
1243
1220
|
*/
|
|
1244
1221
|
processPaymentId: string | undefined;
|
|
1245
1222
|
/**
|
|
1246
|
-
* The ARN of the payment manager
|
|
1223
|
+
* <p>The ARN of the payment manager.</p>
|
|
1247
1224
|
* @public
|
|
1248
1225
|
*/
|
|
1249
1226
|
paymentManagerArn: string | undefined;
|
|
1250
1227
|
/**
|
|
1251
|
-
* The ID of the payment session
|
|
1228
|
+
* <p>The ID of the payment session used.</p>
|
|
1252
1229
|
* @public
|
|
1253
1230
|
*/
|
|
1254
1231
|
paymentSessionId: string | undefined;
|
|
1255
1232
|
/**
|
|
1256
|
-
* The ID of the payment instrument used
|
|
1233
|
+
* <p>The ID of the payment instrument used.</p>
|
|
1257
1234
|
* @public
|
|
1258
1235
|
*/
|
|
1259
1236
|
paymentInstrumentId: string | undefined;
|
|
1260
1237
|
/**
|
|
1261
|
-
* The type of payment
|
|
1238
|
+
* <p>The type of payment processed.</p>
|
|
1262
1239
|
* @public
|
|
1263
1240
|
*/
|
|
1264
1241
|
paymentType: PaymentType | undefined;
|
|
1265
1242
|
/**
|
|
1266
|
-
* The status of the payment
|
|
1243
|
+
* <p>The status of the payment.</p>
|
|
1267
1244
|
* @public
|
|
1268
1245
|
*/
|
|
1269
1246
|
status: PaymentStatus | undefined;
|
|
1270
1247
|
/**
|
|
1271
|
-
* The payment output details specific to the payment type
|
|
1248
|
+
* <p>The payment output details specific to the payment type.</p>
|
|
1272
1249
|
* @public
|
|
1273
1250
|
*/
|
|
1274
1251
|
paymentOutput: PaymentOutput | undefined;
|
|
1275
1252
|
/**
|
|
1276
|
-
* The timestamp when the payment was created
|
|
1253
|
+
* <p>The timestamp when the payment was created.</p>
|
|
1277
1254
|
* @public
|
|
1278
1255
|
*/
|
|
1279
1256
|
createdAt: Date | undefined;
|
|
1280
1257
|
/**
|
|
1281
|
-
* The timestamp when the payment was last updated
|
|
1258
|
+
* <p>The timestamp when the payment was last updated.</p>
|
|
1282
1259
|
* @public
|
|
1283
1260
|
*/
|
|
1284
1261
|
updatedAt: Date | undefined;
|