@or-sdk/accounts 2.3.1-beta.4096.0 → 2.3.1-beta.4097.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 (3) hide show
  1. package/dist/types/Accounts.d.ts +120 -0
  2. package/dist/types/Accounts.d.ts.map +1 -1
  3. package/package.json +3 -3
package/dist/types/Accounts.d.ts CHANGED
@@ -2,22 +2,142 @@ import type { Account, AccountData, AccountsConfig, ListSecretsResponse, ListSec
2
2
  export declare class Accounts {
3
3
  private readonly sdkApi;
4
4
  constructor(params: AccountsConfig);
5
+ /**
6
+ * List accounts
7
+ * ```typescript
8
+ * const result = await accounts.listAccounts();
9
+ * ```
10
+ */
5
11
  listAccounts(): Promise<List<Account>>;
12
+ /**
13
+ * Get account by id
14
+ * ```typescript
15
+ * const result = await accounts.getAccount('account-id');
16
+ * ```
17
+ */
6
18
  getAccount(accountId: string): Promise<Account>;
19
+ /**
20
+ * Get account by name
21
+ *
22
+ * For SUPER_ADMIN token role only
23
+ *
24
+ * @returns accountId if found or undefined if not
25
+ *
26
+ * @example
27
+ * ```typescript
28
+ * const result = await accounts.getAccountIdByName('account-name');
29
+ * ```
30
+ */
7
31
  getAccountIdByName(accountName: string, options?: RequestOptions): Promise<string | undefined>;
32
+ /**
33
+ * Get account by name
34
+ *
35
+ * For SUPER_ADMIN token role only
36
+ *
37
+ * @example
38
+ * ```typescript
39
+ * const result = await accounts.getAccountByName('account-name');
40
+ * ```
41
+ */
8
42
  getAccountByName({ accountName, }: GetAccountByNameParams, options?: RequestOptions): Promise<Account | undefined>;
43
+ /**
44
+ * Get account data by id
45
+ * ```typescript
46
+ * const result = await accounts.getAccountData('account-id');
47
+ * ```
48
+ */
9
49
  getAccountData(accountId: string): Promise<AccountData>;
50
+ /**
51
+ * Create account
52
+ * ```typescript
53
+ * const result = await accounts.createAccount(accountData);
54
+ * ```
55
+ */
10
56
  createAccount(data: AccountData): Promise<Account>;
57
+ /**
58
+ * Disable account
59
+ * ```typescript
60
+ * await accounts.disableAccount('account-id');
61
+ * ```
62
+ */
11
63
  disableAccount(accountId: string): Promise<void>;
64
+ /**
65
+ * Enable account
66
+ * ```typescript
67
+ * await accounts.enableAccount('account-id');
68
+ * ```
69
+ */
12
70
  enableAccount(accountId: string): Promise<void>;
71
+ /**
72
+ * Suspend account
73
+ * ```typescript
74
+ * const result = await accounts.suspendAccount('account-id');
75
+ * ```
76
+ */
13
77
  suspendAccount(accountId: string): Promise<Account>;
78
+ /**
79
+ * Resume account
80
+ * ```typescript
81
+ * await accounts.resumeAccount('account-id');
82
+ * ```
83
+ */
14
84
  resumeAccount(accountId: string): Promise<void>;
85
+ /**
86
+ * Update account
87
+ * ```typescript
88
+ * const result = await accounts.updateAccountData('account-id', accountData);
89
+ * ```
90
+ */
15
91
  updateAccountData(accountId: string, data: AccountData): Promise<Account>;
92
+ /**
93
+ * List account secrets
94
+ * ```typescript
95
+ * const result = await accounts.scrollSecrets({limit:10,next:''});
96
+ * ```
97
+ * @deprecated Use `@or-sdk/keys` instead
98
+ */
16
99
  scrollSecrets({ accountId, limit, next, }?: ListSecretsParams): Promise<ListSecretsResponse>;
100
+ /**
101
+ * Get account key
102
+ * ```typescript
103
+ * const result = await accounts.getKey({key});
104
+ * ```
105
+ * @deprecated Use `@or-sdk/keys` instead
106
+ */
17
107
  getKey({ accountId, key }: GetSecretParams): Promise<GetSecretResponse>;
108
+ /**
109
+ * Create account key
110
+ * ```typescript
111
+ * const expireTime = Date.now() + 1000 * 60 * 60 * 24 * 365; // 1 year
112
+ * const result = await accounts.createKey({key, secret, type, expireTime, meta});
113
+ * ```
114
+ * @deprecated Use `@or-sdk/keys` instead
115
+ */
18
116
  createKey({ accountId, key, secret, type, expireTime, meta }: CreateSecretParams): Promise<void>;
117
+ /**
118
+ * Update account key
119
+ * ```typescript
120
+ * const expireTime = Date.now() + 1000 * 60 * 60 * 24 * 365; // 1 year
121
+ * const result = await accounts.updateKey({key, expireTime, meta});
122
+ * ```
123
+ * @deprecated Use `@or-sdk/keys` instead
124
+ */
19
125
  updateKey({ accountId, key, expireTime, meta }: UpdateKeyParams): Promise<void>;
126
+ /**
127
+ * Update account key secret
128
+ * ```typescript
129
+ * const result = await accounts.updateKeySecret({key, secret});
130
+ * ```
131
+ * @deprecated Use `@or-sdk/keys` instead
132
+ */
20
133
  updateKeySecret({ accountId, key, secret }: UpdateKeySecretParams): Promise<void>;
134
+ /**
135
+ * Delete account key
136
+ * ```typescript
137
+ * const result = await accounts.deleteKey({key});
138
+ * ```
139
+ * @deprecated Use `@or-sdk/keys` instead
140
+ */
21
141
  deleteKey({ accountId, key }: DeleteSecretParams): Promise<void>;
22
142
  }
23
143
  //# sourceMappingURL=Accounts.d.ts.map
package/dist/types/Accounts.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Accounts.d.ts","sourceRoot":"","sources":["../../src/Accounts.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,OAAO,EACP,WAAW,EACX,cAAc,EACd,mBAAmB,EACnB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,eAAe,EACf,qBAAqB,EAErB,IAAI,EAEJ,cAAc,EACd,sBAAsB,EACvB,MAAM,SAAS,CAAC;AAEjB,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAEpB,MAAM,EAAE,cAAc;IAgBrB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAetC,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAoB/C,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAgC9F,gBAAgB,CAC3B,EACE,WAAW,GACZ,EAAE,sBAAsB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAclB,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAavD,aAAa,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAclD,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAahD,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAatD,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAanD,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAaxC,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAezE,aAAa,CAAC,EACzB,SAAqB,EACrB,KAAU,EACV,IAAI,GACL,GAAS,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAyB7C,MAAM,CAAC,EAAE,SAAqB,EAAE,GAAG,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAenF,SAAS,CAAC,EAAE,SAAqB,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB5G,SAAS,CAAC,EAAE,SAAqB,EAAE,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAoB3F,eAAe,CAAC,EAAE,SAAqB,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoB7F,SAAS,CAAC,EAAE,SAAqB,EAAE,GAAG,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;CAO1F"}
1
+ {"version":3,"file":"Accounts.d.ts","sourceRoot":"","sources":["../../src/Accounts.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,OAAO,EACP,WAAW,EACX,cAAc,EACd,mBAAmB,EACnB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,eAAe,EACf,qBAAqB,EAErB,IAAI,EAEJ,cAAc,EACd,sBAAsB,EACvB,MAAM,SAAS,CAAC;AAEjB,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAEpB,MAAM,EAAE,cAAc;IAUlC;;;;;OAKG;IACU,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IASnD;;;;;OAKG;IACU,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAQ5D;;;;;;;;;;;OAWG;IACU,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAsB3G;;;;;;;;;OASG;IACU,gBAAgB,CAC3B,EACE,WAAW,GACZ,EAAE,sBAAsB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAQ/B;;;;;OAKG;IACU,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAOpE;;;;;OAKG;IACU,aAAa,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAQ/D;;;;;OAKG;IACU,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO7D;;;;;OAKG;IACU,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO5D;;;;;OAKG;IACG,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAOzD;;;;;OAKG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOrD;;;;;OAKG;IACU,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAQtF;;;;;;OAMG;IACU,aAAa,CAAC,EACzB,SAAqB,EACrB,KAAU,EACV,IAAI,GACL,GAAS,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAkB1D;;;;;;OAMG;IACU,MAAM,CAAC,EAAE,SAAqB,EAAE,GAAG,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAOhG;;;;;;;OAOG;IACU,SAAS,CAAC,EAAE,SAAqB,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAezH;;;;;;;OAOG;IACU,SAAS,CAAC,EAAE,SAAqB,EAAE,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAaxG;;;;;;OAMG;IACU,eAAe,CAAC,EAAE,SAAqB,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAa1G;;;;;;OAMG;IACU,SAAS,CAAC,EAAE,SAAqB,EAAE,GAAG,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;CAO1F"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@or-sdk/accounts",
3
- "version": "2.3.1-beta.4096.0",
3
+ "version": "2.3.1-beta.4097.0",
4
4
  "license": "Apache-2.0",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",
@@ -18,8 +18,8 @@
18
18
  "dev": "pnpm build:watch:esm"
19
19
  },
20
20
  "dependencies": {
21
- "@or-sdk/base": "^0.44.1-beta.4096.0",
22
- "@or-sdk/sdk-api": "^0.28.1-beta.4096.0"
21
+ "@or-sdk/base": "^0.44.1-beta.4097.0",
22
+ "@or-sdk/sdk-api": "^0.28.1-beta.4097.0"
23
23
  },
24
24
  "devDependencies": {
25
25
  "concurrently": "9.0.1",