@seayoo-web/gamer-api 3.0.4 → 4.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@seayoo-web/gamer-api",
3
3
  "description": "agent for gamer api",
4
- "version": "3.0.4",
4
+ "version": "4.0.1",
5
5
  "type": "module",
6
6
  "source": "index.ts",
7
7
  "main": "./dist/index.js",
@@ -30,11 +30,11 @@
30
30
  "license": "MIT",
31
31
  "devDependencies": {
32
32
  "@types/node": "^22.13.1",
33
- "@seayoo-web/request": "3.4.5",
34
- "@seayoo-web/tsconfig": "1.0.6",
35
- "@seayoo-web/scripts": "3.1.9",
36
- "@seayoo-web/combo-webview": "2.8.0",
33
+ "@seayoo-web/request": "4.0.4",
37
34
  "@seayoo-web/utils": "4.4.1",
35
+ "@seayoo-web/combo-webview": "2.8.0",
36
+ "@seayoo-web/scripts": "3.1.11",
37
+ "@seayoo-web/tsconfig": "1.0.6",
38
38
  "@seayoo-web/validator": "2.3.0"
39
39
  },
40
40
  "peerDependencies": {
@@ -2,7 +2,7 @@ import type { ClubAddress, ClubUserProfile, RedeemParams } from "./club.define";
2
2
  import type { ClubCreditChangeType, ClubItemType } from "./club.enums";
3
3
  import type { UgcSocialMedia } from "./event.enums";
4
4
  import type { AuthToken } from "./token";
5
- import type { RequestInternalError, IRequestOptions } from "@seayoo-web/request";
5
+ import type { RequestInternalError, RequestOptions } from "@seayoo-web/request";
6
6
  import type { SomePartial } from "@seayoo-web/utils";
7
7
  export declare class ClubApi {
8
8
  private token;
@@ -13,13 +13,13 @@ export declare class ClubApi {
13
13
  *
14
14
  * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=tuhsPt3ihp
15
15
  */
16
- getConfig(requestOptions?: IRequestOptions): Promise<import("./club.define").ClubGlobalConfig | null>;
16
+ getConfig(requestOptions?: RequestOptions): Promise<import("./club.define").ClubGlobalConfig | null>;
17
17
  /**
18
18
  * 用于游戏内嵌 Web 页面和微信小程序获取当前登录的游戏账号在俱乐部中的信息。
19
19
  *
20
20
  * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=hIDfaMlT7m
21
21
  */
22
- getCurrentPlayer(requestOptions?: IRequestOptions): Promise<import("./club.define").ClubPlayer | {
22
+ getCurrentPlayer(requestOptions?: RequestOptions): Promise<import("./club.define").ClubPlayer | {
23
23
  message: string;
24
24
  error: RequestInternalError | "seayoo_account_already_deleted" | "player_not_found";
25
25
  }>;
@@ -28,7 +28,7 @@ export declare class ClubApi {
28
28
  *
29
29
  * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=Dpb9JAKqzG
30
30
  */
31
- linkPlayer(requestOptions?: IRequestOptions): Promise<import("./club.define").ClubPlayer | {
31
+ linkPlayer(requestOptions?: RequestOptions): Promise<import("./club.define").ClubPlayer | {
32
32
  message: string;
33
33
  error: RequestInternalError | "seayoo_user_id_has_combo_id" | "combo_id_has_seayoo_user_id";
34
34
  }>;
@@ -37,13 +37,13 @@ export declare class ClubApi {
37
37
  *
38
38
  * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=nwu4FiGM9V
39
39
  */
40
- getRoles(playerId: string, forceReload?: boolean, requestOptions?: IRequestOptions): Promise<import("./club.define").PlayerRole[]>;
40
+ getRoles(playerId: string, forceReload?: boolean, requestOptions?: RequestOptions): Promise<import("./club.define").PlayerRole[]>;
41
41
  /**
42
42
  * 获取俱乐部会员的角色卡片数据
43
43
  *
44
44
  * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=A1Wr7kUXnS
45
45
  */
46
- getRoleCard(memberId: string, requestOptions?: IRequestOptions): Promise<import("./club.define").PlayerRoleCard | null>;
46
+ getRoleCard(memberId: string, requestOptions?: RequestOptions): Promise<import("./club.define").PlayerRoleCard | null>;
47
47
  /**
48
48
  * 设置自己的角色卡片
49
49
  *
@@ -53,25 +53,25 @@ export declare class ClubApi {
53
53
  player_id: string;
54
54
  server_id: string;
55
55
  role_id: string;
56
- }, requestOptions?: IRequestOptions): Promise<import("./club.define").PlayerRoleCard | null>;
56
+ }, requestOptions?: RequestOptions): Promise<import("./club.define").PlayerRoleCard | null>;
57
57
  /**
58
58
  * 强制刷新自己的角色卡片,从游戏内获取最新数据
59
59
  *
60
60
  * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=RPdJquwmgv
61
61
  */
62
- refreshRoleCard(requestOptions?: IRequestOptions): Promise<import("./club.define").PlayerRoleCard | null>;
62
+ refreshRoleCard(requestOptions?: RequestOptions): Promise<import("./club.define").PlayerRoleCard | null>;
63
63
  /**
64
64
  * 获取俱乐部用户的信息
65
65
  *
66
66
  * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=TMWBCFcOr2
67
67
  */
68
- getUserProfile(memberId: string, requestOptions?: IRequestOptions): Promise<ClubUserProfile | null>;
68
+ getUserProfile(memberId: string, requestOptions?: RequestOptions): Promise<ClubUserProfile | null>;
69
69
  /**
70
70
  * 修改自己的俱乐部用户信息
71
71
  *
72
72
  * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=Qt822A57jd
73
73
  */
74
- updateUserProfile(option: Partial<ClubUserProfile>, requestOptions?: IRequestOptions): Promise<ClubUserProfile | {
74
+ updateUserProfile(option: Partial<ClubUserProfile>, requestOptions?: RequestOptions): Promise<ClubUserProfile | {
75
75
  error: "OptionIsEmpty";
76
76
  message: string;
77
77
  } | {
@@ -83,13 +83,13 @@ export declare class ClubApi {
83
83
  *
84
84
  * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=NowUIynMVn
85
85
  */
86
- getAddresses(requestOptions?: IRequestOptions): Promise<ClubAddress[]>;
86
+ getAddresses(requestOptions?: RequestOptions): Promise<ClubAddress[]>;
87
87
  /**
88
88
  * 增加俱乐部收货地址
89
89
  *
90
90
  * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=TaGIIYDRYA
91
91
  */
92
- addAddress(option: Omit<SomePartial<ClubAddress, "is_default">, "address_id">, requestOptions?: IRequestOptions): Promise<ClubAddress | {
92
+ addAddress(option: Omit<SomePartial<ClubAddress, "is_default">, "address_id">, requestOptions?: RequestOptions): Promise<ClubAddress | {
93
93
  message: string;
94
94
  error: RequestInternalError;
95
95
  } | null>;
@@ -98,7 +98,7 @@ export declare class ClubApi {
98
98
  *
99
99
  * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=p9FlJhHnWN
100
100
  */
101
- updateAddress(option: SomePartial<ClubAddress, "is_default">, requestOptions?: IRequestOptions): Promise<ClubAddress | {
101
+ updateAddress(option: SomePartial<ClubAddress, "is_default">, requestOptions?: RequestOptions): Promise<ClubAddress | {
102
102
  message: string;
103
103
  error: RequestInternalError | "address_not_found";
104
104
  }>;
@@ -107,7 +107,7 @@ export declare class ClubApi {
107
107
  *
108
108
  * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=MEEOBdf8rm
109
109
  */
110
- deleteAddress(addressId: number, requestOptions?: IRequestOptions): Promise<boolean | null>;
110
+ deleteAddress(addressId: number, requestOptions?: RequestOptions): Promise<boolean | null>;
111
111
  /**
112
112
  * 获取俱乐部积分统计信息
113
113
  *
@@ -120,7 +120,7 @@ export declare class ClubApi {
120
120
  end_time: number;
121
121
  /** 游戏账号 ID,游戏外必传 */
122
122
  player_id?: string;
123
- }, requestOptions?: IRequestOptions): Promise<import("./club.define").ClubUserCredit | {
123
+ }, requestOptions?: RequestOptions): Promise<import("./club.define").ClubUserCredit | {
124
124
  message: string;
125
125
  error: RequestInternalError | "player_not_found";
126
126
  }>;
@@ -142,7 +142,7 @@ export declare class ClubApi {
142
142
  end_time: number;
143
143
  /** 游戏账号 ID,游戏外必传 */
144
144
  player_id?: string;
145
- }, requestOptions?: IRequestOptions): Promise<{
145
+ }, requestOptions?: RequestOptions): Promise<{
146
146
  credit_logs: import("./club.define").ClubCreditLog[];
147
147
  next_token: string | undefined;
148
148
  }>;
@@ -151,13 +151,13 @@ export declare class ClubApi {
151
151
  *
152
152
  * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=UFSDGvqkdV
153
153
  */
154
- getBenefits(requestOptions?: IRequestOptions): Promise<import("./club.define").ClubBenefitSummary[]>;
154
+ getBenefits(requestOptions?: RequestOptions): Promise<import("./club.define").ClubBenefitSummary[]>;
155
155
  /**
156
156
  * 获取某个权益详细信息
157
157
  *
158
158
  * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=XKto0MeaHF
159
159
  */
160
- getBenefit(benefitId: number, requestOptions?: IRequestOptions): Promise<import("./club.define").ClubBenefit | null>;
160
+ getBenefit(benefitId: number, requestOptions?: RequestOptions): Promise<import("./club.define").ClubBenefit | null>;
161
161
  /**
162
162
  * 获取商城商品列表
163
163
  *
@@ -168,7 +168,7 @@ export declare class ClubApi {
168
168
  player_id?: string;
169
169
  /** 商品分类 ID */
170
170
  catalog_id?: number;
171
- }, requestOptions?: IRequestOptions): Promise<import("./club.define").ClubProduct[]>;
171
+ }, requestOptions?: RequestOptions): Promise<import("./club.define").ClubProduct[]>;
172
172
  /**
173
173
  * 兑换商城商品
174
174
  *
@@ -183,7 +183,7 @@ export declare class ClubApi {
183
183
  params?: RedeemParams;
184
184
  /** 游戏账号 ID,游戏外必传 */
185
185
  player_id?: string;
186
- }, requestOptions?: IRequestOptions): Promise<true | {
186
+ }, requestOptions?: RequestOptions): Promise<true | {
187
187
  message: string;
188
188
  error: RequestInternalError | "mall_product_not_found" | "credit_not_found" | "role_not_found" | "player_level_not_enough" | "credit_balance_not_enough" | "redeem_product_quantity_exceeds_limit" | "redeem_quantity_over_stock" | "redeem_quantity_over_daily_limit" | "redeem_quantity_over_month_limit" | "redeem_quantity_over_year_limit" | "redeem_quantity_over_total_limit" | "club_redeem_condition_dissatisfied";
189
189
  }>;
@@ -201,7 +201,7 @@ export declare class ClubApi {
201
201
  item_type?: ClubItemType;
202
202
  /** 游戏账号 ID,游戏外必传 */
203
203
  player_id?: string;
204
- }, requestOptions?: IRequestOptions): Promise<{
204
+ }, requestOptions?: RequestOptions): Promise<{
205
205
  redemptions: import("./club.define").Redemption[];
206
206
  next_token: string | undefined;
207
207
  }>;
@@ -221,7 +221,7 @@ export declare class ClubApi {
221
221
  content_length: number;
222
222
  /** 待上传文件的 SHA-256 哈希值 用于校验上传对象的完整性 */
223
223
  content_sha256: string;
224
- }, requestOptions?: IRequestOptions): Promise<{
224
+ }, requestOptions?: RequestOptions): Promise<{
225
225
  existed: boolean;
226
226
  image_upload_url: string | undefined;
227
227
  image_id: string;
@@ -1,6 +1,6 @@
1
1
  import type { NotificationCategory } from "./community.enums";
2
2
  import type { AuthToken } from "./token";
3
- import type { IRequestOptions, RequestInternalError } from "@seayoo-web/request";
3
+ import type { RequestOptions, RequestInternalError } from "@seayoo-web/request";
4
4
  export declare class CommunityApi {
5
5
  private token;
6
6
  private req;
@@ -10,19 +10,19 @@ export declare class CommunityApi {
10
10
  *
11
11
  * https://kdocs.cn/l/cbggfJodHLIz?linkname=QaqUa2K0z0
12
12
  */
13
- getForums(requestOptions?: IRequestOptions): Promise<import("./community.define").Forum[]>;
13
+ getForums(requestOptions?: RequestOptions): Promise<import("./community.define").Forum[]>;
14
14
  /**
15
15
  * 获取社区话题列表,仅返回启用状态的话题
16
16
  *
17
17
  * https://kdocs.cn/l/cbggfJodHLIz?linkname=mIwpymAQom
18
18
  */
19
- getTopics(requestOptions?: IRequestOptions): Promise<import("./community.define").Topic[]>;
19
+ getTopics(requestOptions?: RequestOptions): Promise<import("./community.define").Topic[]>;
20
20
  /**
21
21
  * 根据话题 ID 获取社区话题信息
22
22
  *
23
23
  * https://kdocs.cn/l/cbggfJodHLIz?linkname=Jvw7xMK31K
24
24
  */
25
- getTopic(topicId: number, requestOptions?: IRequestOptions): Promise<import("./community.define").Topic | {
25
+ getTopic(topicId: number, requestOptions?: RequestOptions): Promise<import("./community.define").Topic | {
26
26
  error: RequestInternalError | "topic_not_enabled" | "topic_not_found";
27
27
  }>;
28
28
  /**
@@ -54,7 +54,7 @@ export declare class CommunityApi {
54
54
  * - post_like 帖子点赞数排序
55
55
  */
56
56
  sort_key?: "post_time_desc" | "post_like";
57
- }, requestOptions?: IRequestOptions): Promise<{
57
+ }, requestOptions?: RequestOptions): Promise<{
58
58
  posts: import("./community.define").Post[];
59
59
  next_token: string | undefined;
60
60
  } | {
@@ -66,7 +66,7 @@ export declare class CommunityApi {
66
66
  *
67
67
  * https://kdocs.cn/l/cbggfJodHLIz?linkname=yXubbZuDlC
68
68
  */
69
- getPinnedPosts(forumId: number, maxResults: number, nextToken?: string, requestOptions?: IRequestOptions): Promise<{
69
+ getPinnedPosts(forumId: number, maxResults: number, nextToken?: string, requestOptions?: RequestOptions): Promise<{
70
70
  posts: import("./community.define").Post[];
71
71
  next_token: string | undefined;
72
72
  } | {
@@ -78,7 +78,7 @@ export declare class CommunityApi {
78
78
  *
79
79
  * https://kdocs.cn/l/cbggfJodHLIz?linkname=hj1AZy5rcP
80
80
  */
81
- getPost(postId: number, requestOptions?: IRequestOptions): Promise<import("./community.define").Post | {
81
+ getPost(postId: number, requestOptions?: RequestOptions): Promise<import("./community.define").Post | {
82
82
  message: string;
83
83
  error: RequestInternalError | "post_deleted";
84
84
  }>;
@@ -93,7 +93,7 @@ export declare class CommunityApi {
93
93
  title?: string;
94
94
  image_urls?: string[];
95
95
  topic_ids?: number[];
96
- }, requestOptions?: IRequestOptions): Promise<{
96
+ }, requestOptions?: RequestOptions): Promise<{
97
97
  post: import("./community.define").Post | undefined;
98
98
  antispam: import("./community.define").Antispam | undefined;
99
99
  } | {
@@ -114,7 +114,7 @@ export declare class CommunityApi {
114
114
  max_results: number;
115
115
  /** 分页token */
116
116
  next_token?: string;
117
- }, requestOptions?: IRequestOptions): Promise<{
117
+ }, requestOptions?: RequestOptions): Promise<{
118
118
  comments: import("./community.define").Comment[];
119
119
  next_token: string | undefined;
120
120
  } | {
@@ -126,7 +126,7 @@ export declare class CommunityApi {
126
126
  *
127
127
  * https://kdocs.cn/l/cbggfJodHLIz?linkname=RIc7oxVGae
128
128
  */
129
- getComment(commentId: number, requestOptions?: IRequestOptions): Promise<import("./community.define").Comment | {
129
+ getComment(commentId: number, requestOptions?: RequestOptions): Promise<import("./community.define").Comment | {
130
130
  message: string;
131
131
  error: RequestInternalError | "comment_not_found" | "comment_deleted";
132
132
  }>;
@@ -142,7 +142,7 @@ export declare class CommunityApi {
142
142
  content: string;
143
143
  /** 评论内容图片地址 */
144
144
  image_url?: string;
145
- }, requestOptions?: IRequestOptions): Promise<{
145
+ }, requestOptions?: RequestOptions): Promise<{
146
146
  comment: import("./community.define").Comment | undefined;
147
147
  antispam: import("./community.define").Comment | undefined;
148
148
  } | {
@@ -163,7 +163,7 @@ export declare class CommunityApi {
163
163
  query_value: string;
164
164
  /** 分页标识,不传默认首次查询 */
165
165
  next_token?: string;
166
- }, requestOptions?: IRequestOptions): Promise<{
166
+ }, requestOptions?: RequestOptions): Promise<{
167
167
  replies: import("./community.define").Reply[];
168
168
  next_token: string;
169
169
  }>;
@@ -172,7 +172,7 @@ export declare class CommunityApi {
172
172
  *
173
173
  * https://kdocs.cn/l/cbggfJodHLIz?linkname=kxhcSXD3MG
174
174
  */
175
- getReply(replyId: number, requestOptions?: IRequestOptions): Promise<import("./community.define").Reply | {
175
+ getReply(replyId: number, requestOptions?: RequestOptions): Promise<import("./community.define").Reply | {
176
176
  message: string;
177
177
  error: RequestInternalError | "reply_not_found" | "reply_deleted";
178
178
  }>;
@@ -188,7 +188,7 @@ export declare class CommunityApi {
188
188
  content: string;
189
189
  /** 回复的回复 ID (仅当回复回复的时候需要) */
190
190
  reply_id?: number;
191
- }, requestOptions?: IRequestOptions): Promise<{
191
+ }, requestOptions?: RequestOptions): Promise<{
192
192
  reply: import("./community.define").Reply | undefined;
193
193
  antispam: import("./community.define").Antispam | undefined;
194
194
  } | {
@@ -205,7 +205,7 @@ export declare class CommunityApi {
205
205
  target_type: "post" | "comment" | "reply";
206
206
  /** 目标 ID */
207
207
  target_id: number;
208
- }, requestOptions?: IRequestOptions): Promise<true | {
208
+ }, requestOptions?: RequestOptions): Promise<true | {
209
209
  message: string;
210
210
  error: RequestInternalError | "post_not_found" | "post_deleted" | "comment_not_found" | "comment_deleted" | "reply_not_found" | "reply_deleted";
211
211
  }>;
@@ -219,7 +219,7 @@ export declare class CommunityApi {
219
219
  target_type: "post" | "comment" | "reply";
220
220
  /** 目标 ID */
221
221
  target_id: number;
222
- }, requestOptions?: IRequestOptions): Promise<true | {
222
+ }, requestOptions?: RequestOptions): Promise<true | {
223
223
  message: string;
224
224
  error: RequestInternalError | "post_not_found" | "post_deleted" | "comment_not_found" | "comment_deleted" | "reply_not_found" | "reply_deleted";
225
225
  }>;
@@ -237,7 +237,7 @@ export declare class CommunityApi {
237
237
  filename: string;
238
238
  /** 资源文件内容的 SHA-256 哈希值,用于校验上传对象的完整性 */
239
239
  content_sha256: string;
240
- }, requestOptions?: IRequestOptions): Promise<import("./community.define").PresignedUrlResponse | null>;
240
+ }, requestOptions?: RequestOptions): Promise<import("./community.define").PresignedUrlResponse | null>;
241
241
  /**
242
242
  * 获取用户社区通知
243
243
  *
@@ -252,7 +252,7 @@ export declare class CommunityApi {
252
252
  max_results?: number;
253
253
  /** 分页标识,不传默认首次查询 */
