artifacts-api-client 2.0.0 → 2.1.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 (29) hide show
  1. package/dist/api/artifacts-accounts.api.d.ts +4 -4
  2. package/dist/api/artifacts-accounts.api.js +10 -10
  3. package/dist/api/artifacts-characters.api.d.ts +6 -1
  4. package/dist/api/artifacts-characters.api.js +7 -0
  5. package/dist/api/artifacts-events.api.d.ts +1 -10
  6. package/dist/api/artifacts-events.api.js +0 -14
  7. package/dist/api/artifacts-game-assistant.api.d.ts +11 -0
  8. package/dist/api/artifacts-game-assistant.api.js +20 -0
  9. package/dist/api/artifacts-gems-shop.api.d.ts +16 -0
  10. package/dist/api/artifacts-gems-shop.api.js +44 -0
  11. package/dist/api/artifacts-grand-exchange.api.d.ts +6 -3
  12. package/dist/api/artifacts-grand-exchange.api.js +6 -3
  13. package/dist/api/artifacts-my-account.api.d.ts +28 -5
  14. package/dist/api/artifacts-my-account.api.js +71 -4
  15. package/dist/api/artifacts-my-characters.api.d.ts +36 -12
  16. package/dist/api/artifacts-my-characters.api.js +55 -12
  17. package/dist/api/artifacts-raids.api.d.ts +12 -0
  18. package/dist/api/artifacts-raids.api.js +26 -0
  19. package/dist/api/artifacts-season-rewards.api.d.ts +10 -0
  20. package/dist/api/artifacts-season-rewards.api.js +22 -0
  21. package/dist/api/artifacts-simulation.api.js +1 -1
  22. package/dist/api/artifacts-skins.api.d.ts +10 -0
  23. package/dist/api/artifacts-skins.api.js +20 -0
  24. package/dist/api/artifacts-token.api.d.ts +2 -2
  25. package/dist/api/artifacts.api.d.ts +10 -0
  26. package/dist/api/artifacts.api.js +15 -0
  27. package/dist/api/types/api-schema-bindings.types.d.ts +62 -20
  28. package/dist/api/types/api-schema.types.d.ts +6228 -2577
  29. package/package.json +1 -1
