@openfort/openfort-node 0.6.32 → 0.6.34

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.
Files changed (103) hide show
  1. package/README.md +24 -0
  2. package/dist/apis/playersApiWrapper.d.ts +1 -21
  3. package/dist/apis/playersApiWrapper.js +0 -31
  4. package/dist/apis/playersApiWrapper.js.map +1 -1
  5. package/dist/apis/policiesApiWrapper.d.ts +1 -16
  6. package/dist/apis/policiesApiWrapper.js +0 -23
  7. package/dist/apis/policiesApiWrapper.js.map +1 -1
  8. package/dist/apis/settingsApiWrapper.d.ts +2 -2
  9. package/dist/apis/settingsApiWrapper.js.map +1 -1
  10. package/dist/generated/apis/AccountsApi.d.ts +9 -9
  11. package/dist/generated/apis/AccountsApi.js +9 -9
  12. package/dist/generated/apis/InventoriesApi.d.ts +0 -28
  13. package/dist/generated/apis/InventoriesApi.js +0 -111
  14. package/dist/generated/apis/InventoriesApi.js.map +1 -1
  15. package/dist/generated/apis/PlayersApi.d.ts +2 -64
  16. package/dist/generated/apis/PlayersApi.js +2 -249
  17. package/dist/generated/apis/PlayersApi.js.map +1 -1
  18. package/dist/generated/apis/PoliciesApi.d.ts +2 -47
  19. package/dist/generated/apis/PoliciesApi.js +2 -197
  20. package/dist/generated/apis/PoliciesApi.js.map +1 -1
  21. package/dist/generated/apis/SessionsApi.d.ts +4 -1
  22. package/dist/generated/apis/SessionsApi.js +4 -1
  23. package/dist/generated/apis/SessionsApi.js.map +1 -1
  24. package/dist/generated/apis/TransactionIntentsApi.d.ts +6 -4
  25. package/dist/generated/apis/TransactionIntentsApi.js +6 -4
  26. package/dist/generated/apis/TransactionIntentsApi.js.map +1 -1
  27. package/dist/generated/models/CancelTransferOwnershipRequest.d.ts +1 -1
  28. package/dist/generated/models/CreateAccountRequest.d.ts +6 -6
  29. package/dist/generated/models/CreateContractRequest.d.ts +1 -1
  30. package/dist/generated/models/CreatePolicyRequest.d.ts +1 -1
  31. package/dist/generated/models/CreatePolicyRuleRequest.d.ts +2 -2
  32. package/dist/generated/models/CreateSessionRequest.d.ts +3 -3
  33. package/dist/generated/models/CreateTransactionIntentRequest.d.ts +8 -8
  34. package/dist/generated/models/CreateWeb3ConnectionRequest.d.ts +2 -2
  35. package/dist/generated/models/Interaction.d.ts +5 -5
  36. package/dist/generated/models/NextActionPayload.d.ts +8 -0
  37. package/dist/generated/models/NextActionPayload.js +12 -0
  38. package/dist/generated/models/NextActionPayload.js.map +1 -1
  39. package/dist/generated/models/ObjectSerializer.d.ts +0 -7
  40. package/dist/generated/models/ObjectSerializer.js +0 -20
  41. package/dist/generated/models/ObjectSerializer.js.map +1 -1
  42. package/dist/generated/models/PlayerCancelTransferOwnershipRequest.d.ts +2 -2
  43. package/dist/generated/models/PlayerTransferOwnershipRequest.d.ts +3 -3
  44. package/dist/generated/models/ResponseResponse.d.ts +0 -1
  45. package/dist/generated/models/ResponseResponse.js +0 -6
  46. package/dist/generated/models/ResponseResponse.js.map +1 -1
  47. package/dist/generated/models/RevokeSessionRequest.d.ts +2 -2
  48. package/dist/generated/models/SignatureRequest.d.ts +1 -1
  49. package/dist/generated/models/SubmitWeb3ActionRequest.d.ts +1 -1
  50. package/dist/generated/models/TransactionIntentListQueries.d.ts +1 -1
  51. package/dist/generated/models/TransactionIntentResponseAccount.d.ts +1 -1
  52. package/dist/generated/models/TransactionIntentResponseAccount.js +1 -1
  53. package/dist/generated/models/TransactionIntentResponseExpandable.d.ts +1 -1
  54. package/dist/generated/models/TransferOwnershipRequest.d.ts +1 -1
  55. package/dist/generated/models/UpdateContractRequest.d.ts +1 -1
  56. package/dist/generated/models/UpdatePolicyRequest.d.ts +1 -1
  57. package/dist/generated/models/UpdatePolicyRuleRequest.d.ts +2 -2
  58. package/dist/generated/models/all.d.ts +0 -7
  59. package/dist/generated/models/all.js +0 -7
  60. package/dist/generated/models/all.js.map +1 -1
  61. package/dist/generated/types/ObjectParamAPI.d.ts +23 -191
  62. package/dist/generated/types/ObjectParamAPI.js +19 -74
  63. package/dist/generated/types/ObjectParamAPI.js.map +1 -1
  64. package/dist/generated/types/ObservableAPI.d.ts +23 -74
  65. package/dist/generated/types/ObservableAPI.js +23 -204
  66. package/dist/generated/types/ObservableAPI.js.map +1 -1
  67. package/dist/generated/types/PromiseAPI.d.ts +23 -74
  68. package/dist/generated/types/PromiseAPI.js +23 -96
  69. package/dist/generated/types/PromiseAPI.js.map +1 -1
  70. package/dist/models/index.d.ts +0 -2
  71. package/dist/models/index.js +0 -1
  72. package/dist/models/index.js.map +1 -1
  73. package/dist/version.d.ts +1 -1
  74. package/dist/version.js +1 -1
  75. package/package.json +1 -1
  76. package/tsconfig.tsbuildinfo +1 -1
  77. package/dist/generated/models/CreatePlayerAccountRequest.d.ts +0 -47
  78. package/dist/generated/models/CreatePlayerAccountRequest.js +0 -56
  79. package/dist/generated/models/CreatePlayerAccountRequest.js.map +0 -1
  80. package/dist/generated/models/CreatePlayerSessionRequest.d.ts +0 -63
  81. package/dist/generated/models/CreatePlayerSessionRequest.js +0 -80
  82. package/dist/generated/models/CreatePlayerSessionRequest.js.map +0 -1
  83. package/dist/generated/models/CreatePolicyAllowFunctionRequest.d.ts +0 -51
  84. package/dist/generated/models/CreatePolicyAllowFunctionRequest.js +0 -68
  85. package/dist/generated/models/CreatePolicyAllowFunctionRequest.js.map +0 -1
  86. package/dist/generated/models/ObsoleteAssetInventory.d.ts +0 -36
  87. package/dist/generated/models/ObsoleteAssetInventory.js +0 -56
  88. package/dist/generated/models/ObsoleteAssetInventory.js.map +0 -1
  89. package/dist/generated/models/ObsoleteAssetType.d.ts +0 -12
  90. package/dist/generated/models/ObsoleteAssetType.js +0 -14
  91. package/dist/generated/models/ObsoleteAssetType.js.map +0 -1
  92. package/dist/generated/models/ObsoleteInventoryResponse.d.ts +0 -33
  93. package/dist/generated/models/ObsoleteInventoryResponse.js +0 -50
  94. package/dist/generated/models/ObsoleteInventoryResponse.js.map +0 -1
  95. package/dist/generated/models/RevokeSessionPlayerRequest.d.ts +0 -43
  96. package/dist/generated/models/RevokeSessionPlayerRequest.js +0 -50
  97. package/dist/generated/models/RevokeSessionPlayerRequest.js.map +0 -1
  98. package/dist/models/createPlayerSessionRequest.d.ts +0 -4
  99. package/dist/models/createPlayerSessionRequest.js +0 -3
  100. package/dist/models/createPlayerSessionRequest.js.map +0 -1
  101. package/dist/models/revokePlayerSessionRequest.d.ts +0 -4
  102. package/dist/models/revokePlayerSessionRequest.js +0 -3
  103. package/dist/models/revokePlayerSessionRequest.js.map +0 -1