254
254
  next_token?: string;
255
- }, requestOptions?: IRequestOptions): Promise<{
255
+ }, requestOptions?: RequestOptions): Promise<{
256
256
  notifications: (import("./community.define").NotificationSystem | import("./community.define").NotificationPost | import("./community.define").NotificationPostComment | import("./community.define").NotificationCommentReply | import("./community.define").NotificationComment | import("./community.define").NotificationReplyReplied | import("./community.define").NotificationReply)[];
257
257
  next_token: string;
258
258
  }>;
@@ -261,7 +261,7 @@ export declare class CommunityApi {
261
261
  *
262
262
  * https://kdocs.cn/l/cbggfJodHLIz?linkname=CwIOMjAfMU
263
263
  */
264
- getUnreadNotificationsCount(requestOptions?: IRequestOptions): Promise<{
264
+ getUnreadNotificationsCount(requestOptions?: RequestOptions): Promise<{
265
265
  system: number;
266
266
  comment: number;
267
267
  like: number;
@@ -271,5 +271,5 @@ export declare class CommunityApi {
271
271
  *
272
272
  * https://kdocs.cn/l/cbggfJodHLIz?linkname=TCJQxnOjJe
273
273
  */
274
- clearUnreadNotifications(category: NotificationCategory, requestOptions?: IRequestOptions): Promise<boolean>;
274
+ clearUnreadNotifications(category: NotificationCategory, requestOptions?: RequestOptions): Promise<boolean>;
275
275
  }
@@ -1,7 +1,7 @@
1
1
  import type { EventApi } from "./event";
2
2
  import type { EngagementFeatureType, InferEngagementError, InferEngagementParam } from "./event.define";
3
3
  import type { GamerItemType, RewardSource, RewardStatus, UgcReviewStatus } from "./event.enums";
4
- import type { IRequestOptions, RequestInternalError } from "@seayoo-web/request";
4
+ import type { RequestOptions, RequestInternalError } from "@seayoo-web/request";
5
5
  type ApiInstance = InstanceType<typeof EventApi>;
6
6
  /** 支持的 api 方法,用于 TS 类型输入提示 */
7
7
  export type ApiMethodNames = "verifyMobileAllowed" | "getConfig" | "getEngagementsUserCount" | "getEngagementsCount" | "getEngagements" | "visit" | "getUserFeatureStatus" | "getUserEngagementCount" | "getUserEngagements" | "engage" | "claimRewards" | "submitUserRewardAddress" | "getUnlimitQrcodeScene" | "getParamsByQrcodeScene" | "generateUnlimitQrcode" | "getQuestProgress" | "vote2Rewards" | "getVote2Leaderboard" | "getCashbackQuery" | "getUgcRecord" | "getUgcMyCount" | "claimRewardsV2" | "claimWeixinHongbao" | "verifyActivationKey" | "getUserRewards" | "getUserRewardsCount" | "getUserItemCount" | "ugcUploadImage" | "getUgcRecommendation" | "getUgcs" | "getUgcLeaderboard" | "getRedeemItemStocks";
@@ -10,25 +10,25 @@ export type ApiMethodNames = "verifyMobileAllowed" | "getConfig" | "getEngagemen
10
10
  *
11
11
  * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=OWGSPF3Ysl
12
12
  */
13
- export declare function verifyMobileAllowed(this: ApiInstance, gameId: string, mobile: string, requestOptions?: IRequestOptions): Promise<import("./event.define").VerifyMobileResult | null>;
13
+ export declare function verifyMobileAllowed(this: ApiInstance, gameId: string, mobile: string, requestOptions?: RequestOptions): Promise<import("./event.define").VerifyMobileResult | null>;
14
14
  /**
15
15
  * 获取运营活动的基础配置信息
16
16
  *
17
17
  * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=wFXxtdNKPm
18
18
  */
19
- export declare function getConfig(this: ApiInstance, requestOptions?: IRequestOptions): Promise<import("./event.config").EventConfig | null>;
19
+ export declare function getConfig(this: ApiInstance, requestOptions?: RequestOptions): Promise<import("./event.config").EventConfig | null>;
20
20
  /**
21
21
  * 获取某个玩法参与用户数量
22
22
  *
23
23
  * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=ejPOcWMvT1
24
24
  */
25
- export declare function getEngagementsUserCount(this: ApiInstance, featureId: number, requestOptions?: IRequestOptions): Promise<number | null>;
25
+ export declare function getEngagementsUserCount(this: ApiInstance, featureId: number, requestOptions?: RequestOptions): Promise<number | null>;
26
26
  /**
27
27
  * 获取某个玩法参与次数
28
28
  *
29
29
  * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=ejPOcWMvT1
30
30
  */
31
- export declare function getEngagementsCount(this: ApiInstance, featureId: number, requestOptions?: IRequestOptions): Promise<number | null>;
31
+ export declare function getEngagementsCount(this: ApiInstance, featureId: number, requestOptions?: RequestOptions): Promise<number | null>;
32
32
  /**
33
33
  * 获取某个玩法的参与记录(和特定用户无关)
34
34
  *
@@ -36,7 +36,7 @@ export declare function getEngagementsCount(this: ApiInstance, featureId: number
36
36
  *
37
37
  * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=THtZ4ewIQW
38
38
  */
39
- export declare function getEngagements(this: ApiInstance, featureId: number, requestOptions?: IRequestOptions): Promise<import("./event.engage").CommentEngagement[] | import("./event.engage").TeamEngagement[]>;
39
+ export declare function getEngagements(this: ApiInstance, featureId: number, requestOptions?: RequestOptions): Promise<import("./event.engage").CommentEngagement[] | import("./event.engage").TeamEngagement[]>;
40
40
  /**
41
41
  * 用户访问某个活动或玩法
42
42
  *
@@ -49,7 +49,7 @@ export declare function visit(this: ApiInstance, option?: {
49
49
  utm_source?: string;
50
50
  /** 邀请人的世游通行证 ID */
51
51
  invited_by?: string;
52
- }, requestOptions?: IRequestOptions): Promise<{
52
+ }, requestOptions?: RequestOptions): Promise<{
53
53
  first_visit: boolean;
54
54
  } | {
55
55
  message: string;
@@ -65,7 +65,7 @@ export declare function visit(this: ApiInstance, option?: {
65
65
  export declare function getUserFeatureStatus(this: ApiInstance, option?: {
66
66
  server_id: string;
67
67
  role_id: string;
68
- }, requestOptions?: IRequestOptions): Promise<import("./event.define").UserFeatureStatus[]>;
68
+ }, requestOptions?: RequestOptions): Promise<import("./event.define").UserFeatureStatus[]>;
69
69
  /**
70
70
  * 获取用户在目标活动下的某个玩法的参与次数
71
71
  *
@@ -98,7 +98,7 @@ export declare function getUserEngagements(this: ApiInstance, featureId: number,
98
98
  * 当玩法的 engage_account_type 为 role_id 时,可提供 server_id 和 role_id 获取具体角色的参与记录
99
99
  */
100
100
  role_id?: string;
101
- }, requestOptions?: IRequestOptions): Promise<{
101
+ }, requestOptions?: RequestOptions): Promise<{
102
102
  engagements: import("./event.engage").UserEngagement[];
103
103
  next_token: string;
104
104
  }>;
