@openfort/openfort-node 0.6.4 → 0.6.6-beta.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.
Files changed (215) hide show
  1. package/dist/apis/baseApiWrapper.js +2 -2
  2. package/dist/apis/sessionsApiWrapper.js +1 -1
  3. package/dist/apis/sessionsApiWrapper.js.map +1 -1
  4. package/dist/apis/transactionIntentsApiWrapper.d.ts +1 -11
  5. package/dist/apis/transactionIntentsApiWrapper.js +0 -14
  6. package/dist/apis/transactionIntentsApiWrapper.js.map +1 -1
  7. package/dist/generated/apis/AccountsApi.d.ts +15 -10
  8. package/dist/generated/apis/AccountsApi.js +15 -10
  9. package/dist/generated/apis/AccountsApi.js.map +1 -1
  10. package/dist/generated/apis/AuthenticationApi.d.ts +4 -1
  11. package/dist/generated/apis/AuthenticationApi.js +4 -1
  12. package/dist/generated/apis/AuthenticationApi.js.map +1 -1
  13. package/dist/generated/apis/ConfigAuthenticationApi.d.ts +1 -1
  14. package/dist/generated/apis/ConfigAuthenticationApi.js +1 -1
  15. package/dist/generated/apis/ContractsApi.d.ts +16 -12
  16. package/dist/generated/apis/ContractsApi.js +17 -13
  17. package/dist/generated/apis/ContractsApi.js.map +1 -1
  18. package/dist/generated/apis/GoogleAuthenticationApi.d.ts +3 -1
  19. package/dist/generated/apis/GoogleAuthenticationApi.js +3 -1
  20. package/dist/generated/apis/GoogleAuthenticationApi.js.map +1 -1
  21. package/dist/generated/apis/InventoryApi.d.ts +26 -26
  22. package/dist/generated/apis/InventoryApi.js +30 -30
  23. package/dist/generated/apis/InventoryApi.js.map +1 -1
  24. package/dist/generated/apis/PlayersApi.d.ts +51 -17
  25. package/dist/generated/apis/PlayersApi.js +157 -19
  26. package/dist/generated/apis/PlayersApi.js.map +1 -1
  27. package/dist/generated/apis/PlayersAuthenticationApi.d.ts +5 -4
  28. package/dist/generated/apis/PlayersAuthenticationApi.js +5 -4
  29. package/dist/generated/apis/PlayersAuthenticationApi.js.map +1 -1
  30. package/dist/generated/apis/PoliciesApi.d.ts +24 -20
  31. package/dist/generated/apis/PoliciesApi.js +25 -21
  32. package/dist/generated/apis/PoliciesApi.js.map +1 -1
  33. package/dist/generated/apis/PolicyRulesApi.d.ts +11 -11
  34. package/dist/generated/apis/PolicyRulesApi.js +11 -11
  35. package/dist/generated/apis/SessionsApi.d.ts +12 -13
  36. package/dist/generated/apis/SessionsApi.js +12 -17
  37. package/dist/generated/apis/SessionsApi.js.map +1 -1
  38. package/dist/generated/apis/TransactionIntentsApi.d.ts +16 -37
  39. package/dist/generated/apis/TransactionIntentsApi.js +17 -119
  40. package/dist/generated/apis/TransactionIntentsApi.js.map +1 -1
  41. package/dist/generated/models/Account.d.ts +3 -0
  42. package/dist/generated/models/Account.js +1 -1
  43. package/dist/generated/models/Account.js.map +1 -1
  44. package/dist/generated/models/AccountInventoryListQueries.d.ts +6 -0
  45. package/dist/generated/models/AccountInventoryListQueries.js.map +1 -1
  46. package/dist/generated/models/AccountListQueries.d.ts +12 -0
  47. package/dist/generated/models/AccountListQueries.js.map +1 -1
  48. package/dist/generated/models/AccountResponse.d.ts +3 -0
  49. package/dist/generated/models/AccountResponse.js +1 -1
  50. package/dist/generated/models/AccountResponse.js.map +1 -1
  51. package/dist/generated/models/AuthPlayerListQueries.d.ts +9 -0
  52. package/dist/generated/models/AuthPlayerListQueries.js.map +1 -1
  53. package/dist/generated/models/CheckoutRequest.d.ts +1 -1
  54. package/dist/generated/models/ContractListQueries.d.ts +18 -0
  55. package/dist/generated/models/ContractListQueries.js +1 -1
  56. package/dist/generated/models/ContractListQueries.js.map +1 -1
  57. package/dist/generated/models/ContractPolicyRuleResponseContract.d.ts +3 -0
  58. package/dist/generated/models/ContractPolicyRuleResponseContract.js +1 -1
  59. package/dist/generated/models/ContractPolicyRuleResponseContract.js.map +1 -1
  60. package/dist/generated/models/ContractResponse.d.ts +3 -0
  61. package/dist/generated/models/ContractResponse.js +1 -1
  62. package/dist/generated/models/ContractResponse.js.map +1 -1
  63. package/dist/generated/models/CreateAccountRequest.js +1 -1
  64. package/dist/generated/models/CreateAccountRequest.js.map +1 -1
  65. package/dist/generated/models/CreateContractRequest.d.ts +15 -0
  66. package/dist/generated/models/CreateContractRequest.js.map +1 -1
  67. package/dist/generated/models/CreatePlayerAccountRequest.js +1 -1
  68. package/dist/generated/models/CreatePlayerAccountRequest.js.map +1 -1
  69. package/dist/generated/models/CreatePlayerRequest.d.ts +6 -0
  70. package/dist/generated/models/CreatePlayerRequest.js.map +1 -1
  71. package/dist/generated/models/CreatePlayerSessionRequest.d.ts +27 -0
  72. package/dist/generated/models/CreatePlayerSessionRequest.js.map +1 -1
  73. package/dist/generated/models/CreatePolicyAllowFunctionRequest.d.ts +15 -0
  74. package/dist/generated/models/CreatePolicyAllowFunctionRequest.js.map +1 -1
  75. package/dist/generated/models/CreatePolicyRequest.d.ts +6 -0
  76. package/dist/generated/models/CreatePolicyRequest.js +1 -1
  77. package/dist/generated/models/CreatePolicyRequest.js.map +1 -1
  78. package/dist/generated/models/CreatePolicyRuleRequest.d.ts +18 -0
  79. package/dist/generated/models/CreatePolicyRuleRequest.js.map +1 -1
  80. package/dist/generated/models/CreateSessionRequest.d.ts +30 -0
  81. package/dist/generated/models/CreateSessionRequest.js.map +1 -1
  82. package/dist/generated/models/CreateTransactionIntentRequest.d.ts +19 -0
  83. package/dist/generated/models/CreateTransactionIntentRequest.js +6 -0
  84. package/dist/generated/models/CreateTransactionIntentRequest.js.map +1 -1
  85. package/dist/generated/models/DomainData.d.ts +3 -0
  86. package/dist/generated/models/DomainData.js +1 -1
  87. package/dist/generated/models/DomainData.js.map +1 -1
  88. package/dist/generated/models/GasReport.d.ts +2 -1
  89. package/dist/generated/models/GasReport.js +1 -1
  90. package/dist/generated/models/GasReport.js.map +1 -1
  91. package/dist/generated/models/GasReportDataInner.d.ts +35 -0
  92. package/dist/generated/models/GasReportDataInner.js +62 -0
  93. package/dist/generated/models/GasReportDataInner.js.map +1 -0
  94. package/dist/generated/models/GasReportDataInnerPeriod.d.ts +29 -0
  95. package/dist/generated/models/GasReportDataInnerPeriod.js +38 -0
  96. package/dist/generated/models/GasReportDataInnerPeriod.js.map +1 -0
  97. package/dist/generated/models/GasReportDataInnerTransactionIntentsInner.d.ts +32 -0
  98. package/dist/generated/models/GasReportDataInnerTransactionIntentsInner.js +56 -0
  99. package/dist/generated/models/GasReportDataInnerTransactionIntentsInner.js.map +1 -0
  100. package/dist/generated/models/Interaction.d.ts +15 -0
  101. package/dist/generated/models/Interaction.js.map +1 -1
  102. package/dist/generated/models/Log.d.ts +1 -0
  103. package/dist/generated/models/Log.js +6 -0
  104. package/dist/generated/models/Log.js.map +1 -1
  105. package/dist/generated/models/LoginRequest.d.ts +6 -0
  106. package/dist/generated/models/LoginRequest.js.map +1 -1
  107. package/dist/generated/models/Money.d.ts +1 -1
  108. package/dist/generated/models/ObjectSerializer.d.ts +5 -0
  109. package/dist/generated/models/ObjectSerializer.js +15 -0
  110. package/dist/generated/models/ObjectSerializer.js.map +1 -1
  111. package/dist/generated/models/PlayerCancelTransferOwnershipRequest.js +1 -1
  112. package/dist/generated/models/PlayerCancelTransferOwnershipRequest.js.map +1 -1
  113. package/dist/generated/models/PlayerInventoryListQueries.d.ts +12 -0
  114. package/dist/generated/models/PlayerInventoryListQueries.js +1 -1
  115. package/dist/generated/models/PlayerInventoryListQueries.js.map +1 -1
  116. package/dist/generated/models/PlayerInventoryQueries.d.ts +31 -0
  117. package/dist/generated/models/PlayerInventoryQueries.js +32 -0
  118. package/dist/generated/models/PlayerInventoryQueries.js.map +1 -0
  119. package/dist/generated/models/PlayerListQueries.d.ts +12 -0
  120. package/dist/generated/models/PlayerListQueries.js.map +1 -1
  121. package/dist/generated/models/PlayerRequest.d.ts +6 -0
  122. package/dist/generated/models/PlayerRequest.js.map +1 -1
  123. package/dist/generated/models/PlayerResponseAccountsInner.d.ts +3 -0
  124. package/dist/generated/models/PlayerResponseAccountsInner.js +1 -1
  125. package/dist/generated/models/PlayerResponseAccountsInner.js.map +1 -1
  126. package/dist/generated/models/PlayerResponseTransactionIntentsInner.d.ts +9 -0
  127. package/dist/generated/models/PlayerResponseTransactionIntentsInner.js +1 -1
  128. package/dist/generated/models/PlayerResponseTransactionIntentsInner.js.map +1 -1
  129. package/dist/generated/models/PlayerTransferOwnershipRequest.js +1 -1
  130. package/dist/generated/models/PlayerTransferOwnershipRequest.js.map +1 -1
  131. package/dist/generated/models/Policy.d.ts +3 -0
  132. package/dist/generated/models/Policy.js +1 -1
  133. package/dist/generated/models/Policy.js.map +1 -1
  134. package/dist/generated/models/PolicyListQueries.d.ts +18 -0
  135. package/dist/generated/models/PolicyListQueries.js +1 -1
  136. package/dist/generated/models/PolicyListQueries.js.map +1 -1
  137. package/dist/generated/models/PolicyResponse.d.ts +3 -0
  138. package/dist/generated/models/PolicyResponse.js +1 -1
  139. package/dist/generated/models/PolicyResponse.js.map +1 -1
  140. package/dist/generated/models/PolicyRuleListQueries.d.ts +12 -0
  141. package/dist/generated/models/PolicyRuleListQueries.js.map +1 -1
  142. package/dist/generated/models/PolicyStrategyRequest.d.ts +6 -0
  143. package/dist/generated/models/PolicyStrategyRequest.js.map +1 -1
  144. package/dist/generated/models/ProviderRequest.d.ts +9 -0
  145. package/dist/generated/models/ProviderRequest.js.map +1 -1
  146. package/dist/generated/models/ResponseResponse.d.ts +27 -0
  147. package/dist/generated/models/ResponseResponse.js +1 -1
  148. package/dist/generated/models/ResponseResponse.js.map +1 -1
  149. package/dist/generated/models/RevokeSessionPlayerRequest.d.ts +12 -0
  150. package/dist/generated/models/RevokeSessionPlayerRequest.js +1 -1
  151. package/dist/generated/models/RevokeSessionPlayerRequest.js.map +1 -1
  152. package/dist/generated/models/RevokeSessionRequest.d.ts +15 -0
  153. package/dist/generated/models/RevokeSessionRequest.js +1 -1
  154. package/dist/generated/models/RevokeSessionRequest.js.map +1 -1
  155. package/dist/generated/models/SessionListQueries.d.ts +12 -1
  156. package/dist/generated/models/SessionListQueries.js +0 -6
  157. package/dist/generated/models/SessionListQueries.js.map +1 -1
  158. package/dist/generated/models/SignatureRequest.d.ts +6 -0
  159. package/dist/generated/models/SignatureRequest.js.map +1 -1
  160. package/dist/generated/models/SignupRequest.d.ts +12 -0
  161. package/dist/generated/models/SignupRequest.js.map +1 -1
  162. package/dist/generated/models/TransactionIntent.d.ts +9 -0
  163. package/dist/generated/models/TransactionIntent.js +1 -1
  164. package/dist/generated/models/TransactionIntent.js.map +1 -1
  165. package/dist/generated/models/TransactionIntentListQueries.d.ts +21 -0
  166. package/dist/generated/models/TransactionIntentListQueries.js +1 -1
  167. package/dist/generated/models/TransactionIntentListQueries.js.map +1 -1
  168. package/dist/generated/models/TransactionIntentResponse.d.ts +11 -2
  169. package/dist/generated/models/TransactionIntentResponse.js +2 -2
  170. package/dist/generated/models/TransactionIntentResponse.js.map +1 -1
  171. package/dist/generated/models/TransactionIntentResponseAccount.d.ts +46 -0
  172. package/dist/generated/models/TransactionIntentResponseAccount.js +95 -0
  173. package/dist/generated/models/TransactionIntentResponseAccount.js.map +1 -0
  174. package/dist/generated/models/TransactionIntentResponsePlayer.d.ts +3 -0
  175. package/dist/generated/models/TransactionIntentResponsePlayer.js +3 -0
  176. package/dist/generated/models/TransactionIntentResponsePlayer.js.map +1 -1
  177. package/dist/generated/models/TransactionIntentResponsePolicy.d.ts +6 -0
  178. package/dist/generated/models/TransactionIntentResponsePolicy.js +4 -1
  179. package/dist/generated/models/TransactionIntentResponsePolicy.js.map +1 -1
  180. package/dist/generated/models/UpdateContractRequest.d.ts +18 -0
  181. package/dist/generated/models/UpdateContractRequest.js +1 -1
  182. package/dist/generated/models/UpdateContractRequest.js.map +1 -1
  183. package/dist/generated/models/UpdatePolicyRequest.d.ts +9 -0
  184. package/dist/generated/models/UpdatePolicyRequest.js +1 -1
  185. package/dist/generated/models/UpdatePolicyRequest.js.map +1 -1
  186. package/dist/generated/models/UpdatePolicyRuleRequest.d.ts +15 -0
  187. package/dist/generated/models/UpdatePolicyRuleRequest.js.map +1 -1
  188. package/dist/generated/models/all.d.ts +5 -0
  189. package/dist/generated/models/all.js +5 -0
  190. package/dist/generated/models/all.js.map +1 -1
  191. package/dist/generated/types/ObjectParamAPI.d.ts +193 -152
  192. package/dist/generated/types/ObjectParamAPI.js +82 -53
  193. package/dist/generated/types/ObjectParamAPI.js.map +1 -1
  194. package/dist/generated/types/ObservableAPI.d.ts +168 -137
  195. package/dist/generated/types/ObservableAPI.js +199 -168
  196. package/dist/generated/types/ObservableAPI.js.map +1 -1
  197. package/dist/generated/types/PromiseAPI.d.ts +168 -137
  198. package/dist/generated/types/PromiseAPI.js +175 -144
  199. package/dist/generated/types/PromiseAPI.js.map +1 -1
  200. package/dist/index.d.ts +2 -0
  201. package/dist/index.js +9 -0
  202. package/dist/index.js.map +1 -1
  203. package/dist/models/index.d.ts +0 -1
  204. package/dist/models/index.js +0 -1
  205. package/dist/models/index.js.map +1 -1
  206. package/dist/models/webHookEvent.d.ts +5 -0
  207. package/dist/models/{updateTransactionIntentRequest.js → webHookEvent.js} +1 -1
  208. package/dist/models/webHookEvent.js.map +1 -0
  209. package/dist/version.d.ts +1 -1
  210. package/dist/version.js +1 -1
  211. package/dist/version.js.map +1 -1
  212. package/package.json +7 -6
  213. package/tsconfig.tsbuildinfo +1 -1
  214. package/dist/models/updateTransactionIntentRequest.d.ts +0 -3
  215. package/dist/models/updateTransactionIntentRequest.js.map +0 -1