@@ -13,9 +13,6 @@ import { ContractReadResponse } from '../models/ContractReadResponse';
13
13
  import { ContractResponse } from '../models/ContractResponse';
14
14
  import { CreateAccountRequest } from '../models/CreateAccountRequest';
15
15
  import { CreateContractRequest } from '../models/CreateContractRequest';
16
- import { CreatePlayerAccountRequest } from '../models/CreatePlayerAccountRequest';
17
- import { CreatePlayerSessionRequest } from '../models/CreatePlayerSessionRequest';
18
- import { CreatePolicyAllowFunctionRequest } from '../models/CreatePolicyAllowFunctionRequest';
19
16
  import { CreatePolicyRequest } from '../models/CreatePolicyRequest';
20
17
  import { CreatePolicyRuleRequest } from '../models/CreatePolicyRuleRequest';
21
18
  import { CreateSessionRequest } from '../models/CreateSessionRequest';
@@ -37,7 +34,6 @@ import { OAuthConfig } from '../models/OAuthConfig';
37
34
  import { OAuthConfigListResponse } from '../models/OAuthConfigListResponse';
38
35
  import { OAuthProvider } from '../models/OAuthProvider';
39
36
  import { OAuthRequest } from '../models/OAuthRequest';
40
- import { ObsoleteInventoryResponse } from '../models/ObsoleteInventoryResponse';
41
37
  import { PlayerCancelTransferOwnershipRequest } from '../models/PlayerCancelTransferOwnershipRequest';
42
38
  import { PlayerCreateRequest } from '../models/PlayerCreateRequest';
43
39
  import { PlayerDeleteResponse } from '../models/PlayerDeleteResponse';
@@ -56,7 +52,6 @@ import { PolicyRuleResponse } from '../models/PolicyRuleResponse';
56
52
  import { RegisterPlayerEncryptedKeyRequest } from '../models/RegisterPlayerEncryptedKeyRequest';
57
53
  import { RegisterPlayerEncryptedKeyResponse } from '../models/RegisterPlayerEncryptedKeyResponse';
58
54
  import { RetrievePlayerEncryptedKeyResponse } from '../models/RetrievePlayerEncryptedKeyResponse';
59
- import { RevokeSessionPlayerRequest } from '../models/RevokeSessionPlayerRequest';
60
55
  import { RevokeSessionRequest } from '../models/RevokeSessionRequest';
61
56
  import { SessionListResponse } from '../models/SessionListResponse';
62
57
  import { SessionResponse } from '../models/SessionResponse';