@@ -123,7 +123,7 @@ export declare function engage<T extends EngagementFeatureType = unknown>(this:
123
123
  role_id?: string;
124
124
  role_name?: string;
125
125
  avatar_url?: string;
126
- }, requestOptions?: IRequestOptions): Promise<import("./event.define").EngageResponse | {
126
+ }, requestOptions?: RequestOptions): Promise<import("./event.define").EngageResponse | {
127
127
  message: string;
128
128
  error: RequestInternalError | InferEngagementError<T>;
129
129
  }>;
@@ -145,7 +145,7 @@ export declare function claimRewards(this: ApiInstance, params: {
145
145
  role_id?: string;
146
146
  /** 游戏角色名 */
147
147
  role_name?: string;
148
- }, requestOptions?: IRequestOptions): Promise<import("./event.define").ClaimedItem[] | {
148
+ }, requestOptions?: RequestOptions): Promise<import("./event.define").ClaimedItem[] | {
149
149
  message: string;
150
150
  error: RequestInternalError | "invalid_server_id" | "invalid_role_id" | "event_not_found" | "engagement_not_found" | "event_not_started" | "event_already_ended" | "claim_rewards_not_started" | "claim_rewards_already_ended" | "no_rewards_to_claim" | "reward_received" | "claim_reward_error";
151
151
  }>;