@@ -103,7 +103,7 @@ export interface AccountsApiGetAccountRequest {
103
103
  */
104
104
  id: string;
105
105
  /**
106
- * whether to expand the response or not
106
+ *
107
107
  * @type Array<AccountResponseExpandable>
108
108
  * @memberof AccountsApigetAccount
109
109
  */
@@ -111,31 +111,31 @@ export interface AccountsApiGetAccountRequest {
111
111
  }
112
112
  export interface AccountsApiGetAccountsRequest {
113
113
  /**
114
- *
114
+ * Specifies the unique player ID
115
115
  * @type string
116
116
  * @memberof AccountsApigetAccounts
117
117
  */
118
118
  player: string;
119
119
  /**
120
- *
120
+ * Specifies the maximum number of records to return.
121
121
  * @type number
122
122
  * @memberof AccountsApigetAccounts
123
123
  */
124
124
  limit?: number;
125
125
  /**
126
- *
126
+ * Specifies the offset for the first records to return.
127
127
  * @type number
128
128
  * @memberof AccountsApigetAccounts
129
129
  */
130
130
  skip?: number;
131
131
  /**
132
- *
132
+ * Specifies the order in which to sort the results.
133
133
  * @type SortOrder
134
134
  * @memberof AccountsApigetAccounts
135
135
  */
136
136
  order?: SortOrder;
137
137
  /**
138
- *
138
+ * Specifies the fields to expand in the response.
139
139
  * @type Array<AccountResponseExpandable>
140
140
  * @memberof AccountsApigetAccounts
141
141
  */
@@ -195,7 +195,8 @@ export declare class ObjectAccountsApi {
195
195
  private api;
196
196
  constructor(configuration: Configuration, requestFactory?: AccountsApiRequestFactory, responseProcessor?: AccountsApiResponseProcessor);
197
197
  /**
198
- * Request the ownership transfer of an account to a given address.
198
+ * This endpoint allows you to cancel a pending transfer of ownership.
199
+ * Cancel request of ownership transfer of an account.
199
200
  * @param param the request object
200
201
  */
201
202
  cancelTransferOwnership(param: AccountsApiCancelTransferOwnershipRequest, options?: Configuration): Promise<TransactionIntentResponse>;
@@ -205,22 +206,26 @@ export declare class ObjectAccountsApi {
205
206
  */
206
207
  completeRecovery(param: AccountsApiCompleteRecoveryRequest, options?: Configuration): Promise<TransactionIntentResponse>;
207
208
  /**
208
- * Creates an account object.
209
+ * This endpoint allows you to add a new account to your Openfort player. Only one account can be active per chain per player.
210
+ * Create an account object.
209
211
  * @param param the request object
210
212
  */
211
213
  createAccount(param: AccountsApiCreateAccountRequest, options?: Configuration): Promise<AccountResponse>;
212
214
  /**
213
215
  * 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.
216
+ * Get existing account.
214
217
  * @param param the request object
215
218
  */
216
219
  getAccount(param: AccountsApiGetAccountRequest, options?: Configuration): Promise<AccountResponse>;
217
220
  /**
218
- * 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.
221
+ * 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.
222
+ * List accounts of a player.
219
223
  * @param param the request object
220
224
  */
221
225
  getAccounts(param: AccountsApiGetAccountsRequest, options?: Configuration): Promise<AccountListResponse>;
222
226
  /**
223
- * Request the ownership transfer of an account to a given address.
227
+ * 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.
228
+ * Request ownership transfer of an account.
224
229
  * @param param the request object
225
230
  */
226
231
  requestTransferOwnership(param: AccountsApiRequestTransferOwnershipRequest, options?: Configuration): Promise<TransactionIntentResponse>;
@@ -259,7 +264,7 @@ export interface AuthenticationApiSignupRequest {
259
264
  }
260
265
  export interface AuthenticationApiVerifyAuthTokenRequest {
261
266
  /**
262
- *
267
+ * Specifies the auth token.
263
268
  * @type string
264
269
  * @memberof AuthenticationApiverifyAuthToken
265
270
  */
@@ -269,14 +274,17 @@ export declare class ObjectAuthenticationApi {
269
274
  private api;
270
275
  constructor(configuration: Configuration, requestFactory?: AuthenticationApiRequestFactory, responseProcessor?: AuthenticationApiResponseProcessor);
271
276
  /**
277
+ * Login a player.
272
278
  * @param param the request object
273
279
  */
274
280
  login(param: AuthenticationApiLoginRequest, options?: Configuration): Promise<AuthResponse>;
275
281
  /**
282
+ * Sign up a player.
276
283
  * @param param the request object
277
284
  */
278
285
  signup(param: AuthenticationApiSignupRequest, options?: Configuration): Promise<AuthResponse>;
279
286
  /**
287
+ * Verify an auth token.
280
288
  * @param param the request object
281
289
  */
282
290
  verifyAuthToken(param: AuthenticationApiVerifyAuthTokenRequest, options?: Configuration): Promise<PlayerResponse>;
@@ -294,7 +302,7 @@ export declare class ObjectConfigAuthenticationApi {
294
302
  private api;
295
303
  constructor(configuration: Configuration, requestFactory?: ConfigAuthenticationApiRequestFactory, responseProcessor?: ConfigAuthenticationApiResponseProcessor);
296
304
  /**
297
- * Google OAuth. Add a google_client_id and a google_client_secret
305
+ * Configure Google OAuth2.
298
306
  * @param param the request object
299
307
  */
300
308
  editProvider(param: ConfigAuthenticationApiEditProviderRequest, options?: Configuration): Promise<ProjectResponse>;
@@ -310,7 +318,7 @@ export interface ContractsApiCreateContractRequest {
310
318
  }
311
319
  export interface ContractsApiDeleteContractRequest {
312
320
  /**
313
- *
321
+ * Specifies the unique contract ID.
314
322
  * @type string
315
323
  * @memberof ContractsApideleteContract
316
324
  */
@@ -326,43 +334,43 @@ export interface ContractsApiGetContractRequest {
326
334
  }
327
335
  export interface ContractsApiGetContractsRequest {
328
336
  /**
329
- *
337
+ * Specifies the maximum number of records to return.
330
338
  * @type number
331
339
  * @memberof ContractsApigetContracts
332
340
  */
333
341
  limit?: number;
334
342
  /**
335
- *
343
+ * Specifies the offset for the first records to return.
336
344
  * @type number
337
345
  * @memberof ContractsApigetContracts
338
346
  */
339
347
  skip?: number;
340
348
  /**
341
- *
349
+ * Specifies the order in which to sort the results.
342
350
  * @type SortOrder
343
351
  * @memberof ContractsApigetContracts
344
352
  */
345
353
  order?: SortOrder;
346
354
  /**
347
- *
355
+ * Specifies the name of the contract.
348
356
  * @type string
349
357
  * @memberof ContractsApigetContracts
350
358
  */
351
359
  name?: string;
352
360
  /**
353
- *
361
+ * Specifies whether to include deleted contracts.
354
362
  * @type boolean
355
363
  * @memberof ContractsApigetContracts
356
364
  */
357
365
  deleted?: boolean;
358
366
  /**
359
- *
367
+ * The chain ID of the contract.
360
368
  * @type number
361
369
  * @memberof ContractsApigetContracts
362
370
  */
363
371
  chainId?: number;
364
372
  /**
365
- *
373
+ * Specifies the address of the contract.
366
374
  * @type string
367
375
  * @memberof ContractsApigetContracts
368
376
  */
@@ -370,7 +378,7 @@ export interface ContractsApiGetContractsRequest {
370
378
  }
371
379
  export interface ContractsApiUpdateContractRequest {
372
380
  /**
373
- *
381
+ * Specifies the unique contract ID.
374
382
  * @type string
375
383
  * @memberof ContractsApiupdateContract
376
384
  */
@@ -386,22 +394,26 @@ export declare class ObjectContractsApi {
386
394
  private api;
387
395
  constructor(configuration: Configuration, requestFactory?: ContractsApiRequestFactory, responseProcessor?: ContractsApiResponseProcessor);
388
396
  /**
389
- * Creates a contract object.
397
+ * Add a new contract to your project in Openfort
398
+ * Create contract object.
390
399
  * @param param the request object
391
400
  */
392
401
  createContract(param: ContractsApiCreateContractRequest, options?: Configuration): Promise<ContractResponse>;
393
402
  /**
403
+ * Delete a contract from the project by providing its contract id.
394
404
  * Deletes a contract object.
395
405
  * @param param the request object
396
406
  */
397
407
  deleteContract(param: ContractsApiDeleteContractRequest, options?: Configuration): Promise<ContractDeleteResponse>;
398
408
  /**
399
- * Retrieves the details of an existing contract. Supply the unique contract ID from either a contract creation request or the contract list, and Openfort will return the corresponding contract information.
409
+ * Retrieve a contract by providing their contract id.
410
+ * Get a contract.
400
411
  * @param param the request object
401
412
  */
402
413
  getContract(param: ContractsApiGetContractRequest, options?: Configuration): Promise<ContractResponse>;
403
414
  /**
404
- * Returns a list of your contracts. The contracts are returned sorted by creation date, with the most recently created contracts appearing first.
415
+ * List of all contracts per project. By default, a maximum of ten contracts are shown.
416
+ * List contracts.
405
417
  * @param param the request object
406
418
  */
407
419
  getContracts(param?: ContractsApiGetContractsRequest, options?: Configuration): Promise<ContractListResponse>;
@@ -416,7 +428,7 @@ export interface GoogleAuthenticationApiGetSigninUrlRequest {
416
428
  }
417
429
  export interface GoogleAuthenticationApiGetTokenRequest {
418
430
  /**
419
- *
431
+ * Specifies the oauth key.
420
432
  * @type string
421
433
  * @memberof GoogleAuthenticationApigetToken
422
434
  */
@@ -426,10 +438,12 @@ export declare class ObjectGoogleAuthenticationApi {
426
438
  private api;
427
439
  constructor(configuration: Configuration, requestFactory?: GoogleAuthenticationApiRequestFactory, responseProcessor?: GoogleAuthenticationApiResponseProcessor);
428
440
  /**
441
+ * Get the google oauth signin url.
429
442
  * @param param the request object
430
443
  */
431
444
  getSigninUrl(param?: GoogleAuthenticationApiGetSigninUrlRequest, options?: Configuration): Promise<GetSigninUrlResponse>;
432
445
  /**
446
+ * Get the google oauth token.
433
447
  * @param param the request object
434
448
  */
435
449
  getToken(param: GoogleAuthenticationApiGetTokenRequest, options?: Configuration): Promise<AuthResponse>;
@@ -443,19 +457,19 @@ export interface InventoryApiGetAccountCryptoCurrencyInventoryRequest {
443
457
  */
444
458
  id: string;
445
459
  /**
446
- *
460
+ * Specifies the maximum number of records to return.
447
461
  * @type number
448
462
  * @memberof InventoryApigetAccountCryptoCurrencyInventory
449
463
  */
450
464
  limit?: number;
451
465
  /**
452
- *
466
+ * Specifies the offset for the first records to return.
453
467
  * @type number
454
468
  * @memberof InventoryApigetAccountCryptoCurrencyInventory
455
469
  */
456
470
  skip?: number;
457
471
  /**
458
- *
472
+ * Specifies the order in which to sort the results.
459
473
  * @type SortOrder
460
474
  * @memberof InventoryApigetAccountCryptoCurrencyInventory
461
475
  */
@@ -491,19 +505,19 @@ export interface InventoryApiGetAccountNftInventoryRequest {
491
505
  */
492
506
  id: string;
493
507
  /**
494
- *
508
+ * Specifies the maximum number of records to return.
495
509
  * @type number
496
510
  * @memberof InventoryApigetAccountNftInventory
497
511
  */
498
512
  limit?: number;
499
513
  /**
500
- *
514
+ * Specifies the offset for the first records to return.
501
515
  * @type number
502
516
  * @memberof InventoryApigetAccountNftInventory
503
517
  */
504
518
  skip?: number;
505
519
  /**
506
- *
520
+ * Specifies the order in which to sort the results.
507
521
  * @type SortOrder
508
522
  * @memberof InventoryApigetAccountNftInventory
509
523
  */
@@ -523,31 +537,31 @@ export interface InventoryApiGetPlayerCryptoCurrencyInventoryRequest {
523
537
  */
524
538
  id: string;
525
539
  /**
526
- *
540
+ * Filter by chain id.
527
541
  * @type number
528
542
  * @memberof InventoryApigetPlayerCryptoCurrencyInventory
529
543
  */
530
544
  chainId: number;
531
545
  /**
532
- *
546
+ * Specifies the maximum number of records to return.
533
547
  * @type number
534
548
  * @memberof InventoryApigetPlayerCryptoCurrencyInventory
535
549
  */
536
550
  limit?: number;
537
551
  /**
538
- *
552
+ * Specifies the offset for the first records to return.
539
553
  * @type number
540
554
  * @memberof InventoryApigetPlayerCryptoCurrencyInventory
541
555
  */
542
556
  skip?: number;
543
557
  /**
544
- *
558
+ * Specifies the order in which to sort the results.
545
559
  * @type SortOrder
546
560
  * @memberof InventoryApigetPlayerCryptoCurrencyInventory
547
561
  */
548
562
  order?: SortOrder;
549
563
  /**
550
- *
564
+ * Filter by contract ID.
551
565
  * @type Array&lt;string&gt;
552
566
  * @memberof InventoryApigetPlayerCryptoCurrencyInventory
553
567
  */
@@ -561,7 +575,7 @@ export interface InventoryApiGetPlayerInventoryRequest {
561
575
  */
562
576
  id: string;
563
577
  /**
564
- *
578
+ * Filter by chain id.
565
579
  * @type number
566
580
  * @memberof InventoryApigetPlayerInventory
567
581
  */
@@ -575,7 +589,7 @@ export interface InventoryApiGetPlayerNativeInventoryRequest {
575
589
  */
576
590
  id: string;
577
591
  /**
578
- *
592
+ * Filter by chain id.
579
593
  * @type number
580
594
  * @memberof InventoryApigetPlayerNativeInventory
581
595
  */
@@ -589,31 +603,31 @@ export interface InventoryApiGetPlayerNftInventoryRequest {
589
603
  */
590
604
  id: string;
591
605
  /**
592
- *
606
+ * Filter by chain id.
593
607
  * @type number
594
608
  * @memberof InventoryApigetPlayerNftInventory
595
609
  */
596
610
  chainId: number;
597
611
  /**
598
- *
612
+ * Specifies the maximum number of records to return.
599
613
  * @type number
600
614
  * @memberof InventoryApigetPlayerNftInventory
601
615
  */
602
616
  limit?: number;
603
617
  /**
604
- *
618
+ * Specifies the offset for the first records to return.
605
619
  * @type number
606
620
  * @memberof InventoryApigetPlayerNftInventory
607
621
  */
608
622
  skip?: number;
609
623
  /**
610
- *
624
+ * Specifies the order in which to sort the results.
611
625
  * @type SortOrder
612
626
  * @memberof InventoryApigetPlayerNftInventory
613
627
  */
614
628
  order?: SortOrder;
615
629
  /**
616
- *
630
+ * Filter by contract ID.
617
631
  * @type Array&lt;string&gt;
618
632
  * @memberof InventoryApigetPlayerNftInventory
619
633
  */
@@ -623,42 +637,42 @@ export declare class ObjectInventoryApi {
623
637
  private api;
624
638
  constructor(configuration: Configuration, requestFactory?: InventoryApiRequestFactory, responseProcessor?: InventoryApiResponseProcessor);
625
639
  /**
626
- * Retrieves the cryptocurrency assets 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.
640
+ * Retrieves the cryptocurrency assets of an existing account.
627
641
  * @param param the request object
628
642
  */
629
643
  getAccountCryptoCurrencyInventory(param: InventoryApiGetAccountCryptoCurrencyInventoryRequest, options?: Configuration): Promise<InventoryListResponse>;
630
644
  /**
631
- * Retrieves the inventory 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.
645
+ * Get inventory of account.
632
646
  * @param param the request object
633
647
  */
634
648
  getAccountInventory(param: InventoryApiGetAccountInventoryRequest, options?: Configuration): Promise<ObsoleteInventoryResponse>;
635
649
  /**
636
- * Retrieves the native asset 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.
650
+ * Retrieves the native asset of an existing account.
637
651
  * @param param the request object
638
652
  */
639
653
  getAccountNativeInventory(param: InventoryApiGetAccountNativeInventoryRequest, options?: Configuration): Promise<InventoryResponse>;
640
654
  /**
641
- * Retrieves the NFT assets 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.
655
+ * Retrieves the NFT assets of an existing account.
642
656
  * @param param the request object
643
657
  */
644
658
  getAccountNftInventory(param: InventoryApiGetAccountNftInventoryRequest, options?: Configuration): Promise<InventoryListResponse>;
645
659
  /**
646
- * Retrieves the cruptocurrency assets list of an existing player. Supply the unique player ID from either a player creation request or the player list, and Openfort will return the corresponding player information.
660
+ * Get cryptocurrency list of player.
647
661
  * @param param the request object
648
662
  */
649
663
  getPlayerCryptoCurrencyInventory(param: InventoryApiGetPlayerCryptoCurrencyInventoryRequest, options?: Configuration): Promise<InventoryListResponse>;
650
664
  /**
651
- * Retrieves the inventory of an existing player. Supply the unique player ID from either a player creation request or the player list, and Openfort will return the corresponding player information.
665
+ * Get inventory of player.
652
666
  * @param param the request object
653
667
  */
654
668
  getPlayerInventory(param: InventoryApiGetPlayerInventoryRequest, options?: Configuration): Promise<ObsoleteInventoryResponse>;
655
669
  /**
656
- * Retrieves the native assets list of an existing player. Supply the unique player ID from either a player creation request or the player list, and Openfort will return the corresponding player information.
670
+ * Get native token list of player.
657
671
  * @param param the request object
658
672
  */
659
673
  getPlayerNativeInventory(param: InventoryApiGetPlayerNativeInventoryRequest, options?: Configuration): Promise<InventoryResponse>;
660
674
  /**
661
- * Retrieves the NFT assets list of an existing player. Supply the unique player ID from either a player creation request or the player list, and Openfort will return the corresponding player information.
675
+ * Get NFTs list of player.
662
676
  * @param param the request object
663
677
  */
664
678
  getPlayerNftInventory(param: InventoryApiGetPlayerNftInventoryRequest, options?: Configuration): Promise<InventoryListResponse>;
@@ -722,7 +736,7 @@ export interface PlayersApiGetPlayerRequest {
722
736
  */
723
737
  id: string;
724
738
  /**
725
- *
739
+ * Specifies the expandable fields.
726
740
  * @type Array&lt;PlayerResponseExpandable&gt;
727
741
  * @memberof PlayersApigetPlayer
728
742
  */
@@ -730,13 +744,13 @@ export interface PlayersApiGetPlayerRequest {
730
744
  }
731
745
  export interface PlayersApiGetPlayerAccountsRequest {
732
746
  /**
733
- *
747
+ * Specifies the unique player ID.
734
748
  * @type string
735
749
  * @memberof PlayersApigetPlayerAccounts
736
750
  */
737
751
  id: string;
738
752
  /**
739
- *
753
+ * Specifies the expandable fields.
740
754
  * @type Array&lt;AccountResponseExpandable&gt;
741
755
  * @memberof PlayersApigetPlayerAccounts
742
756
  */
@@ -744,36 +758,64 @@ export interface PlayersApiGetPlayerAccountsRequest {
744
758
  }
745
759
  export interface PlayersApiGetPlayersRequest {
746
760
  /**
747
- *
761
+ * Specifies the maximum number of records to return.
748
762
  * @type number
749
763
  * @memberof PlayersApigetPlayers
750
764
  */
751
765
  limit?: number;
752
766
  /**
753
- *
767
+ * Specifies the offset for the first records to return.
754
768
  * @type number
755
769
  * @memberof PlayersApigetPlayers
756
770
  */
757
771
  skip?: number;
758
772
  /**
759
- *
773
+ * Specifies the order in which to sort the results.
760
774
  * @type SortOrder
761
775
  * @memberof PlayersApigetPlayers
762
776
  */
763
777
  order?: SortOrder;
764
778
  /**
765
- *
779
+ * Specifies the fields to expand in the response.
766
780
  * @type Array&lt;PlayerResponseExpandable&gt;
767
781
  * @memberof PlayersApigetPlayers
768
782
  */
769
783
  expand?: Array<PlayerResponseExpandable>;
770
784
  /**
771
- *
785
+ * Filter by player name.
772
786
  * @type string
773
787
  * @memberof PlayersApigetPlayers
774
788
  */
775
789
  name?: string;
776
790
  }
791
+ export interface PlayersApiObsoleteCancelTransferAccountOwnershipRequest {
792
+ /**
793
+ *
794
+ * @type string
795
+ * @memberof PlayersApiobsoleteCancelTransferAccountOwnership
796
+ */
797
+ id: string;
798
+ /**
799
+ *
800
+ * @type PlayerCancelTransferOwnershipRequest
801
+ * @memberof PlayersApiobsoleteCancelTransferAccountOwnership
802
+ */
803
+ playerCancelTransferOwnershipRequest: PlayerCancelTransferOwnershipRequest;
804
+ }
805
+ export interface PlayersApiObsoleteRequestTransferAccountOwnershipRequest {
806
+ /**
807
+ * Specifies the unique player ID.
808
+ * @type string
809
+ * @memberof PlayersApiobsoleteRequestTransferAccountOwnership
810
+ */
811
+ id: string;
812
+ /**
813
+ *
814
+ * @type PlayerTransferOwnershipRequest
815
+ * @memberof PlayersApiobsoleteRequestTransferAccountOwnership
816
+ */
817
+ playerTransferOwnershipRequest: PlayerTransferOwnershipRequest;
818
+ }
777
819
  export interface PlayersApiRequestTransferAccountOwnershipRequest {
778
820
  /**
779
821
  * Specifies the unique player ID.
@@ -820,47 +862,63 @@ export declare class ObjectPlayersApi {
820
862
  private api;
821
863
  constructor(configuration: Configuration, requestFactory?: PlayersApiRequestFactory, responseProcessor?: PlayersApiResponseProcessor);
822
864
  /**
823
- * Request the ownership transfer of an account to a given address.
865
+ * This endpoint allows you to cancel a pending transfer of ownership.
866
+ * Cancel request to transfer ownership of an account.
824
867
  * @param param the request object
825
868
  */
826
869
  cancelTransferAccountOwnership(param: PlayersApiCancelTransferAccountOwnershipRequest, options?: Configuration): Promise<TransactionIntentResponse>;
827
870
  /**
828
- * Creates a player object.
871
+ * Add a new player to your player list in Openfort.
872
+ * Create a player object.
829
873
  * @param param the request object
830
874
  */
831
875
  createPlayer(param: PlayersApiCreatePlayerRequest, options?: Configuration): Promise<PlayerResponse>;
832
876
  /**
833
- * Creates an account object for an existing player.
877
+ * Create account object for a player.
834
878
  * @param param the request object
835
879
  */
836
880
  createPlayerAccount(param: PlayersApiCreatePlayerAccountRequest, options?: Configuration): Promise<AccountResponse>;
837
881
  /**
838
- * Creates a session object for the given player.
882
+ * Create session object for a player.
839
883
  * @param param the request object
840
884
  */
841
885
  createPlayerSession(param: PlayersApiCreatePlayerSessionRequest, options?: Configuration): Promise<SessionResponse>;
842
886
  /**
843
- * Retrieves the details of an existing player. Supply the unique player ID from either a player creation request or the player list, and Openfort will return the corresponding player information.
887
+ * Retrieves the details of an existing player.
844
888
  * @param param the request object
845
889
  */
846
890
  getPlayer(param: PlayersApiGetPlayerRequest, options?: Configuration): Promise<PlayerResponse>;
847
891
  /**
848
- * Returns a list of your accounts for the given player. The accounts are returned sorted by creation date, with the most recently created accounts appearing first.
892
+ * List of accounts of a player.
849
893
  * @param param the request object
850
894
  */
851
895
  getPlayerAccounts(param: PlayersApiGetPlayerAccountsRequest, options?: Configuration): Promise<AccountListResponse>;
852
896
  /**
853
- * Returns a list of your players. The players are returned sorted by creation date, with the most recently created players appearing first.
897
+ * By default, a maximum of ten players are shown.
898
+ * List players.
854
899
  * @param param the request object
855
900
  */
856
901
  getPlayers(param?: PlayersApiGetPlayersRequest, options?: Configuration): Promise<PlayerListResponse>;
857
902
  /**
858
- * Transfer ownership of an account to an address.
903
+ * This endpoint allows you to cancel a pending transfer of ownership.
904
+ * Cancel request to transfer ownership of an account.
905
+ * @param param the request object
906
+ */
907
+ obsoleteCancelTransferAccountOwnership(param: PlayersApiObsoleteCancelTransferAccountOwnershipRequest, options?: Configuration): Promise<TransactionIntentResponse>;
908
+ /**
909
+ * 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.
910
+ * Request transfer ownership of account.
911
+ * @param param the request object
912
+ */
913
+ obsoleteRequestTransferAccountOwnership(param: PlayersApiObsoleteRequestTransferAccountOwnershipRequest, options?: Configuration): Promise<TransactionIntentResponse>;
914
+ /**
915
+ * 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.
916
+ * Request transfer ownership of account.
859
917
  * @param param the request object
860
918
  */
861
919
  requestTransferAccountOwnership(param: PlayersApiRequestTransferAccountOwnershipRequest, options?: Configuration): Promise<TransactionIntentResponse>;
862
920
  /**
863
- * Creates a session object for the given player.
921
+ * Revoke session object for a player.
864
922
  * @param param the request object
865
923
  */
866
924
  revokePlayerSession(param: PlayersApiRevokePlayerSessionRequest, options?: Configuration): Promise<SessionResponse>;
@@ -873,25 +931,25 @@ export declare class ObjectPlayersApi {
873
931
  import { PlayersAuthenticationApiRequestFactory, PlayersAuthenticationApiResponseProcessor } from "../apis/PlayersAuthenticationApi";
874
932
  export interface PlayersAuthenticationApiGetAuthenticatedPlayersRequest {
875
933
  /**
876
- *
934
+ * Specifies the maximum number of records to return.
877
935
  * @type number
878
936
  * @memberof PlayersAuthenticationApigetAuthenticatedPlayers
879
937
  */
880
938
  limit?: number;
881
939
  /**
882
- *
940
+ * Specifies the offset for the first records to return.
883
941
  * @type number
884
942
  * @memberof PlayersAuthenticationApigetAuthenticatedPlayers
885
943
  */
886
944
  skip?: number;
887
945
  /**
888
- *
946
+ * Specifies the order in which to sort the results.
889
947
  * @type SortOrder
890
948
  * @memberof PlayersAuthenticationApigetAuthenticatedPlayers
891
949
  */
892
950
  order?: SortOrder;
893
951
  /**
894
- *
952
+ * Specifies the email address of the user.
895
953
  * @type string
896
954
  * @memberof PlayersAuthenticationApigetAuthenticatedPlayers
897
955
  */
@@ -901,6 +959,7 @@ export declare class ObjectPlayersAuthenticationApi {
901
959
  private api;
902
960
  constructor(configuration: Configuration, requestFactory?: PlayersAuthenticationApiRequestFactory, responseProcessor?: PlayersAuthenticationApiResponseProcessor);
903
961
  /**
962
+ * List authenticated players.
904
963
  * @param param the request object
905
964
  */
906
965
  getAuthenticatedPlayers(param?: PlayersAuthenticationApiGetAuthenticatedPlayersRequest, options?: Configuration): Promise<AuthPlayerListResponse>;
@@ -916,7 +975,7 @@ export interface PoliciesApiCreatePolicyRequest {
916
975
  }
917
976
  export interface PoliciesApiCreatePolicyAllowFunctionRequest {
918
977
  /**
919
- *
978
+ * Specifies the unique policy ID.
920
979
  * @type string
921
980
  * @memberof PoliciesApicreatePolicyAllowFunction
922
981
  */
@@ -930,7 +989,7 @@ export interface PoliciesApiCreatePolicyAllowFunctionRequest {
930
989
  }
931
990
  export interface PoliciesApiDeletePolicyRequest {
932
991
  /**
933
- *
992
+ * Specifies the unique policy ID.
934
993
  * @type string
935
994
  * @memberof PoliciesApideletePolicy
936
995
  */
@@ -938,43 +997,43 @@ export interface PoliciesApiDeletePolicyRequest {
938
997
  }
939
998
  export interface PoliciesApiGetPoliciesRequest {
940
999
  /**
941
- *
1000
+ * Specifies the maximum number of records to return.
942
1001
  * @type number
943
1002
  * @memberof PoliciesApigetPolicies
944
1003
  */
945
1004
  limit?: number;
946
1005
  /**
947
- *
1006
+ * Specifies the offset for the first records to return.
948
1007
  * @type number
949
1008
  * @memberof PoliciesApigetPolicies
950
1009
  */
951
1010
  skip?: number;
952
1011
  /**
953
- *
1012
+ * Specifies the order in which to sort the results.
954
1013
  * @type SortOrder
955
1014
  * @memberof PoliciesApigetPolicies
956
1015
  */
957
1016
  order?: SortOrder;
958
1017
  /**
959
- *
1018
+ * Specifies the fields to expand in the response.
960
1019
  * @type Array&lt;PolicyResponseExpandable&gt;
961
1020
  * @memberof PoliciesApigetPolicies
962
1021
  */
963
1022
  expand?: Array<PolicyResponseExpandable>;
964
1023
  /**
965
- *
1024
+ * Specifies the name of the policy.
966
1025
  * @type string
967
1026
  * @memberof PoliciesApigetPolicies
968
1027
  */
969
1028
  name?: string;
970
1029
  /**
971
- *
1030
+ * Specifies whether to include deleted contracts.
972
1031
  * @type boolean
973
1032
  * @memberof PoliciesApigetPolicies
974
1033
  */
975
1034
  deleted?: boolean;
976
1035
  /**
977
- *
1036
+ * The chain ID of the policy.
978
1037
  * @type number
979
1038
  * @memberof PoliciesApigetPolicies
980
1039
  */
@@ -982,13 +1041,13 @@ export interface PoliciesApiGetPoliciesRequest {
982
1041
  }
983
1042
  export interface PoliciesApiGetPolicyRequest {
984
1043
  /**
985
- *
1044
+ * Specifies the unique policy ID.
986
1045
  * @type string
987
1046
  * @memberof PoliciesApigetPolicy
988
1047
  */
989
1048
  id: string;
990
1049
  /**
991
- *
1050
+ * Specifies the fields to expand.
992
1051
  * @type Array&lt;PolicyResponseExpandable&gt;
993
1052
  * @memberof PoliciesApigetPolicy
994
1053
  */
@@ -996,13 +1055,13 @@ export interface PoliciesApiGetPolicyRequest {
996
1055
  }
997
1056
  export interface PoliciesApiGetPolicyAllowFunctionsRequest {
998
1057
  /**
999
- *
1058
+ * Specifies the unique policy ID.
1000
1059
  * @type string
1001
1060
  * @memberof PoliciesApigetPolicyAllowFunctions
1002
1061
  */
1003
1062
  id: string;
1004
1063
  /**
1005
- *
1064
+ * Specifies the fields to expand.
1006
1065
  * @type Array&lt;&#39;contract&#39;&gt;
1007
1066
  * @memberof PoliciesApigetPolicyAllowFunctions
1008
1067
  */
@@ -1010,7 +1069,7 @@ export interface PoliciesApiGetPolicyAllowFunctionsRequest {
1010
1069
  }
1011
1070
  export interface PoliciesApiGetPolicyTotalGasUsageRequest {
1012
1071
  /**
1013
- *
1072
+ * Specifies the unique policy ID.
1014
1073
  * @type string
1015
1074
  * @memberof PoliciesApigetPolicyTotalGasUsage
1016
1075
  */
@@ -1018,7 +1077,7 @@ export interface PoliciesApiGetPolicyTotalGasUsageRequest {
1018
1077
  }
1019
1078
  export interface PoliciesApiUpdatePolicyRequest {
1020
1079
  /**
1021
- *
1080
+ * Specifies the unique policy ID.
1022
1081
  * @type string
1023
1082
  * @memberof PoliciesApiupdatePolicy
1024
1083
  */
@@ -1054,43 +1113,47 @@ export declare class ObjectPoliciesApi {
1054
1113
  private api;
1055
1114
  constructor(configuration: Configuration, requestFactory?: PoliciesApiRequestFactory, responseProcessor?: PoliciesApiResponseProcessor);
1056
1115
  /**
1057
- * Creates a policy object.
1116
+ * Create a policy object.
1058
1117
  * @param param the request object
1059
1118
  */
1060
1119
  createPolicy(param: PoliciesApiCreatePolicyRequest, options?: Configuration): Promise<PolicyResponse>;
1061
1120
  /**
1121
+ * Create a policy rule object for a policy.
1062
1122
  * @param param the request object
1063
1123
  */
1064
1124
  createPolicyAllowFunction(param: PoliciesApiCreatePolicyAllowFunctionRequest, options?: Configuration): Promise<PolicyRuleResponse>;
1065
1125
  /**
1066
- * Deletes a policy object.
1126
+ * Delete a policy object.
1067
1127
  * @param param the request object
1068
1128
  */
1069
1129
  deletePolicy(param: PoliciesApiDeletePolicyRequest, options?: Configuration): Promise<PolicyDeleteResponse>;
1070
1130
  /**
1071
- * Gets all policy objects for a given project.
1131
+ * List policies.
1072
1132
  * @param param the request object
1073
1133
  */
1074
1134
  getPolicies(param?: PoliciesApiGetPoliciesRequest, options?: Configuration): Promise<PolicyListResponse>;
1075
1135
  /**
1076
- * Gets a policy object for a given project.
1136
+ * Get a policy object.
1077
1137
  * @param param the request object
1078
1138
  */
1079
1139
  getPolicy(param: PoliciesApiGetPolicyRequest, options?: Configuration): Promise<PolicyResponse>;
1080
1140
  /**
1141
+ * List policy rules of a policy.
1081
1142
  * @param param the request object
1082
1143
  */
1083
1144
  getPolicyAllowFunctions(param: PoliciesApiGetPolicyAllowFunctionsRequest, options?: Configuration): Promise<PolicyRuleListResponse>;
1084
1145
  /**
1146
+ * List all gas reports of a policy.
1085
1147
  * @param param the request object
1086
1148
  */
1087
1149
  getPolicyTotalGasUsage(param: PoliciesApiGetPolicyTotalGasUsageRequest, options?: Configuration): Promise<GasReport>;
1088
1150
  /**
1089
- * Updates a policy object.
1151
+ * Update a policy object.
1090
1152
  * @param param the request object
1091
1153
  */
1092
1154
  updatePolicy(param: PoliciesApiUpdatePolicyRequest, options?: Configuration): Promise<PolicyResponse>;
1093
1155
  /**
1156
+ * Update a policy rule object of a policy.
1094
1157
  * @param param the request object
1095
1158
  */
1096
1159
  updatePolicyAllowFunction(param: PoliciesApiUpdatePolicyAllowFunctionRequest, options?: Configuration): Promise<PolicyRuleResponse>;
@@ -1106,7 +1169,7 @@ export interface PolicyRulesApiCreatePolicyRulesRequest {
1106
1169
  }
1107
1170
  export interface PolicyRulesApiDeletePolicyRulesRequest {
1108
1171
  /**
1109
- *
1172
+ * Specifies the unique policy rule ID.
1110
1173
  * @type string
1111
1174
  * @memberof PolicyRulesApideletePolicyRules
1112
1175
  */
@@ -1114,31 +1177,31 @@ export interface PolicyRulesApiDeletePolicyRulesRequest {
1114
1177
  }
1115
1178
  export interface PolicyRulesApiGetPolicyRulesRequest {
1116
1179
  /**
1117
- *
1180
+ * Specifies the unique policy ID.
1118
1181
  * @type string
1119
1182
  * @memberof PolicyRulesApigetPolicyRules
1120
1183
  */
1121
1184
  policy: string;
1122
1185
  /**
1123
- *
1186
+ * Specifies the maximum number of records to return.
1124
1187
  * @type number
1125
1188
  * @memberof PolicyRulesApigetPolicyRules
1126
1189
  */
1127
1190
  limit?: number;
1128
1191
  /**
1129
- *
1192
+ * Specifies the offset for the first records to return.
1130
1193
  * @type number
1131
1194
  * @memberof PolicyRulesApigetPolicyRules
1132
1195
  */
1133
1196
  skip?: number;
1134
1197
  /**
1135
- *
1198
+ * Specifies the order in which to sort the results.
1136
1199
  * @type SortOrder
1137
1200
  * @memberof PolicyRulesApigetPolicyRules
1138
1201
  */
1139
1202
  order?: SortOrder;
1140
1203
  /**
1141
- *
1204
+ * Specifies the fields to expand in the response.
1142
1205
  * @type Array&lt;&#39;contract&#39;&gt;
1143
1206
  * @memberof PolicyRulesApigetPolicyRules
1144
1207
  */
@@ -1146,7 +1209,7 @@ export interface PolicyRulesApiGetPolicyRulesRequest {
1146
1209
  }
1147
1210
  export interface PolicyRulesApiUpdatePolicyRulesRequest {
1148
1211
  /**
1149
- * Specifies the unique allow function ID.
1212
+ * Specifies the unique policy rule ID.
1150
1213
  * @type string
1151
1214
  * @memberof PolicyRulesApiupdatePolicyRules
1152
1215
  */
@@ -1162,22 +1225,22 @@ export declare class ObjectPolicyRulesApi {
1162
1225
  private api;
1163
1226
  constructor(configuration: Configuration, requestFactory?: PolicyRulesApiRequestFactory, responseProcessor?: PolicyRulesApiResponseProcessor);
1164
1227
  /**
1165
- * Creates an allow function object.
1228
+ * Create a policy rule object.
1166
1229
  * @param param the request object
1167
1230
  */
1168
1231
  createPolicyRules(param: PolicyRulesApiCreatePolicyRulesRequest, options?: Configuration): Promise<PolicyRuleResponse>;
1169
1232
  /**
1170
- * Deletes an polciy rule (allow_functions) object.
1233
+ * Deletes a policy rule object.
1171
1234
  * @param param the request object
1172
1235
  */
1173
1236
  deletePolicyRules(param: PolicyRulesApiDeletePolicyRulesRequest, options?: Configuration): Promise<PolicyRuleDeleteResponse>;
1174
1237
  /**
1175
- * Returns a list of your allow functions for the given policy. The allow functions are returned sorted by creation date, with the most recently created allow functions appearing first.
1238
+ * List policy rules of a policy.
1176
1239
  * @param param the request object
1177
1240
  */
1178
1241
  getPolicyRules(param: PolicyRulesApiGetPolicyRulesRequest, options?: Configuration): Promise<PolicyRuleListResponse>;
1179
1242
  /**
1180
- * Updates an allow functions object.
1243
+ * Update a policy rule object.
1181
1244
  * @param param the request object
1182
1245
  */
1183
1246
  updatePolicyRules(param: PolicyRulesApiUpdatePolicyRulesRequest, options?: Configuration): Promise<PolicyRuleResponse>;
@@ -1193,51 +1256,45 @@ export interface SessionsApiCreateSessionRequest {
1193
1256
  }
1194
1257
  export interface SessionsApiGetPlayerSessionsRequest {
1195
1258
  /**
1196
- *
1259
+ * The player ID
1197
1260
  * @type string
1198
1261
  * @memberof SessionsApigetPlayerSessions
1199
1262
  */
1200
1263
  player: string;
1201
1264
  /**
1202
- *
1265
+ * Specifies the maximum number of records to return.
1203
1266
  * @type number
1204
1267
  * @memberof SessionsApigetPlayerSessions
1205
1268
  */
1206
1269
  limit?: number;
1207
1270
  /**
1208
- *
1271
+ * Specifies the offset for the first records to return.
1209
1272
  * @type number
1210
1273
  * @memberof SessionsApigetPlayerSessions
1211
1274
  */
1212
1275
  skip?: number;
1213
1276
  /**
1214
- *
1277
+ * Specifies the order in which to sort the results.
1215
1278
  * @type SortOrder
1216
1279
  * @memberof SessionsApigetPlayerSessions
1217
1280
  */
1218
1281
  order?: SortOrder;
1219
1282
  /**
1220
- *
1283
+ * Specifies the fields to expand in the response.
1221
1284
  * @type Array&lt;SessionResponseExpandable&gt;
1222
1285
  * @memberof SessionsApigetPlayerSessions
1223
1286
  */
1224
1287
  expand?: Array<SessionResponseExpandable>;
1225
- /**
1226
- *
1227
- * @type string
1228
- * @memberof SessionsApigetPlayerSessions
1229
- */
1230
- address?: string;
1231
1288
  }
1232
1289
  export interface SessionsApiGetSessionRequest {
1233
1290
  /**
1234
- *
1291
+ * Specifies the unique session ID.
1235
1292
  * @type string
1236
1293
  * @memberof SessionsApigetSession
1237
1294
  */
1238
1295
  id: string;
1239
1296
  /**
1240
- *
1297
+ * Specifies the fields to expand.
1241
1298
  * @type Array&lt;SessionResponseExpandable&gt;
1242
1299
  * @memberof SessionsApigetSession
1243
1300
  */
@@ -1253,7 +1310,7 @@ export interface SessionsApiRevokeSessionRequest {
1253
1310
  }
1254
1311
  export interface SessionsApiSignatureSessionRequest {
1255
1312
  /**
1256
- *
1313
+ * Specifies the unique session ID.
1257
1314
  * @type string
1258
1315
  * @memberof SessionsApisignatureSession
1259
1316
  */
@@ -1269,12 +1326,12 @@ export declare class ObjectSessionsApi {
1269
1326
  private api;
1270
1327
  constructor(configuration: Configuration, requestFactory?: SessionsApiRequestFactory, responseProcessor?: SessionsApiResponseProcessor);
1271
1328
  /**
1272
- * Creates the session for the account.
1329
+ * Create a session key.
1273
1330
  * @param param the request object
1274
1331
  */
1275
1332
  createSession(param: SessionsApiCreateSessionRequest, options?: Configuration): Promise<SessionResponse>;
1276
1333
  /**
1277
- * Returns a list of your players. The players are returned sorted by creation date, with the most recently created players appearing first.
1334
+ * List session keys of a player.
1278
1335
  * @param param the request object
1279
1336
  */
1280
1337
  getPlayerSessions(param: SessionsApiGetPlayerSessionsRequest, options?: Configuration): Promise<SessionListResponse>;
@@ -1284,7 +1341,7 @@ export declare class ObjectSessionsApi {
1284
1341
  */
1285
1342
  getSession(param: SessionsApiGetSessionRequest, options?: Configuration): Promise<SessionResponse>;
1286
1343
  /**
1287
- * Revokes the session for the account.
1344
+ * Revoke the session session key.
1288
1345
  * @param param the request object
1289
1346
  */
1290
1347
  revokeSession(param: SessionsApiRevokeSessionRequest, options?: Configuration): Promise<SessionResponse>;
@@ -1305,13 +1362,13 @@ export interface TransactionIntentsApiCreateTransactionIntentRequest {
1305
1362
  }
1306
1363
  export interface TransactionIntentsApiGetTransactionIntentRequest {
1307
1364
  /**
1308
- *
1365
+ * Specifies the unique transaction intent ID.
1309
1366
  * @type string
1310
1367
  * @memberof TransactionIntentsApigetTransactionIntent
1311
1368
  */
1312
1369
  id: string;
1313
1370
  /**
1314
- *
1371
+ * Specifies the expandable fields.
1315
1372
  * @type Array&lt;TransactionIntentResponseExpandable&gt;
1316
1373
  * @memberof TransactionIntentsApigetTransactionIntent
1317
1374
  */
@@ -1319,49 +1376,49 @@ export interface TransactionIntentsApiGetTransactionIntentRequest {
1319
1376
  }
1320
1377
  export interface TransactionIntentsApiGetTransactionIntentsRequest {
1321
1378
  /**
1322
- *
1379
+ * Specifies the maximum number of records to return.
1323
1380
  * @type number
1324
1381
  * @memberof TransactionIntentsApigetTransactionIntents
1325
1382
  */
1326
1383
  limit?: number;
1327
1384
  /**
1328
- *
1385
+ * Specifies the offset for the first records to return.
1329
1386
  * @type number
1330
1387
  * @memberof TransactionIntentsApigetTransactionIntents
1331
1388
  */
1332
1389
  skip?: number;
1333
1390
  /**
1334
- *
1391
+ * Specifies the order in which to sort the results.
1335
1392
  * @type SortOrder
1336
1393
  * @memberof TransactionIntentsApigetTransactionIntents
1337
1394
  */
1338
1395
  order?: SortOrder;
1339
1396
  /**
1340
- *
1397
+ * Specifies the fields to expand in the response.
1341
1398
  * @type Array&lt;TransactionIntentResponseExpandable&gt;
1342
1399
  * @memberof TransactionIntentsApigetTransactionIntents
1343
1400
  */
1344
1401
  expand?: Array<TransactionIntentResponseExpandable>;
1345
1402
  /**
1346
- *
1403
+ * The chain ID.
1347
1404
  * @type number
1348
1405
  * @memberof TransactionIntentsApigetTransactionIntents
1349
1406
  */
1350
1407
  chainId?: number;
1351
1408
  /**
1352
- *
1409
+ * Filter by account ID.
1353
1410
  * @type Array&lt;string&gt;
1354
1411
  * @memberof TransactionIntentsApigetTransactionIntents
1355
1412
  */
1356
1413
  accountId?: Array<string>;
1357
1414
  /**
1358
- *
1415
+ * Filter by player ID.
1359
1416
  * @type Array&lt;string&gt;
1360
1417
  * @memberof TransactionIntentsApigetTransactionIntents
1361
1418
  */
1362
1419
  playerId?: Array<string>;
1363
1420
  /**
1364
- *
1421
+ * Filter by policy ID.
1365
1422
  * @type Array&lt;string&gt;
1366
1423
  * @memberof TransactionIntentsApigetTransactionIntents
1367
1424
  */
@@ -1369,7 +1426,7 @@ export interface TransactionIntentsApiGetTransactionIntentsRequest {
1369
1426
  }
1370
1427
  export interface TransactionIntentsApiSignatureRequest {
1371
1428
  /**
1372
- *
1429
+ * Specifies the unique transaction intent ID.
1373
1430
  * @type string
1374
1431
  * @memberof TransactionIntentsApisignature
1375
1432
  */
@@ -1381,45 +1438,29 @@ export interface TransactionIntentsApiSignatureRequest {
1381
1438
  */
1382
1439
  signatureRequest: SignatureRequest;
1383
1440
  }
1384
- export interface TransactionIntentsApiUpdateTransactionIntentResponseRequest {
1385
- /**
1386
- *
1387
- * @type string
1388
- * @memberof TransactionIntentsApiupdateTransactionIntentResponse
1389
- */
1390
- id: string;
1391
- }
1392
- export interface TransactionIntentsApiUpdateTransactionIntentsResponseRequest {
1393
- }
1394
1441
  export declare class ObjectTransactionIntentsApi {
1395
1442
  private api;
1396
1443
  constructor(configuration: Configuration, requestFactory?: TransactionIntentsApiRequestFactory, responseProcessor?: TransactionIntentsApiResponseProcessor);
1397
1444
  /**
1398
- * Creates a transaction intent object.
1445
+ * Retrieve a transaction intent by providing their id on Openfort. Transaction intents that have not been processed yet, have the `response` attribute as undefined.
1446
+ * Create a transaction intent object.
1399
1447
  * @param param the request object
1400
1448
  */
1401
1449
  createTransactionIntent(param: TransactionIntentsApiCreateTransactionIntentRequest, options?: Configuration): Promise<TransactionIntentResponse>;
1402
1450
  /**
1403
- * Retrieves a transaction intent object.
1451
+ * Get a transaction intent object.
1404
1452
  * @param param the request object
1405
1453
  */
1406
1454
  getTransactionIntent(param: TransactionIntentsApiGetTransactionIntentRequest, options?: Configuration): Promise<TransactionIntentResponse>;
1407
1455
  /**
1408
- * Returns a list of transaction intents for the given project. The accounts are returned sorted by creation date, with the most recently created accounts appearing first.
1456
+ * List transaction intents.
1409
1457
  * @param param the request object
1410
1458
  */
1411
1459
  getTransactionIntents(param?: TransactionIntentsApiGetTransactionIntentsRequest, options?: Configuration): Promise<TransactionIntentListResponse>;
1412
1460
  /**
1461
+ * This endpoint is used to put a userOperationHash signature on-chain. This means players that have informed (and use) an [externally-owned account (EOA)](https://ethereum.org/en/developers/docs/accounts/) to authorize operations, such as registering a session key, for their gaming accounts. Given that players with non-custodial accounts are the only ones in possession of the private key, they must sign the information inside the `nextAction` value received from the `POST` API endpoint that creates a transaction_intent, even with their session-keys. Once signed, the client needs to send the signed message using the `/signature` endpoint or use one of the available client-side libraries to do so.
1413
1462
  * Confirms the creation of a transaction intent with an external owner.
1414
1463
  * @param param the request object
1415
1464
  */
1416
1465
  signature(param: TransactionIntentsApiSignatureRequest, options?: Configuration): Promise<TransactionIntentResponse>;
1417
- /**
1418
- * @param param the request object
1419
- */
1420
- updateTransactionIntentResponse(param: TransactionIntentsApiUpdateTransactionIntentResponseRequest, options?: Configuration): Promise<TransactionIntentResponse>;
1421
- /**
1422
- * @param param the request object
1423
- */
1424
- updateTransactionIntentsResponse(param?: TransactionIntentsApiUpdateTransactionIntentsResponseRequest, options?: Configuration): Promise<TransactionIntentListResponse>;
1425
1466
  }