@@ -86,9 +81,9 @@ export declare class PromiseAccountsApi {
86
81
  private api;
87
82
  constructor(configuration: Configuration, requestFactory?: AccountsApiRequestFactory, responseProcessor?: AccountsApiResponseProcessor);
88
83
  /**
89
- * This endpoint allows you to cancel a pending transfer of ownership.
84
+ * Cancel a pending transfer of ownership.
90
85
  * Cancel request to transfer ownership of an account.
91
- * @param id Specifies the unique account ID.
86
+ * @param id Specifies the unique account ID (starts with acc_).
92
87
  * @param cancelTransferOwnershipRequest
93
88
  */
94
89
  cancelTransferOwnership(id: string, cancelTransferOwnershipRequest: CancelTransferOwnershipRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
@@ -99,7 +94,7 @@ export declare class PromiseAccountsApi {
99
94
  */
100
95
  completeRecovery(id: string, completeRecoveryRequest: CompleteRecoveryRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
101
96
  /**
102
- * This endpoint allows you to add a new account to your Openfort player. Only one account can be active per chain per player.
97
+ * Creates a new blockchain account for the provided player. Account creation does not consume any gas. All accounts of a player will use the same address across blockchains. Only one account can per chain per player.
103
98
  * Create an account object.
104
99
  * @param createAccountRequest
105
100
  */
@@ -112,14 +107,14 @@ export declare class PromiseAccountsApi {
112
107
  */
113
108
  deployAccount(id: string, deployRequest: DeployRequest, _options?: Configuration): Promise<AccountResponse>;
114
109
  /**
115
- * Retrieves the details of an existing account. Supply the unique account ID from either a account creation request or the account list, and Openfort will return the corresponding account information.
110
+ * Retrieves the details of an existing account. Supply the unique account ID from either a account creation request or the account list, and Openfort will return the corresponding account information.
116
111
  * Get existing account.
117
112
  * @param id Specifies the unique account ID (starts with acc_).
118
113
  * @param expand
119
114
  */
120
115
  getAccount(id: string, expand?: Array<AccountResponseExpandable>, _options?: Configuration): Promise<AccountResponse>;
121
116
  /**
122
- * Returns a list of accounts for the given player. The accounts are returned sorted by creation date, with the most recently created accounts appearing first. By default, a maximum of ten accounts are shown per page.
117
+ * Returns a list of accounts for the given player. The accounts are returned sorted by creation date, with the most recently created accounts appearing first. By default, a maximum of 10 accounts are shown per page.
123
118
  * List accounts of a player.
124
119
  * @param player Specifies the unique player ID (starts with pla_)
125
120
  * @param limit Specifies the maximum number of records to return.
@@ -129,16 +124,16 @@ export declare class PromiseAccountsApi {
129
124
  */
130
125
  getAccounts(player: string, limit?: number, skip?: number, order?: SortOrder, expand?: Array<AccountResponseExpandable>, _options?: Configuration): Promise<AccountListResponse>;
131
126
  /**
132
- * This endpoint allows you to perform a request to change the owner of an account. To perform an update on the owner of an account, first you must provide a new owner address. Once requested, the owner must accept to take ownership by calling `acceptOwnership()` in the smart contract account.
127
+ * Perform a request to change the owner of an account. To perform an update on the owner of an account, first you must provide a new owner address. Once requested, the owner must accept to take ownership by calling `acceptOwnership()` in the smart contract account.
133
128
  * Request transfer ownership of account.
134
- * @param id Specifies the unique account ID.
129
+ * @param id Specifies the unique account ID (starts with acc_).
135
130
  * @param transferOwnershipRequest
136
131
  */
137
132
  requestTransferOwnership(id: string, transferOwnershipRequest: TransferOwnershipRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
138
133
  /**
139
134
  * Signs the typed data value with types data structure for domain using the [EIP-712](https://eips.ethereum.org/EIPS/eip-712) specification.
140
135
  * Sign a given payload
141
- * @param id Specifies the unique account ID.
136
+ * @param id Specifies the unique account ID (starts with acc_).
142
137
  * @param signPayloadRequest
143
138
  */
144
139
  signPayload(id: string, signPayloadRequest: SignPayloadRequest, _options?: Configuration): Promise<SignPayloadResponse>;
@@ -149,7 +144,7 @@ export declare class PromiseAccountsApi {
149
144
  */
150
145
  startRecovery(id: string, startRecoveryRequest: StartRecoveryRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
151
146
  /**
152
- * This endpoint updates the account state with the blockchain. Specifically, it updates the account owner and whether its deployed or not.
147
+ * Synchronize the account state with the blockchain. Specifically, it updates the account owner and whether its deployed or not.
153
148
  * Sync account state with the blockchain
154
149
  * @param id Specifies the unique account ID (starts with acc_).
155
150
  */
@@ -254,11 +249,6 @@ export declare class PromiseInventoriesApi {
254
249
  * @param contractId
255
250
  */
256
251
  getAccountCryptoCurrencyInventory(id: string, limit?: number, skip?: number, order?: SortOrder, contractId?: Array<string>, _options?: Configuration): Promise<InventoryListResponse>;
257
- /**
258
- * Get inventory of account.
259
- * @param id Specifies the unique account ID (starts with acc_).
260
- */
261
- getAccountInventory(id: string, _options?: Configuration): Promise<ObsoleteInventoryResponse>;
262
252
  /**
263
253
  * Retrieves the native asset of an existing account.
264
254
  * @param id Specifies the unique account ID.
@@ -283,12 +273,6 @@ export declare class PromiseInventoriesApi {
283
273
  * @param contractId Filter by contract ID (starts with con_).
284
274
  */
285
275
  getPlayerCryptoCurrencyInventory(id: string, chainId: number, limit?: number, skip?: number, order?: SortOrder, contractId?: Array<string>, _options?: Configuration): Promise<InventoryListResponse>;
286
- /**
287
- * Get inventory of player.
288
- * @param id Specifies the unique player ID (starts with pla_).
289
- * @param chainId Filter by chain id.
290
- */
291
- getPlayerInventory(id: string, chainId: number, _options?: Configuration): Promise<ObsoleteInventoryResponse>;
292
276
  /**
293
277
  * Get native token list of player.
294
278
  * @param id Specifies the unique player ID (starts with pla_).
@@ -367,23 +351,11 @@ export declare class PromisePlayersApi {
367
351
  */
368
352
  cancelTransferAccountOwnership(id: string, playerCancelTransferOwnershipRequest: PlayerCancelTransferOwnershipRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
369
353
  /**
370
- * Add a new player to your player list in Openfort.
354
+ * Creates a Player.
371
355
  * Create a player object.
372
356
  * @param playerCreateRequest
373
357
  */
374
358
  createPlayer(playerCreateRequest: PlayerCreateRequest, _options?: Configuration): Promise<PlayerResponse>;
375
- /**
376
- * Create account object for a player.
377
- * @param id Specifies the unique player ID (starts with pla_).
378
- * @param createPlayerAccountRequest
379
- */
380
- createPlayerAccount(id: string, createPlayerAccountRequest: CreatePlayerAccountRequest, _options?: Configuration): Promise<AccountResponse>;
381
- /**
382
- * Create session object for a player.
383
- * @param id Specifies the unique player ID (starts with pla_).
384
- * @param createPlayerSessionRequest
385
- */
386
- createPlayerSession(id: string, createPlayerSessionRequest: CreatePlayerSessionRequest, _options?: Configuration): Promise<SessionResponse>;
387
359
  /**
388
360
  * Deletes a player object.
389
361
  * @param id Specifies the unique player ID (starts with pla_).
@@ -395,12 +367,6 @@ export declare class PromisePlayersApi {
395
367
  * @param expand Specifies the expandable fields.
396
368
  */
397
369
  getPlayer(id: string, expand?: Array<PlayerResponseExpandable>, _options?: Configuration): Promise<PlayerResponse>;
398
- /**
399
- * List of accounts of a player.
400
- * @param id Specifies the unique player ID (starts with pla_).
401
- * @param expand Specifies the expandable fields.
402
- */
403
- getPlayerAccounts(id: string, expand?: Array<AccountResponseExpandable>, _options?: Configuration): Promise<AccountListResponse>;
404
370
  /**
405
371
  * By default, a maximum of ten players are shown.
406
372
  * List players.
@@ -419,12 +385,7 @@ export declare class PromisePlayersApi {
419
385
  */
420
386
  requestTransferAccountOwnership(id: string, playerTransferOwnershipRequest: PlayerTransferOwnershipRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
421
387
  /**
422
- * Revoke session object for a player.
423
- * @param id Specifies the unique player ID (starts with pla_).
424
- * @param revokeSessionPlayerRequest
425
- */
426
- revokePlayerSession(id: string, revokeSessionPlayerRequest: RevokeSessionPlayerRequest, _options?: Configuration): Promise<SessionResponse>;
427
- /**
388
+ * Updates the specified Player by setting the values of the parameters passed.
428
389
  * Updates a player object.
429
390
  * @param id Specifies the unique player ID (starts with pla_).
430
391
  * @param playerUpdateRequest
@@ -462,12 +423,6 @@ export declare class PromisePoliciesApi {
462
423
  * @param createPolicyRequest
463
424
  */
464
425
  createPolicy(createPolicyRequest: CreatePolicyRequest, _options?: Configuration): Promise<PolicyResponse>;
465
- /**
466
- * Create a policy rule object for a policy.
467
- * @param id Specifies the unique policy ID (starts with pol_).
468
- * @param createPolicyAllowFunctionRequest
469
- */
470
- createPolicyAllowFunction(id: string, createPolicyAllowFunctionRequest: CreatePolicyAllowFunctionRequest, _options?: Configuration): Promise<PolicyRuleResponse>;
471
426
  /**
472
427
  * Delete a policy object.
473
428
  * @param id Specifies the unique policy ID (starts with pol_).
@@ -484,6 +439,7 @@ export declare class PromisePoliciesApi {
484
439
  */
485
440
  enablePolicy(id: string, _options?: Configuration): Promise<PolicyResponse>;
486
441
  /**
442
+ * Returns a list of Policies.
487
443
  * List policies.
488
444
  * @param limit Specifies the maximum number of records to return.
489
445
  * @param skip Specifies the offset for the first records to return.
@@ -496,17 +452,12 @@ export declare class PromisePoliciesApi {
496
452
  */
497
453
  getPolicies(limit?: number, skip?: number, order?: SortOrder, expand?: Array<PolicyResponseExpandable>, name?: string, deleted?: boolean, chainId?: number, enabled?: boolean, _options?: Configuration): Promise<PolicyListResponse>;
498
454
  /**
455
+ * Retrieves the details of a Policy that has previously been created.
499
456
  * Get a policy object.
500
457
  * @param id Specifies the unique policy ID (starts with pol_).
501
458
  * @param expand Specifies the fields to expand.
502
459
  */
503
460
  getPolicy(id: string, expand?: Array<PolicyResponseExpandable>, _options?: Configuration): Promise<PolicyResponse>;
504
- /**
505
- * List policy rules of a policy.
506
- * @param id Specifies the unique policy ID (starts with pol_).
507
- * @param expand Specifies the fields to expand.
508
- */
509
- getPolicyAllowFunctions(id: string, expand?: Array<'contract'>, _options?: Configuration): Promise<PolicyRuleListResponse>;
510
461
  /**
511
462
  * List all gas reports of a policy.
512
463
  * @param id Specifies the unique policy ID (starts with pol_).
@@ -518,13 +469,6 @@ export declare class PromisePoliciesApi {
518
469
  * @param updatePolicyRequest
519
470
  */
520
471
  updatePolicy(id: string, updatePolicyRequest: UpdatePolicyRequest, _options?: Configuration): Promise<PolicyResponse>;
521
- /**
522
- * Update a policy rule object of a policy.
523
- * @param policy Specifies the unique policy ID (starts with pol_).
524
- * @param policyRule Specifies the unique policy rule ID (starts with afu_).
525
- * @param updatePolicyRuleRequest
526
- */
527
- updatePolicyAllowFunction(policy: string, policyRule: string, updatePolicyRuleRequest: UpdatePolicyRuleRequest, _options?: Configuration): Promise<PolicyRuleResponse>;
528
472
  }
529
473
  import { PolicyRulesApiRequestFactory, PolicyRulesApiResponseProcessor } from "../apis/PolicyRulesApi";
530
474
  export declare class PromisePolicyRulesApi {
@@ -561,11 +505,13 @@ export declare class PromiseSessionsApi {
561
505
  private api;
562
506
  constructor(configuration: Configuration, requestFactory?: SessionsApiRequestFactory, responseProcessor?: SessionsApiResponseProcessor);
563
507
  /**
508
+ * Creates a Session.
564
509
  * Create a session key.
565
510
  * @param createSessionRequest
566
511
  */
567
512
  createSession(createSessionRequest: CreateSessionRequest, _options?: Configuration): Promise<SessionResponse>;
568
513
  /**
514
+ * Returns a list of Sessions.
569
515
  * List session keys of a player.
570
516
  * @param player The player ID (starts with pla_)
571
517
  * @param limit Specifies the maximum number of records to return.
@@ -575,6 +521,7 @@ export declare class PromiseSessionsApi {
575
521
  */
576
522
  getPlayerSessions(player: string, limit?: number, skip?: number, order?: SortOrder, expand?: Array<SessionResponseExpandable>, _options?: Configuration): Promise<SessionListResponse>;
577
523
  /**
524
+ * Retrieves the details of a Session that has previously been created.
578
525
  * Returns a player session by session id
579
526
  * @param id Specifies the unique session ID (starts with ses_).
580
527
  * @param expand Specifies the fields to expand.
@@ -586,7 +533,7 @@ export declare class PromiseSessionsApi {
586
533
  */
587
534
  revokeSession(revokeSessionRequest: RevokeSessionRequest, _options?: Configuration): Promise<SessionResponse>;
588
535
  /**
589
- * Send signed userOpHash to create session.
536
+ * Send signed userOperationHash to create session.
590
537
  * @param id Specifies the unique session ID (starts with ses_).
591
538
  * @param signatureRequest
592
539
  */
@@ -636,37 +583,39 @@ export declare class PromiseTransactionIntentsApi {
636
583
  private api;
637
584
  constructor(configuration: Configuration, requestFactory?: TransactionIntentsApiRequestFactory, responseProcessor?: TransactionIntentsApiResponseProcessor);
638
585
  /**
639
- * Retrieve a transaction intent by providing their id on Openfort. Transaction intents that have not been processed yet, have the `response` attribute as undefined.
586
+ * Creates a TransactionIntent. A pending TransactionIntent has the `response` attribute as undefined. After the TransactionIntent is created and broadcasted to the blockchain, `response` will be populated with the transaction hash and a status (1 success, 0 fail). When using a non-custodial account, a `nextAction` attribute is returned with the `userOperationHash` that must be signed by the owner of the account.
640
587
  * Create a transaction intent object.
641
588
  * @param createTransactionIntentRequest
642
589
  */
643
590
  createTransactionIntent(createTransactionIntentRequest: CreateTransactionIntentRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
644
591
  /**
645
- * Estimate the gas cost of creating a transaction intent and putting it on chain. If a policy that includes payment of gas in ERC-20 tokens is provided, an extra field `estimatedTXGasFeeToken` is returned with the estimated amount of tokens.
592
+ * Estimate the gas cost of broadcasting a TransactionIntent. This is a simulation, it does not send the transaction on-chain. If a Policy ID is used that includes payment of gas in ERC-20 tokens, an extra field `estimatedTXGasFeeToken` is returned with the estimated amount of tokens that will be used.
646
593
  * Estimate gas cost of creating a transaction
647
594
  * @param createTransactionIntentRequest
648
595
  */
649
596
  estimateTransactionIntentCost(createTransactionIntentRequest: CreateTransactionIntentRequest, _options?: Configuration): Promise<EstimateTransactionIntentGasResult>;
650
597
  /**
598
+ * Retrieves the details of a TransactionIntent that has previously been created.
651
599
  * Get a transaction intent object.
652
600
  * @param id Specifies the unique transaction intent ID (starts with tin_).
653
601
  * @param expand Specifies the expandable fields.
654
602
  */
655
603
  getTransactionIntent(id: string, expand?: Array<TransactionIntentResponseExpandable>, _options?: Configuration): Promise<TransactionIntentResponse>;
656
604
  /**
605
+ * Returns a list of TransactionIntents.
657
606
  * List transaction intents.
658
607
  * @param limit Specifies the maximum number of records to return.
659
608
  * @param skip Specifies the offset for the first records to return.
660
609
  * @param order Specifies the order in which to sort the results.
661
610
  * @param expand Specifies the fields to expand in the response.
662
- * @param chainId The chain ID.
611
+ * @param chainId The chain ID. Must be a [supported chain](/chains).
663
612
  * @param accountId Filter by account ID.
664
613
  * @param playerId Filter by player ID (starts with pla_).
665
614
  * @param policyId Filter by policy ID (starts with pol_).
666
615
  */
667
616
  getTransactionIntents(limit?: number, skip?: number, order?: SortOrder, expand?: Array<TransactionIntentResponseExpandable>, chainId?: number, accountId?: Array<string>, playerId?: Array<string>, policyId?: Array<string>, _options?: Configuration): Promise<TransactionIntentListResponse>;
668
617
  /**
669
- * For non-custodial smart accounts, each on chain action using their wallet, they must sign the userOperationHash received from the `POST` API endpoint that creates a transactionIntent.
618
+ * Broadcasts a signed TransactionIntent to the blockchain. Use this endpoint to send the signed `userOperationHash`. Openfort will then put it on-chain.
670
619
  * Send a signed transaction userOperationHash.
671
620
  * @param id Specifies the unique transaction intent ID (starts with tin_).
672
621
  * @param signatureRequest
@@ -7,9 +7,9 @@ class PromiseAccountsApi {
7
7
  this.api = new ObservableAPI_1.ObservableAccountsApi(configuration, requestFactory, responseProcessor);
8
8
  }
9
9
  /**
10
- * This endpoint allows you to cancel a pending transfer of ownership.
10
+ * Cancel a pending transfer of ownership.
11
11
  * Cancel request to transfer ownership of an account.
12
- * @param id Specifies the unique account ID.
12
+ * @param id Specifies the unique account ID (starts with acc_).
13
13
  * @param cancelTransferOwnershipRequest
14
14
  */
15
15
  cancelTransferOwnership(id, cancelTransferOwnershipRequest, _options) {
@@ -26,7 +26,7 @@ class PromiseAccountsApi {
26
26
  return result.toPromise();
27
27
  }
28
28
  /**
29
- * This endpoint allows you to add a new account to your Openfort player. Only one account can be active per chain per player.
29
+ * Creates a new blockchain account for the provided player. Account creation does not consume any gas. All accounts of a player will use the same address across blockchains. Only one account can per chain per player.
30
30
  * Create an account object.
31
31
  * @param createAccountRequest
32
32
  */
@@ -45,7 +45,7 @@ class PromiseAccountsApi {
45
45
  return result.toPromise();
46
46
  }
47
47
  /**
48
- * Retrieves the details of an existing account. Supply the unique account ID from either a account creation request or the account list, and Openfort will return the corresponding account information.
48
+ * Retrieves the details of an existing account. Supply the unique account ID from either a account creation request or the account list, and Openfort will return the corresponding account information.
49
49
  * Get existing account.
50
50
  * @param id Specifies the unique account ID (starts with acc_).
51
51
  * @param expand
@@ -55,7 +55,7 @@ class PromiseAccountsApi {
55
55
  return result.toPromise();
56
56
  }
57
57
  /**
58
- * Returns a list of accounts for the given player. The accounts are returned sorted by creation date, with the most recently created accounts appearing first. By default, a maximum of ten accounts are shown per page.
58
+ * Returns a list of accounts for the given player. The accounts are returned sorted by creation date, with the most recently created accounts appearing first. By default, a maximum of 10 accounts are shown per page.
59
59
  * List accounts of a player.
60
60
  * @param player Specifies the unique player ID (starts with pla_)
61
61
  * @param limit Specifies the maximum number of records to return.
@@ -68,9 +68,9 @@ class PromiseAccountsApi {
68
68
  return result.toPromise();
69
69
  }
70
70
  /**
71
- * This endpoint allows you to perform a request to change the owner of an account. To perform an update on the owner of an account, first you must provide a new owner address. Once requested, the owner must accept to take ownership by calling `acceptOwnership()` in the smart contract account.
71
+ * Perform a request to change the owner of an account. To perform an update on the owner of an account, first you must provide a new owner address. Once requested, the owner must accept to take ownership by calling `acceptOwnership()` in the smart contract account.
72
72
  * Request transfer ownership of account.
73
- * @param id Specifies the unique account ID.
73
+ * @param id Specifies the unique account ID (starts with acc_).
74
74
  * @param transferOwnershipRequest
75
75
  */
76
76
  requestTransferOwnership(id, transferOwnershipRequest, _options) {
@@ -80,7 +80,7 @@ class PromiseAccountsApi {
80
80
  /**
81
81
  * Signs the typed data value with types data structure for domain using the [EIP-712](https://eips.ethereum.org/EIPS/eip-712) specification.
82
82
  * Sign a given payload
83
- * @param id Specifies the unique account ID.
83
+ * @param id Specifies the unique account ID (starts with acc_).
84
84
  * @param signPayloadRequest
85
85
  */
86
86
  signPayload(id, signPayloadRequest, _options) {
@@ -97,7 +97,7 @@ class PromiseAccountsApi {
97
97
  return result.toPromise();
98
98
  }
99
99
  /**
100
- * This endpoint updates the account state with the blockchain. Specifically, it updates the account owner and whether its deployed or not.
100
+ * Synchronize the account state with the blockchain. Specifically, it updates the account owner and whether its deployed or not.
101
101
  * Sync account state with the blockchain
102
102
  * @param id Specifies the unique account ID (starts with acc_).
103
103
  */
@@ -249,14 +249,6 @@ class PromiseInventoriesApi {
249
249
  const result = this.api.getAccountCryptoCurrencyInventory(id, limit, skip, order, contractId, _options);
250
250
  return result.toPromise();
251
251
  }
252
- /**
253
- * Get inventory of account.
254
- * @param id Specifies the unique account ID (starts with acc_).
255
- */
256
- getAccountInventory(id, _options) {
257
- const result = this.api.getAccountInventory(id, _options);
258
- return result.toPromise();
259
- }
260
252
  /**
261
253
  * Retrieves the native asset of an existing account.
262
254
  * @param id Specifies the unique account ID.
@@ -290,15 +282,6 @@ class PromiseInventoriesApi {
290
282
  const result = this.api.getPlayerCryptoCurrencyInventory(id, chainId, limit, skip, order, contractId, _options);
291
283
  return result.toPromise();
292
284
  }
293
- /**
294
- * Get inventory of player.
295
- * @param id Specifies the unique player ID (starts with pla_).
296
- * @param chainId Filter by chain id.
297
- */
298
- getPlayerInventory(id, chainId, _options) {
299
- const result = this.api.getPlayerInventory(id, chainId, _options);
300
- return result.toPromise();
301
- }
302
285
  /**
303
286
  * Get native token list of player.
304
287
  * @param id Specifies the unique player ID (starts with pla_).
@@ -411,7 +394,7 @@ class PromisePlayersApi {
411
394
  return result.toPromise();
412
395
  }
413
396
  /**
414
- * Add a new player to your player list in Openfort.
397
+ * Creates a Player.
415
398
  * Create a player object.
416
399
  * @param playerCreateRequest
417
400
  */
@@ -419,24 +402,6 @@ class PromisePlayersApi {
419
402
  const result = this.api.createPlayer(playerCreateRequest, _options);
420
403
  return result.toPromise();
421
404
  }
422
- /**
423
- * Create account object for a player.
424
- * @param id Specifies the unique player ID (starts with pla_).
425
- * @param createPlayerAccountRequest
426
- */
427
- createPlayerAccount(id, createPlayerAccountRequest, _options) {
428
- const result = this.api.createPlayerAccount(id, createPlayerAccountRequest, _options);
429
- return result.toPromise();
430
- }
431
- /**
432
- * Create session object for a player.
433
- * @param id Specifies the unique player ID (starts with pla_).
434
- * @param createPlayerSessionRequest
435
- */
436
- createPlayerSession(id, createPlayerSessionRequest, _options) {
437
- const result = this.api.createPlayerSession(id, createPlayerSessionRequest, _options);
438
- return result.toPromise();
439
- }
440
405
  /**
441
406
  * Deletes a player object.
442
407
  * @param id Specifies the unique player ID (starts with pla_).
@@ -454,15 +419,6 @@ class PromisePlayersApi {
454
419
  const result = this.api.getPlayer(id, expand, _options);
455
420
  return result.toPromise();
456
421
  }
457
- /**
458
- * List of accounts of a player.
459
- * @param id Specifies the unique player ID (starts with pla_).
460
- * @param expand Specifies the expandable fields.
461
- */
462
- getPlayerAccounts(id, expand, _options) {
463
- const result = this.api.getPlayerAccounts(id, expand, _options);
464
- return result.toPromise();
465
- }
466
422
  /**
467
423
  * By default, a maximum of ten players are shown.
468
424
  * List players.
@@ -487,15 +443,7 @@ class PromisePlayersApi {
487
443
  return result.toPromise();
488
444
  }
489
445
  /**
490
- * Revoke session object for a player.
491
- * @param id Specifies the unique player ID (starts with pla_).
492
- * @param revokeSessionPlayerRequest
493
- */
494
- revokePlayerSession(id, revokeSessionPlayerRequest, _options) {
495
- const result = this.api.revokePlayerSession(id, revokeSessionPlayerRequest, _options);
496
- return result.toPromise();
497
- }
498
- /**
446
+ * Updates the specified Player by setting the values of the parameters passed.
499
447
  * Updates a player object.
500
448
  * @param id Specifies the unique player ID (starts with pla_).
501
449
  * @param playerUpdateRequest
@@ -552,15 +500,6 @@ class PromisePoliciesApi {
552
500
  const result = this.api.createPolicy(createPolicyRequest, _options);
553
501
  return result.toPromise();
554
502
  }
555
- /**
556
- * Create a policy rule object for a policy.
557
- * @param id Specifies the unique policy ID (starts with pol_).
558
- * @param createPolicyAllowFunctionRequest
559
- */
560
- createPolicyAllowFunction(id, createPolicyAllowFunctionRequest, _options) {
561
- const result = this.api.createPolicyAllowFunction(id, createPolicyAllowFunctionRequest, _options);
562
- return result.toPromise();
563
- }
564
503
  /**
565
504
  * Delete a policy object.
566
505
  * @param id Specifies the unique policy ID (starts with pol_).
@@ -586,6 +525,7 @@ class PromisePoliciesApi {
586
525
  return result.toPromise();
587
526
  }
588
527
  /**
528
+ * Returns a list of Policies.
589
529
  * List policies.
590
530
  * @param limit Specifies the maximum number of records to return.
591
531
  * @param skip Specifies the offset for the first records to return.
@@ -601,6 +541,7 @@ class PromisePoliciesApi {
601
541
  return result.toPromise();
602
542
  }
603
543
  /**
544
+ * Retrieves the details of a Policy that has previously been created.
604
545
  * Get a policy object.
605
546
  * @param id Specifies the unique policy ID (starts with pol_).
606
547
  * @param expand Specifies the fields to expand.
@@ -609,15 +550,6 @@ class PromisePoliciesApi {
609
550
  const result = this.api.getPolicy(id, expand, _options);
610
551
  return result.toPromise();
611
552
  }
612
- /**
613
- * List policy rules of a policy.
614
- * @param id Specifies the unique policy ID (starts with pol_).
615
- * @param expand Specifies the fields to expand.
616
- */
617
- getPolicyAllowFunctions(id, expand, _options) {
618
- const result = this.api.getPolicyAllowFunctions(id, expand, _options);
619
- return result.toPromise();
620
- }
621
553
  /**
622
554
  * List all gas reports of a policy.
623
555
  * @param id Specifies the unique policy ID (starts with pol_).
@@ -635,16 +567,6 @@ class PromisePoliciesApi {
635
567
  const result = this.api.updatePolicy(id, updatePolicyRequest, _options);
636
568
  return result.toPromise();
637
569
  }
638
- /**
639
- * Update a policy rule object of a policy.
640
- * @param policy Specifies the unique policy ID (starts with pol_).
641
- * @param policyRule Specifies the unique policy rule ID (starts with afu_).
642
- * @param updatePolicyRuleRequest
643
- */
644
- updatePolicyAllowFunction(policy, policyRule, updatePolicyRuleRequest, _options) {
645
- const result = this.api.updatePolicyAllowFunction(policy, policyRule, updatePolicyRuleRequest, _options);
646
- return result.toPromise();
647
- }
648
570
  }
649
571
  exports.PromisePoliciesApi = PromisePoliciesApi;
650
572
  const ObservableAPI_10 = require("./ObservableAPI");
@@ -697,6 +619,7 @@ class PromiseSessionsApi {
697
619
  this.api = new ObservableAPI_11.ObservableSessionsApi(configuration, requestFactory, responseProcessor);
698
620
  }
699
621
  /**
622
+ * Creates a Session.
700
623
  * Create a session key.
701
624
  * @param createSessionRequest
702
625
  */
@@ -705,6 +628,7 @@ class PromiseSessionsApi {
705
628
  return result.toPromise();
706
629
  }
707
630
  /**
631
+ * Returns a list of Sessions.
708
632
  * List session keys of a player.
709
633
  * @param player The player ID (starts with pla_)
710
634
  * @param limit Specifies the maximum number of records to return.
@@ -717,6 +641,7 @@ class PromiseSessionsApi {
717
641
  return result.toPromise();
718
642
  }
719
643
  /**
644
+ * Retrieves the details of a Session that has previously been created.
720
645
  * Returns a player session by session id
721
646
  * @param id Specifies the unique session ID (starts with ses_).
722
647
  * @param expand Specifies the fields to expand.
@@ -734,7 +659,7 @@ class PromiseSessionsApi {
734
659
  return result.toPromise();
735
660
  }
736
661
  /**
737
- * Send signed userOpHash to create session.
662
+ * Send signed userOperationHash to create session.
738
663
  * @param id Specifies the unique session ID (starts with ses_).
739
664
  * @param signatureRequest
740
665
  */
@@ -809,7 +734,7 @@ class PromiseTransactionIntentsApi {
809
734
  this.api = new ObservableAPI_13.ObservableTransactionIntentsApi(configuration, requestFactory, responseProcessor);
810
735
  }
811
736
  /**
812
- * Retrieve a transaction intent by providing their id on Openfort. Transaction intents that have not been processed yet, have the `response` attribute as undefined.
737
+ * Creates a TransactionIntent. A pending TransactionIntent has the `response` attribute as undefined. After the TransactionIntent is created and broadcasted to the blockchain, `response` will be populated with the transaction hash and a status (1 success, 0 fail). When using a non-custodial account, a `nextAction` attribute is returned with the `userOperationHash` that must be signed by the owner of the account.
813
738
  * Create a transaction intent object.
814
739
  * @param createTransactionIntentRequest
815
740
  */
@@ -818,7 +743,7 @@ class PromiseTransactionIntentsApi {
818
743
  return result.toPromise();
819
744
  }
820
745
  /**
821
- * Estimate the gas cost of creating a transaction intent and putting it on chain. If a policy that includes payment of gas in ERC-20 tokens is provided, an extra field `estimatedTXGasFeeToken` is returned with the estimated amount of tokens.
746
+ * Estimate the gas cost of broadcasting a TransactionIntent. This is a simulation, it does not send the transaction on-chain. If a Policy ID is used that includes payment of gas in ERC-20 tokens, an extra field `estimatedTXGasFeeToken` is returned with the estimated amount of tokens that will be used.
822
747
  * Estimate gas cost of creating a transaction
823
748
  * @param createTransactionIntentRequest
824
749
  */
@@ -827,6 +752,7 @@ class PromiseTransactionIntentsApi {
827
752
  return result.toPromise();
828
753
  }
829
754
  /**
755
+ * Retrieves the details of a TransactionIntent that has previously been created.
830
756
  * Get a transaction intent object.
831
757
  * @param id Specifies the unique transaction intent ID (starts with tin_).
832
758
  * @param expand Specifies the expandable fields.
@@ -836,12 +762,13 @@ class PromiseTransactionIntentsApi {
836
762
  return result.toPromise();
837
763
  }
838
764
  /**
765
+ * Returns a list of TransactionIntents.
839
766
  * List transaction intents.
840
767
  * @param limit Specifies the maximum number of records to return.
841
768
  * @param skip Specifies the offset for the first records to return.
842
769
  * @param order Specifies the order in which to sort the results.
843
770
  * @param expand Specifies the fields to expand in the response.
844
- * @param chainId The chain ID.
771
+ * @param chainId The chain ID. Must be a [supported chain](/chains).
845
772
  * @param accountId Filter by account ID.
846
773
  * @param playerId Filter by player ID (starts with pla_).
847
774
  * @param policyId Filter by policy ID (starts with pol_).
@@ -851,7 +778,7 @@ class PromiseTransactionIntentsApi {
851
778
  return result.toPromise();
852
779
  }
853
780
  /**
854
- * For non-custodial smart accounts, each on chain action using their wallet, they must sign the userOperationHash received from the `POST` API endpoint that creates a transactionIntent.
781
+ * Broadcasts a signed TransactionIntent to the blockchain. Use this endpoint to send the signed `userOperationHash`. Openfort will then put it on-chain.
855
782
  * Send a signed transaction userOperationHash.
856
783
  * @param id Specifies the unique transaction intent ID (starts with tin_).
857
784
  * @param signatureRequest