@@ -171,7 +171,7 @@ export declare function submitUserRewardAddress(this: ApiInstance, option: {
171
171
  district: string;
172
172
  /** 详细收货地址 */
173
173
  address: string;
174
- }, requestOptions?: IRequestOptions): Promise<true | {
174
+ }, requestOptions?: RequestOptions): Promise<true | {
175
175
  message: string;
176
176
  error: RequestInternalError | "invalid_token" | "event_not_found" | "address_not_found";
177
177
  } | null>;
@@ -182,7 +182,7 @@ export declare function submitUserRewardAddress(this: ApiInstance, option: {
182
182
  *
183
183
  * @param params - 前端扫描二维码打开小程序所需参数
184
184
  */
185
- export declare function getUnlimitQrcodeScene(this: ApiInstance, params: string, requestOptions?: IRequestOptions): Promise<string | null>;
185
+ export declare function getUnlimitQrcodeScene(this: ApiInstance, params: string, requestOptions?: RequestOptions): Promise<string | null>;
186
186
  /**
187
187
  * 根据小程序码携带 scene 值,获取对应的前端所需参数
188
188
  *
@@ -190,7 +190,7 @@ export declare function getUnlimitQrcodeScene(this: ApiInstance, params: string,
190
190
  *
191
191
  * @param scene - 小程序码 scene 值
192
192
  */
193
- export declare function getParamsByQrcodeScene(this: ApiInstance, scene: string, requestOptions?: IRequestOptions): Promise<string | null>;
193
+ export declare function getParamsByQrcodeScene(this: ApiInstance, scene: string, requestOptions?: RequestOptions): Promise<string | null>;
194
194
  /**
195
195
  * 生成不限制的带参数的小程序码(dataURI 格式的小程序码图片)
196
196
  *
@@ -232,13 +232,13 @@ export declare function generateUnlimitQrcode(this: ApiInstance, option: {
232
232
  };
233
233
  /** 生成的小程序码是否需要透明底色 */
234
234
  is_hyaline?: boolean;
235
- }, requestOptions?: IRequestOptions): Promise<string | null>;
235
+ }, requestOptions?: RequestOptions): Promise<string | null>;
236
236
  /**
237
237
  * 本接口用于获取任务玩法的实时进度数据,支持部分任务进度的查询:累计充值金额 / 累计游戏内活跃值 / 账号等级目标
238
238
  *
239
239
  * https://www.kdocs.cn/l/ckWFDcOsYEUA?linkname=ZAnm12d3f0
240
240
  */