@@ -3,16 +3,16 @@ import { CreateAccountApiBody, CreateAccountApiResult, ForgotPasswordApiBody, Fo
3
3
  export declare class ArtifactsAccountsApi {
4
4
  private readonly httpClient;
5
5
  constructor(httpClient: ArtifactsHttpClient);
6
+ /** Retrieve the achievements of an account. */
7
+ getAchievements(account: string, params?: GetAccountAchievementsApiQuery): Promise<GetAccountAchievementsApiResult>;
8
+ /** Account character lists. */
9
+ getCharacters(account: string): Promise<GetAccountCharactersApiResult>;
6
10
  /** Create an account. */
7
11
  create(body: CreateAccountApiBody): Promise<CreateAccountApiResult>;
8
12
  /** Request a password reset. */
9
13
  forgotPassword(body: ForgotPasswordApiBody): Promise<ForgotPasswordApiResult>;
10
14
  /** Reset password with a token. Use /forgot_password to get a token by email. */
11
15
  resetPassword(body: ResetPasswordApiBody): Promise<ResetPasswordApiResult>;
12
- /** Retrieve the achievements of an account. */
13
- getAchievements(account: string, params?: GetAccountAchievementsApiQuery): Promise<GetAccountAchievementsApiResult>;
14
- /** Account character lists. */
15
- getCharacters(account: string): Promise<GetAccountCharactersApiResult>;
16
16
  /** Retrieve the details of an account. */
17
17
  get(account: string): Promise<GetAccountApiResult>;
18
18
  }
@@ -6,6 +6,16 @@ class ArtifactsAccountsApi {
6
6
  constructor(httpClient) {
7
7
  this.httpClient = httpClient;
8
8
  }
9
+ /** Retrieve the achievements of an account. */
10
+ getAchievements(account, params) {
11
+ return this.httpClient.get(`/accounts/${account}/achievements`, {
12
+ query: params,
13
+ });
14
+ }
15
+ /** Account character lists. */
16
+ getCharacters(account) {
17
+ return this.httpClient.get(`/accounts/${account}/characters`);
18
+ }
9
19
  /** Create an account. */
10
20
  create(body) {
11
21
  return this.httpClient.post(`/accounts/create`, {
@@ -24,16 +34,6 @@ class ArtifactsAccountsApi {
24
34
  body,
25
35
  });
26
36
  }
27
- /** Retrieve the achievements of an account. */
28
- getAchievements(account, params) {
29
- return this.httpClient.get(`/accounts/${account}/achievements`, {
30
- query: params,
31
- });
32
- }
33
- /** Account character lists. */
34
- getCharacters(account) {
35
- return this.httpClient.get(`/accounts/${account}/characters`);
36
- }
37
37
  /** Retrieve the details of an account. */
38
38
  get(account) {
39
39
  return this.httpClient.get(`/accounts/${account}`);
@@ -1,5 +1,5 @@
1
1
  import { ArtifactsHttpClient } from '../http-client/artifacts.http-client';
2
- import { CreateCharacterApiBody, CreateCharacterApiResult, DeleteCharacterApiBody, DeleteCharacterApiResult, GetActiveCharactersApiQuery, GetActiveCharactersApiResult, GetCharacterApiResult } from './types/api-schema-bindings.types';
2
+ import { CreateCharacterApiBody, CreateCharacterApiResult, DeleteCharacterApiBody, DeleteCharacterApiResult, GetActiveCharactersApiQuery, GetActiveCharactersApiResult, GetCharacterApiResult, GetCharacterStatsApiResult } from './types/api-schema-bindings.types';
3
3
  export declare class ArtifactsCharactersApi {
4
4
  private readonly httpClient;
5
5
  constructor(httpClient: ArtifactsHttpClient);
@@ -7,6 +7,11 @@ export declare class ArtifactsCharactersApi {
7
7
  create(body: CreateCharacterApiBody): Promise<CreateCharacterApiResult>;
8
8
  /** Delete character on your account. */
9
9
  delete(body: DeleteCharacterApiBody): Promise<DeleteCharacterApiResult>;
10
+ /** Retrieve gameplay statistics for a character.
11
+
12
+ Stats are only visible if the character's account has an active subscription.
13
+ Statistics are still collected for all accounts regardless of subscription status. */
14
+ getStats(name: string): Promise<GetCharacterStatsApiResult>;
10
15
  /** Fetch active characters details. */
11
16
  getActive(params?: GetActiveCharactersApiQuery): Promise<GetActiveCharactersApiResult>;
12
17
  /** Retrieve the details of a character. */
@@ -20,6 +20,13 @@ class ArtifactsCharactersApi {
20
20
  isSecure: true,
21
21
  });
22
22
  }
23
+ /** Retrieve gameplay statistics for a character.
24
+
25
+ Stats are only visible if the character's account has an active subscription.
26
+ Statistics are still collected for all accounts regardless of subscription status. */
27
+ getStats(name) {
28
+ return this.httpClient.get(`/characters/${name}/stats`);
29
+ }
23
30
  /** Fetch active characters details. */
24
31
  getActive(params = {}) {
25
32
  return this.httpClient.get(`/characters/active`, {
@@ -1,5 +1,5 @@
1
1
  import { ArtifactsHttpClient } from '../http-client/artifacts.http-client';
2
- import { GetAllActiveEventsApiQuery, GetAllActiveEventsApiResult, GetAllEventsApiQuery, GetAllEventsApiResult, SpawnEventApiBody, SpawnEventApiResult } from './types/api-schema-bindings.types';
2
+ import { GetAllActiveEventsApiQuery, GetAllActiveEventsApiResult, GetAllEventsApiQuery, GetAllEventsApiResult } from './types/api-schema-bindings.types';
3
3
  export declare class ArtifactsEventsApi {
4
4
  private readonly httpClient;
5
5
  constructor(httpClient: ArtifactsHttpClient);
@@ -7,13 +7,4 @@ export declare class ArtifactsEventsApi {
7
7
  getAllActive(params?: GetAllActiveEventsApiQuery): Promise<GetAllActiveEventsApiResult>;
8
8
  /** Fetch events details. */
9
9
  getAll(params?: GetAllEventsApiQuery): Promise<GetAllEventsApiResult>;
10
- /**
11
- * Spawn a specific event by code consuming 1 event token.
12
- *
13
- * Rules:
14
- * - Maximum active events defined by utils.config.max_active_events().
15
- * - Event must not already be active.
16
- * - Member or founder account required.
17
- */
18
- spawn(body: SpawnEventApiBody): Promise<SpawnEventApiResult>;
19
10
  }
@@ -18,19 +18,5 @@ class ArtifactsEventsApi {
18
18
  query: params,
19
19
  });
20
20
  }
21
- /**
22
- * Spawn a specific event by code consuming 1 event token.
23
- *
24
- * Rules:
25
- * - Maximum active events defined by utils.config.max_active_events().
26
- * - Event must not already be active.
27
- * - Member or founder account required.
28
- */
29
- spawn(body) {
30
- return this.httpClient.post(`/events/spawn`, {
31
- body,
32
- isSecure: true,
33
- });
34
- }
35
21
  }
36
22
  exports.ArtifactsEventsApi = ArtifactsEventsApi;
@@ -0,0 +1,11 @@
1
+ import { ArtifactsHttpClient } from "../http-client/artifacts.http-client";
2
+ import { AskGameAssistantApiBody, AskGameAssistantApiResult } from "./types/api-schema-bindings.types";
3
+ export declare class ArtifactsGameAssistantApi {
4
+ private readonly httpClient;
5
+ constructor(httpClient: ArtifactsHttpClient);
6
+ /** Ask the game assistant a question about game mechanics or public API usage.
7
+ * An active membership is required.
8
+ * Members receive a limited number of free questions per day.
9
+ * When no free question is available, the request can spend 1 gem with pay_with_gems=true. */
10
+ ask(body: AskGameAssistantApiBody): Promise<AskGameAssistantApiResult>;
11
+ }
@@ -0,0 +1,20 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ArtifactsGameAssistantApi = void 0;
4
+ class ArtifactsGameAssistantApi {
5
+ httpClient;
6
+ constructor(httpClient) {
7
+ this.httpClient = httpClient;
8
+ }
9
+ /** Ask the game assistant a question about game mechanics or public API usage.
10
+ * An active membership is required.
11
+ * Members receive a limited number of free questions per day.
12
+ * When no free question is available, the request can spend 1 gem with pay_with_gems=true. */
13
+ ask(body) {
14
+ return this.httpClient.post(`/game_assistant/ask`, {
15
+ body,
16
+ isSecure: true,
17
+ });
18
+ }
19
+ }
20
+ exports.ArtifactsGameAssistantApi = ArtifactsGameAssistantApi;
@@ -0,0 +1,16 @@
1
+ import { ArtifactsHttpClient } from "../http-client/artifacts.http-client";
2
+ import { BuyCustomDesignApiResult, BuySkinApiResult, BuySpawnEventApiResult, BuySubscriptionApiResult, GetCatalogApiResult } from "./types/api-schema-bindings.types";
3
+ export declare class ArtifactsGemsShopApi {
4
+ private readonly httpClient;
5
+ constructor(httpClient: ArtifactsHttpClient);
6
+ /** Return the gems shop catalog. */
7
+ get(): Promise<GetCatalogApiResult>;
8
+ /** Buy a skin from the gems shop using gems. */
9
+ buySkin(code: string): Promise<BuySkinApiResult>;
10
+ /** Spawn an event from the gems shop using gems. */
11
+ buySpawnEvent(code: string): Promise<BuySpawnEventApiResult>;
12
+ /** Buy or extend membership by 30 days using gems. Unavailable while a Stripe subscription is active. */
13
+ buySubscription(): Promise<BuySubscriptionApiResult>;
14
+ /** Buy a custom design using gems. */
15
+ buyCustomDesign(code: string): Promise<BuyCustomDesignApiResult>;
16
+ }
@@ -0,0 +1,44 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ArtifactsGemsShopApi = void 0;
4
+ class ArtifactsGemsShopApi {
5
+ httpClient;
6
+ constructor(httpClient) {
7
+ this.httpClient = httpClient;
8
+ }
9
+ /** Return the gems shop catalog. */
10
+ get() {
11
+ return this.httpClient.get(`/gems_shop/`);
12
+ }
13
+ /** Buy a skin from the gems shop using gems. */
14
+ buySkin(code) {
15
+ const body = { code };
16
+ return this.httpClient.post(`/gems_shop/skin`, {
17
+ body,
18
+ isSecure: true,
19
+ });
20
+ }
21
+ /** Spawn an event from the gems shop using gems. */
22
+ buySpawnEvent(code) {
23
+ const body = { code };
24
+ return this.httpClient.post(`/gems_shop/spawn_event`, {
25
+ body,
26
+ isSecure: true,
27
+ });
28
+ }
29
+ /** Buy or extend membership by 30 days using gems. Unavailable while a Stripe subscription is active. */
30
+ buySubscription() {
31
+ return this.httpClient.post(`/gems_shop/subscription`, {
32
+ isSecure: true,
33
+ });
34
+ }
35
+ /** Buy a custom design using gems. */
36
+ buyCustomDesign(code) {
37
+ const body = { code };
38
+ return this.httpClient.post(`/gems_shop/buy_custom_design`, {
39
+ body,
40
+ isSecure: true,
41
+ });
42
+ }
43
+ }
44
+ exports.ArtifactsGemsShopApi = ArtifactsGemsShopApi;
@@ -3,10 +3,13 @@ import { GetGrandExchangeSellHistoryApiQuery, GetGrandExchangeSellHistoryApiResu
3
3
  export declare class ArtifactsGrandExchangeApi {
4
4
  private readonly httpClient;
5
5
  constructor(httpClient: ArtifactsHttpClient);
6
- /** Fetch the sales history of the item for the last 7 days. */
6
+ /** Fetch the sales history of the item for the last 7 days (buy and sell orders). */
7
7
  getHistory(code: string, params?: GetGrandExchangeSellHistoryApiQuery): Promise<GetGrandExchangeSellHistoryApiResult>;
8
- /** Fetch all sell orders. */
8
+ /** Fetch all sell orders (sell and buy orders).
9
+
10
+ Use the type parameter to filter by order type;
11
+ when using account, type is required to keep account searches explicit.*/
9
12
  getAll(params?: GetGrandExchangeSellOrdersApiQuery): Promise<GetGrandExchangeSellOrdersApiResult>;
10
- /** Retrieve the sell order of a item. */
13
+ /** Retrieve a specific order by ID. */
11
14
  get(id: string): Promise<GetGrandExchangeSellOrderApiResult>;
12
15
  }
@@ -6,19 +6,22 @@ class ArtifactsGrandExchangeApi {
6
6
  constructor(httpClient) {
7
7
  this.httpClient = httpClient;
8
8
  }
9
- /** Fetch the sales history of the item for the last 7 days. */
9
+ /** Fetch the sales history of the item for the last 7 days (buy and sell orders). */
10
10
  getHistory(code, params = {}) {
11
11
  return this.httpClient.get(`/grandexchange/history/${code}`, {
12
12
  query: params,
13
13
  });
14
14
  }
15
- /** Fetch all sell orders. */
15
+ /** Fetch all sell orders (sell and buy orders).
16
+
17
+ Use the type parameter to filter by order type;
18
+ when using account, type is required to keep account searches explicit.*/
16
19
  getAll(params = {}) {
17
20
  return this.httpClient.get('/grandexchange/orders', {
18
21
  query: params,
19
22
  });
20
23
  }
21
- /** Retrieve the sell order of a item. */
24
+ /** Retrieve a specific order by ID. */
22
25
  get(id) {
23
26
  return this.httpClient.get(`/grandexchange/orders/${id}`);
24
27
  }
@@ -1,5 +1,5 @@
1
1
  import { ArtifactsHttpClient } from '../http-client/artifacts.http-client';
2
- import { ChangePasswordApiBody, ChangePasswordApiResult, GetAccountDetailsApiResult, GetBankApiResult, GetBankItemsApiQuery, GetBankItemsApiResult, GetMyGrandExchangeSellHistoryApiRequest, GetMyGrandExchangeSellHistoryApiResult, GetMyGrandExchangeSellOrdersApiRequest, GetMyGrandExchangeSellOrdersApiResult } from './types/api-schema-bindings.types';
2
+ import { BuyGemsApiBody, BuyGemsApiResult, CancelSubscriptionApiResult, ChangeEmailApiBody, ChangeEmailApiResult, ChangePasswordApiBody, ChangePasswordApiResult, GetAccountDetailsApiResult, GetBankApiResult, GetBankItemsApiQuery, GetBankItemsApiResult, GetMyGemsHistoryApiResult, GetMyGrandExchangeHistoryApiRequest, GetMyGrandExchangeHistoryApiResult, GetMyGrandExchangeOrdersApiRequest, GetMyGrandExchangeOrdersApiResult, GetMyPurchaseHistoryApiResult, GetMySubscriptionApiResult, GetPendingItemsApiRequest, GetPendingItemsApiResult, GetRateLimitsApiResult, SubscribeWithMemberTokenApiResult, SubscribeWithStripeApiBody, SubscribeWithStripeApiResult } from './types/api-schema-bindings.types';
3
3
  export declare class ArtifactsMyAccountApi {
4
4
  private readonly httpClient;
5
5
  constructor(httpClient: ArtifactsHttpClient);
@@ -7,12 +7,35 @@ export declare class ArtifactsMyAccountApi {
7
7
  getBank(): Promise<GetBankApiResult>;
8
8
  /** Fetch all items in your bank. */
9
9
  getBankItems(params?: GetBankItemsApiQuery): Promise<GetBankItemsApiResult>;
10
- /** Fetch your sell orders details. */
11
- getGrandExchangeSellOrders(params?: GetMyGrandExchangeSellOrdersApiRequest): Promise<GetMyGrandExchangeSellOrdersApiResult>;
12
- /** Fetch your sales history of the last 7 days. */
13
- getGrandExchangeSellHistory(params?: GetMyGrandExchangeSellHistoryApiRequest): Promise<GetMyGrandExchangeSellHistoryApiResult>;
10
+ /** Fetch your orders details (sell and buy orders). */
11
+ getGrandExchangeOrders(params?: GetMyGrandExchangeOrdersApiRequest): Promise<GetMyGrandExchangeOrdersApiResult>;
12
+ /** Fetch your transaction history of the last 7 days (buy and sell orders). */
13
+ getGrandExchangeHistory(params?: GetMyGrandExchangeHistoryApiRequest): Promise<GetMyGrandExchangeHistoryApiResult>;
14
14
  /** Fetch account details. */
15
15
  get(): Promise<GetAccountDetailsApiResult>;
16
+ /** Retrieve all unclaimed pending items for your account. */
17
+ getPendingItems(params?: GetPendingItemsApiRequest): Promise<GetPendingItemsApiResult>;
18
+ /** Get all rate limits. */
19
+ getRateLimits(): Promise<GetRateLimitsApiResult>;
16
20
  /** Change your account password. Changing the password reset the account token. */
17
21
  changePassword(body: ChangePasswordApiBody): Promise<ChangePasswordApiResult>;
22
+ /** Change your account email. */
23
+ changeEmail(body: ChangeEmailApiBody): Promise<ChangeEmailApiResult>;
24
+ /** Get current subscription details. */
25
+ getSubscription(): Promise<GetMySubscriptionApiResult>;
26
+ /** Subscribe to become a member and unlock the benefits tied to your selected plan.
27
+ * You will receive a secure Stripe checkout URL to complete the payment. */
28
+ subscribeWithStripe(body: SubscribeWithStripeApiBody): Promise<SubscribeWithStripeApiResult>;
29
+ /** Redeem a member token to start or extend membership by 30 days.
30
+ * Member tokens are manually granted as rewards for events.
31
+ * Member tokens cannot be redeemed while a Stripe subscription is active. */
32
+ subscribeWithMemberToken(): Promise<SubscribeWithMemberTokenApiResult>;
33
+ /** Cancel subscription at the end of the current billing period. */
34
+ cancelSubscription(): Promise<CancelSubscriptionApiResult>;
35
+ /** List all purchases (subscriptions and gem packs). */
36
+ getPurchaseHistory(): Promise<GetMyPurchaseHistoryApiResult>;
37
+ /** List all gem credits and debits. */
38
+ getGemsHistory(): Promise<GetMyGemsHistoryApiResult>;
39
+ /** Purchase gems. Returns a Stripe checkout URL for payment. */
40
+ buyGems(body: BuyGemsApiBody): Promise<BuyGemsApiResult>;
18
41
  }
@@ -19,15 +19,15 @@ class ArtifactsMyAccountApi {
19
19
  isSecure: true,
20
20
  });
21
21
  }
22
- /** Fetch your sell orders details. */
23
- getGrandExchangeSellOrders(params = {}) {
22
+ /** Fetch your orders details (sell and buy orders). */
23
+ getGrandExchangeOrders(params = {}) {
24
24
  return this.httpClient.get(`/my/grandexchange/orders`, {
25
25
  query: params,
26
26
  isSecure: true,
27
27
  });
28
28
  }
29
- /** Fetch your sales history of the last 7 days. */
30
- getGrandExchangeSellHistory(params = {}) {
29
+ /** Fetch your transaction history of the last 7 days (buy and sell orders). */
30
+ getGrandExchangeHistory(params = {}) {
31
31
  return this.httpClient.get(`/my/grandexchange/history`, {
32
32
  query: params,
33
33
  isSecure: true,
@@ -37,6 +37,19 @@ class ArtifactsMyAccountApi {
37
37
  get() {
38
38
  return this.httpClient.get(`/my/details`, { isSecure: true });
39
39
  }
40
+ /** Retrieve all unclaimed pending items for your account. */
41
+ getPendingItems(params = {}) {
42
+ return this.httpClient.get(`/my/pending_items`, {
43
+ query: params,
44
+ isSecure: true,
45
+ });
46
+ }
47
+ /** Get all rate limits. */
48
+ getRateLimits() {
49
+ return this.httpClient.get(`/my/rates`, {
50
+ isSecure: true,
51
+ });
52
+ }
40
53
  /** Change your account password. Changing the password reset the account token. */
41
54
  changePassword(body) {
42
55
  return this.httpClient.post(`/my/change_password`, {
@@ -44,5 +57,59 @@ class ArtifactsMyAccountApi {
44
57
  isSecure: true,
45
58
  });
46
59
  }
60
+ /** Change your account email. */
61
+ changeEmail(body) {
62
+ return this.httpClient.post(`/my/change_email`, {
63
+ body,
64
+ isSecure: true,
65
+ });
66
+ }
67
+ /** Get current subscription details. */
68
+ getSubscription() {
69
+ return this.httpClient.get(`/my/subscription`, {
70
+ isSecure: true,
71
+ });
72
+ }
73
+ /** Subscribe to become a member and unlock the benefits tied to your selected plan.
74
+ * You will receive a secure Stripe checkout URL to complete the payment. */
75
+ subscribeWithStripe(body) {
76
+ return this.httpClient.post(`/my/subscribe/stripe`, {
77
+ body,
78
+ isSecure: true,
79
+ });
80
+ }
81
+ /** Redeem a member token to start or extend membership by 30 days.
82
+ * Member tokens are manually granted as rewards for events.
83
+ * Member tokens cannot be redeemed while a Stripe subscription is active. */
84
+ subscribeWithMemberToken() {
85
+ return this.httpClient.post(`/my/subscribe/member_token`, {
86
+ isSecure: true,
87
+ });
88
+ }
89
+ /** Cancel subscription at the end of the current billing period. */
90
+ cancelSubscription() {
91
+ return this.httpClient.post(`/my/subscribe/cancel`, {
92
+ isSecure: true,
93
+ });
94
+ }
95
+ /** List all purchases (subscriptions and gem packs). */
96
+ getPurchaseHistory() {
97
+ return this.httpClient.get(`/my/purchase_history`, {
98
+ isSecure: true,
99
+ });
100
+ }
101
+ /** List all gem credits and debits. */
102
+ getGemsHistory() {
103
+ return this.httpClient.get(`/my/gems_history`, {
104
+ isSecure: true,
105
+ });
106
+ }
107
+ /** Purchase gems. Returns a Stripe checkout URL for payment. */
108
+ buyGems(body) {
109
+ return this.httpClient.post(`/my/buy_gems`, {
110
+ body,
111
+ isSecure: true,
112
+ });
113
+ }
47
114
  }
48
115
  exports.ArtifactsMyAccountApi = ArtifactsMyAccountApi;
@@ -1,18 +1,21 @@
1
1
  import { ArtifactsHttpClient } from '../http-client/artifacts.http-client';
2
- import { CraftingApiBody, CraftingApiResult, DepositBankItemApiBody, DepositBankGoldApiBody, DepositBankGoldApiResult, DepositBankItemApiResult, EquipItemApiBody, EquipItemApiResult, FightApiResult, GatheringApiResult, MoveApiBody, MoveApiResult, UnequipItemApiBody, UnequipItemApiResult, WithdrawBankItemApiBody, WithdrawBankItemApiResult, WithdrawBankGoldApiBody, WithdrawBankGoldApiResult, RecyclingApiBody, RecyclingApiResult, BuyGrandExchangeItemApiBody, BuyGrandExchangeItemApiResult, CreateGrandExchangeSellOrderApiBody, CreateGrandExchangeSellOrderApiResult, DeleteItemApiBody, DeleteItemApiResult, AcceptTaskApiResult, CompleteTaskApiResult, ExchangeTaskApiResult, GetAllLogsApiResult, GetAllLogsApiQuery, GetMyCharactersApiResult, CancelTaskApiResult, BuyExpansionApiResult, TransitionApiResult, RestApiResult, UseItemApiBody, UseItemApiResult, FightApiBody, NpcBuyItemApiBody, NpcBuyItemApiResult, NpcSellItemApiBody, NpcSellItemApiResult, CancelGrandExchangeSellOrderApiBody, CancelGrandExchangeSellOrderApiResult, TradeTaskItemApiBody, TradeTaskItemApiResult, GiveGoldApiBody, GiveGoldApiResult, GiveItemsApiBody, GiveItemsApiResult, ChangeSkinApiBody, ChangeSkinApiResult, GetLogsApiQuery, GetLogsApiResult } from './types/api-schema-bindings.types';
2
+ import { CraftingApiBody, CraftingApiResult, DepositBankItemApiBody, DepositBankGoldApiBody, DepositBankGoldApiResult, DepositBankItemApiResult, EquipItemsApiBody, EquipItemsApiResult, FightApiResult, GatheringApiResult, MoveApiBody, MoveApiResult, UnequipItemsApiBody, UnequipItemsApiResult, WithdrawBankItemApiBody, WithdrawBankItemApiResult, WithdrawBankGoldApiBody, WithdrawBankGoldApiResult, RecyclingApiBody, RecyclingApiResult, BuyGrandExchangeItemApiBody, BuyGrandExchangeItemApiResult, CreateGrandExchangeSellOrderApiBody, CreateGrandExchangeSellOrderApiResult, DeleteItemApiBody, DeleteItemApiResult, AcceptTaskApiResult, CompleteTaskApiResult, ExchangeTaskApiResult, GetAllLogsApiResult, GetAllLogsApiQuery, GetMyCharactersApiResult, CancelTaskApiResult, BuyExpansionApiResult, TransitionApiResult, RestApiResult, UseItemApiBody, UseItemApiResult, FightApiBody, NpcBuyItemApiBody, NpcBuyItemApiResult, NpcSellItemApiBody, NpcSellItemApiResult, CancelGrandExchangeOrderApiBody, CancelGrandExchangeOrderApiResult, TradeTaskItemApiBody, TradeTaskItemApiResult, GiveGoldApiBody, GiveGoldApiResult, GiveItemsApiBody, GiveItemsApiResult, ChangeSkinApiBody, ChangeSkinApiResult, GetLogsApiQuery, GetLogsApiResult, CreateGrandExchangeBuyOrderApiBody, CreateGrandExchangeBuyOrderApiResult, FillGrandExchangeApiBody, FillGrandExchangeApiResult, ClaimPendingItemApiResult, RenameApiBody, RenameApiResult } from './types/api-schema-bindings.types';
3
3
  export declare class ArtifactsMyCharactersApi {
4
4
  private readonly httpClient;
5
5
  constructor(httpClient: ArtifactsHttpClient);
6
6
  /** Moves a character on the map using the map's X and Y position. */
7
7
  move(name: string, body: MoveApiBody): Promise<MoveApiResult>;
8
- /** Execute a transition from the current map to another layer. The character must be on a map that has a transition available. */
8
+ /** Execute a transition from the current map to another layer.
9
+ * The character must be on a map that has a transition available. */
9
10
  transition(name: string): Promise<TransitionApiResult>;
10
11
  /** Recovers hit points by resting. (1 second per 5 HP, minimum 3 seconds) */
11
12
  rest(name: string): Promise<RestApiResult>;
12
- /** Equip an item on your character. */
13
- equipItem(name: string, body: EquipItemApiBody): Promise<EquipItemApiResult>;
14
- /** Unequip an item on your character. */
15
- unequipItem(name: string, body: UnequipItemApiBody): Promise<UnequipItemApiResult>;
13
+ /** Equip multiple items on your character.
14
+ * The cooldown will be 3 seconds multiplied by the number of different items equipped. */
15
+ equipItems(name: string, body: EquipItemsApiBody): Promise<EquipItemsApiResult>;
16
+ /** Unequip multiple items on your character.
17
+ * The cooldown will be 3 seconds multiplied by the number of different items unequipped. */
18
+ unequipItems(name: string, body: UnequipItemsApiBody): Promise<UnequipItemsApiResult>;
16
19
  /** Use an item as a consumable. */
17
20
  useItem(name: string, body: UseItemApiBody): Promise<UseItemApiResult>;
18
21
  /** Start a fight against a monster on the character's map. */
@@ -23,9 +26,11 @@ export declare class ArtifactsMyCharactersApi {
23
26
  crafting(name: string, body: CraftingApiBody): Promise<CraftingApiResult>;
24
27
  /** Deposit golds in a bank on the character's map. */
25
28
  depositBankGold(name: string, body: DepositBankGoldApiBody): Promise<DepositBankGoldApiResult>;
26
- /** Deposit multiple items in a bank on the character's map. The cooldown will be 3 seconds multiplied by the number of different items deposited. */
29
+ /** Deposit multiple items in a bank on the character's map.
30
+ * The cooldown will be 3 seconds multiplied by the number of different items deposited. */
27
31
  depositBankItem(name: string, body: DepositBankItemApiBody): Promise<DepositBankItemApiResult>;
28
- /** Take items from your bank and put them in the character's inventory. The cooldown will be 3 seconds multiplied by the number of different items withdrawn. */
32
+ /** Take items from your bank and put them in the character's inventory.
33
+ * The cooldown will be 3 seconds multiplied by the number of different items withdrawn. */
29
34
  withdrawBankItem(name: string, body: WithdrawBankItemApiBody): Promise<WithdrawBankItemApiResult>;
30
35
  /** Withdraw gold from your bank. */
31
36
  withdrawBankGold(name: string, body: WithdrawBankGoldApiBody): Promise<WithdrawBankGoldApiResult>;
@@ -39,10 +44,24 @@ export declare class ArtifactsMyCharactersApi {
39
44
  recycling(name: string, body: RecyclingApiBody): Promise<RecyclingApiResult>;
40
45
  /** Buy an item at the Grand Exchange on the character's map. */
41
46
  buyGrandExchangeItem(name: string, body: BuyGrandExchangeItemApiBody): Promise<BuyGrandExchangeItemApiResult>;
42
- /** Create a sell order at the Grand Exchange on the character's map. Please note there is a 3% listing tax, charged at the time of posting, on the total price. */
47
+ /** Create a sell order at the Grand Exchange on the character's map. */
43
48
  createGrandExchangeSellOrder(name: string, body: CreateGrandExchangeSellOrderApiBody): Promise<CreateGrandExchangeSellOrderApiResult>;
44
- /** Cancel a sell order at the Grand Exchange on the character's map. */
45
- cancelGrandExchangeSellOrder(name: string, body: CancelGrandExchangeSellOrderApiBody): Promise<CancelGrandExchangeSellOrderApiResult>;
49
+ /** Cancel an order (sell or buy) at the Grand Exchange on the character's map.
50
+
51
+ For sell orders: Items are returned to your inventory.
52
+ For buy orders: Gold is refunded to your character. */
53
+ cancelGrandExchangeOrder(name: string, body: CancelGrandExchangeOrderApiBody): Promise<CancelGrandExchangeOrderApiResult>;
54
+ /** Create a buy order at the Grand Exchange on the character's map.
55
+
56
+ The total gold (price * quantity) is locked when creating the order.
57
+ Other players can then sell items to fulfill your order.
58
+ Items will be delivered to your pending items when the order is filled. */
59
+ createGrandExchangeBuyOrder(name: string, body: CreateGrandExchangeBuyOrderApiBody): Promise<CreateGrandExchangeBuyOrderApiResult>;
60
+ /** Sell items to an existing buy order at the Grand Exchange on the character's map.
61
+
62
+ You will receive the gold immediately.
63
+ The buyer will receive the items in their pending items. */
64
+ fillGrandExchange(name: string, body: FillGrandExchangeApiBody): Promise<FillGrandExchangeApiResult>;
46
65
  /** Complete a task. */
47
66
  completeTask(name: string): Promise<CompleteTaskApiResult>;
48
67
  /** Exchange 6 tasks coins for a random reward. Rewards are exclusive items or resources. */
@@ -55,12 +74,17 @@ export declare class ArtifactsMyCharactersApi {
55
74
  cancelTask(name: string): Promise<CancelTaskApiResult>;
56
75
  /** Give gold to another character in your account on the same map. */
57
76
  giveGold(name: string, body: GiveGoldApiBody): Promise<GiveGoldApiResult>;
58
- /** Give items to another character in your account on the same map. The cooldown will be 3 seconds multiplied by the number of different items given. */
77
+ /** Give items to another character in your account on the same map.
78
+ * The cooldown will be 3 seconds multiplied by the number of different items given. */
59
79
  giveItems(name: string, body: GiveItemsApiBody): Promise<GiveItemsApiResult>;
80
+ /** Claim a pending item with a specific character. */
81
+ claimPendingItem(id: string, name: string): Promise<ClaimPendingItemApiResult>;
60
82
  /** Delete an item from your character's inventory. */
61
83
  deleteItem(name: string, body: DeleteItemApiBody): Promise<DeleteItemApiResult>;
62
84
  /** Change the skin of your character. */
63
85
  changeSkin(name: string, body: ChangeSkinApiBody): Promise<ChangeSkinApiResult>;
86
+ /** Rename a character. An active membership is required. */
87
+ rename(name: string, body: RenameApiBody): Promise<RenameApiResult>;
64
88
  /** History of the last 5000 actions of all your characters. */
65
89
  getAllLogs(params?: GetAllLogsApiQuery): Promise<GetAllLogsApiResult>;
66
90
  /** History of the last actions of your character. */