241
- export declare function getQuestProgress(this: ApiInstance, featureId: number, requestOptions?: IRequestOptions): Promise<import("./event.engage").QuestProgress | {
241
+ export declare function getQuestProgress(this: ApiInstance, featureId: number, requestOptions?: RequestOptions): Promise<import("./event.engage").QuestProgress | {
242
242
  message: string;
243
243
  error: RequestInternalError | "invalid_token" | "feature_not_found";
244
244
  } | null>;
@@ -249,7 +249,7 @@ export declare function getQuestProgress(this: ApiInstance, featureId: number, r
249
249
  *
250
250
  * https://www.kdocs.cn/l/chlVWKom7DzU?linkname=fabGKteIEK
251
251
  */
252
- export declare function vote2Rewards(this: ApiInstance, featureId: number, requestOptions?: IRequestOptions): Promise<import("./event.engage").Vote2ClaimRewardsResponse | {
252
+ export declare function vote2Rewards(this: ApiInstance, featureId: number, requestOptions?: RequestOptions): Promise<import("./event.engage").Vote2ClaimRewardsResponse | {
253
253
  message: string;
254
254
  code: RequestInternalError | "vote_rewards_not_started" | "vote_rewards_already_ended" | "engagement_not_found";
255
255
  } | null>;
@@ -258,13 +258,13 @@ export declare function vote2Rewards(this: ApiInstance, featureId: number, reque
258
258
  *
259
259
  * https://www.kdocs.cn/l/chlVWKom7DzU?linkname=cYZMVXbP4u
260
260
  */
261
- export declare function getVote2Leaderboard(this: ApiInstance, featureId: number, requestOptions?: IRequestOptions): Promise<import("./event.engage").CandidateVote[]>;
261
+ export declare function getVote2Leaderboard(this: ApiInstance, featureId: number, requestOptions?: RequestOptions): Promise<import("./event.engage").CandidateVote[]>;
262
262
  /**
263
263
  * 充值返还玩法的查询接口,查询返还数据
264
264
  *
265
265
  * https://www.kdocs.cn/l/ckWFDcOsYEUA?linkname=yNolN2sWp4
266
266
  */
267
- export declare function getCashbackQuery(this: ApiInstance, featureId: number, requestOptions?: IRequestOptions): Promise<import("./event.engage").CashbackEngagementData | {
267
+ export declare function getCashbackQuery(this: ApiInstance, featureId: number, requestOptions?: RequestOptions): Promise<import("./event.engage").CashbackEngagementData | {
268
268
  message: string;
269
269
  error: RequestInternalError | "event_not_found" | "feature_not_found";
270
270
  } | null>;
@@ -286,7 +286,7 @@ export declare function getUgcRecord(this: ApiInstance, option: {
286
286
  max_results?: number;
287
287
  /** 分页标识,不传默认首页查询 */
288
288
  next_token?: string;
289
- }, requestOptions?: IRequestOptions): Promise<import("./event.engage").UgcRecordResponse | {
289
+ }, requestOptions?: RequestOptions): Promise<import("./event.engage").UgcRecordResponse | {
290
290
  message: string;
291
291
  error: RequestInternalError | "event_not_found" | "feature_not_found";
292
292
  } | null>;
@@ -298,7 +298,7 @@ export declare function getUgcRecord(this: ApiInstance, option: {
298
298
  export declare function getUgcMyCount(this: ApiInstance, option: {
299
299
  /** 活动 ID 列表,多个用逗号分隔。若不传,则统计所有活动。*/
300
300
  event_ids?: string;
301
- }, requestOptions?: IRequestOptions): Promise<{
301
+ }, requestOptions?: RequestOptions): Promise<{
302
302
  total_count: number;
303
303
  } | {
304
304
  message: string;
@@ -320,7 +320,7 @@ export declare function claimRewardsV2(this: ApiInstance, params: {
320
320
  role_id?: string;
321
321
  /** 游戏角色名 */
322
322
  role_name?: string;
323
- }, requestOptions?: IRequestOptions): Promise<import("./event.engage").UserReward[] | {
323
+ }, requestOptions?: RequestOptions): Promise<import("./event.engage").UserReward[] | {
324
324
  message: string;
325
325
  error: RequestInternalError | "invalid_server_id" | "invalid_role_id" | "event_not_found" | "engagement_not_found" | "event_not_started" | "event_already_ended" | "claim_rewards_not_started" | "claim_rewards_already_ended" | "no_rewards_to_claim" | "reward_received" | "claim_reward_error";
326
326
  }>;
@@ -329,7 +329,7 @@ export declare function claimRewardsV2(this: ApiInstance, params: {
329
329
  *
330
330
  * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=aQLhlOAB4Q
331
331
  */
332
- export declare function claimWeixinHongbao(this: ApiInstance, rewardId: number, requestOptions?: IRequestOptions): Promise<{
332
+ export declare function claimWeixinHongbao(this: ApiInstance, rewardId: number, requestOptions?: RequestOptions): Promise<{
333
333
  reward_status: import("./event.enums").ClaimRewardStatus;
334
334
  } | {
335
335
  message: string;
@@ -340,7 +340,7 @@ export declare function claimWeixinHongbao(this: ApiInstance, rewardId: number,
340
340
  *
341
341
  * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=B4xwTbDzhn
342
342
  */
343
- export declare function verifyActivationKey(this: ApiInstance, activationKey: string, requestOptions?: IRequestOptions): Promise<true | {
343
+ export declare function verifyActivationKey(this: ApiInstance, activationKey: string, requestOptions?: RequestOptions): Promise<true | {
344
344
  readonly error: "not_logged_in";
345
345
  message?: undefined;
346
346
  } | {
@@ -361,7 +361,7 @@ export declare function getUserRewards(this: ApiInstance, option: {
361
361
  max_results?: number;
362
362
  next_token?: string;
363
363
  reward_status?: RewardStatus;
364
- }, requestOptions?: IRequestOptions): Promise<{
364
+ }, requestOptions?: RequestOptions): Promise<{
365
365
  user_rewards: import("./event.engage").UserReward[];
366
366
  next_token: string;
367
367
  }>;
@@ -373,7 +373,7 @@ export declare function getUserRewards(this: ApiInstance, option: {
373
373
  export declare function getUserRewardsCount(this: ApiInstance, option: {
374
374
  /** 活动 ID 列表,多个用逗号分隔。若不传,则统计所有活动。*/
375
375
  event_ids?: string;
376
- }, requestOptions?: IRequestOptions): Promise<{
376
+ }, requestOptions?: RequestOptions): Promise<{
377
377
  unclaimed: number;
378
378
  }>;
379
379
  /**
@@ -381,7 +381,7 @@ export declare function getUserRewardsCount(this: ApiInstance, option: {
381
381
  *
382
382
  * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=mnGCTeTgMb
383
383
  */
384
- export declare function getUserItemCount(this: ApiInstance, itemId: number, requestOptions?: IRequestOptions): Promise<number | null>;
384
+ export declare function getUserItemCount(this: ApiInstance, itemId: number, requestOptions?: RequestOptions): Promise<number | null>;
385
385
  /**
386
386
  * 媒体资源预上传地址获取,为投稿玩法(UGC)提供 S3 预签名上传 URL,供用户客户端上传图片资源
387
387
  *
@@ -397,7 +397,7 @@ export declare function ugcUploadImage(this: ApiInstance, featureId: number, opt
397
397
  size: number;
398
398
  /** 媒体文件内容的 SHA-256 哈希值 用于校验上传对象的完整性 */
399
399
  sha256: string;
400
- }, requestOptions?: IRequestOptions): Promise<{
400
+ }, requestOptions?: RequestOptions): Promise<{
401
401
  existed: boolean;
402
402
  upload_url: string | undefined;
403
403
  image_url: string;
@@ -410,7 +410,7 @@ export declare function ugcUploadImage(this: ApiInstance, featureId: number, opt
410
410
  *
411
411
  * https://www.kdocs.cn/l/ckWFDcOsYEUA?linkname=WzvcAPjHAh
412
412
  */
413
- export declare function getUgcRecommendation(this: ApiInstance, featureId: number, requestOptions?: IRequestOptions): Promise<import("./event.engage").UgcRecordResponse | {
413
+ export declare function getUgcRecommendation(this: ApiInstance, featureId: number, requestOptions?: RequestOptions): Promise<import("./event.engage").UgcRecordResponse | {
414
414
  message: string;
415
415
  error: RequestInternalError | "event_not_found" | "feature_not_found";
416
416
  }>;
@@ -423,7 +423,7 @@ export declare function getUgcs(this: ApiInstance, featureId: number, option?: {
423
423
  /** 单页返回的最大数量,默认 20 */
424
424
  max_results?: number;
425
425
  next_token?: string;
426
- }, requestOptions?: IRequestOptions): Promise<import("./event.engage").UgcRecordBaseResponse | {
426
+ }, requestOptions?: RequestOptions): Promise<import("./event.engage").UgcRecordBaseResponse | {
427
427
  message: string;
428
428
  error: RequestInternalError | "event_not_found" | "feature_not_found";
429
429
  }>;
@@ -437,7 +437,7 @@ export declare function getUgcs(this: ApiInstance, featureId: number, option?: {
437
437
  *
438
438
  * https://www.kdocs.cn/l/ckWFDcOsYEUA?linkname=KoB7S8omkC
439
439
  */
440
- export declare function getUgcLeaderboard(this: ApiInstance, featureId: number, requestOptions?: IRequestOptions): Promise<import("./event.engage").UgcLeaderboardResponse | {
440
+ export declare function getUgcLeaderboard(this: ApiInstance, featureId: number, requestOptions?: RequestOptions): Promise<import("./event.engage").UgcLeaderboardResponse | {
441
441
  message: string;
442
442
  error: RequestInternalError | "event_not_found" | "feature_not_found";
443
443
  } | null>;
@@ -446,7 +446,7 @@ export declare function getUgcLeaderboard(this: ApiInstance, featureId: number,
446
446
  *
447
447
  * https://www.kdocs.cn/l/ckWFDcOsYEUA?linkname=gOqT9svLF7
448
448
  */
449
- export declare function getRedeemItemStocks(this: ApiInstance, featureId: number, requestOptions?: IRequestOptions): Promise<import("./event.engage").RedeemStocksResponse | {
449
+ export declare function getRedeemItemStocks(this: ApiInstance, featureId: number, requestOptions?: RequestOptions): Promise<import("./event.engage").RedeemStocksResponse | {
450
450
  message: string;
451
451
  error: RequestInternalError | "event_not_found" | "feature_not_found";
452
452
  } | null>;