@rebornteam/reborn-api 4.9.3 → 4.9.4
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/.openapi-generator/FILES +5 -0
- package/README.md +8 -2
- package/api.ts +287 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +190 -1
- package/dist/api.js +176 -3
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +190 -1
- package/dist/esm/api.js +170 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/AdminAdvancedBanImportRequest.md +35 -0
- package/docs/AdminImportApi.md +63 -0
- package/docs/AdminJobConfig.md +31 -0
- package/docs/AdminJobField.md +33 -0
- package/docs/AdminJobsApi.md +47 -0
- package/docs/JobFieldType.md +15 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
3
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 4.9.
|
|
5
|
+
* The version of the OpenAPI document: 4.9.4
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -13,6 +13,43 @@ import type { Configuration } from './configuration';
|
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import type { RequestArgs } from './base';
|
|
15
15
|
import { BaseAPI } from './base';
|
|
16
|
+
/**
|
|
17
|
+
* Source AdvancedBan MySQL connection details for a punishment import.
|
|
18
|
+
*/
|
|
19
|
+
export interface AdminAdvancedBanImportRequest {
|
|
20
|
+
/**
|
|
21
|
+
* MySQL host
|
|
22
|
+
*/
|
|
23
|
+
'host': string;
|
|
24
|
+
/**
|
|
25
|
+
* MySQL port (default 3306)
|
|
26
|
+
*/
|
|
27
|
+
'port'?: number | null;
|
|
28
|
+
/**
|
|
29
|
+
* Database / schema name
|
|
30
|
+
*/
|
|
31
|
+
'database': string;
|
|
32
|
+
/**
|
|
33
|
+
* MySQL username
|
|
34
|
+
*/
|
|
35
|
+
'username': string;
|
|
36
|
+
/**
|
|
37
|
+
* MySQL password
|
|
38
|
+
*/
|
|
39
|
+
'password'?: string | null;
|
|
40
|
+
/**
|
|
41
|
+
* Active punishments table (default \'Punishments\')
|
|
42
|
+
*/
|
|
43
|
+
'activeTable'?: string | null;
|
|
44
|
+
/**
|
|
45
|
+
* History table (default \'PunishmentHistory\')
|
|
46
|
+
*/
|
|
47
|
+
'historyTable'?: string | null;
|
|
48
|
+
/**
|
|
49
|
+
* Use TLS for the MySQL connection (default false)
|
|
50
|
+
*/
|
|
51
|
+
'useSsl'?: boolean | null;
|
|
52
|
+
}
|
|
16
53
|
/**
|
|
17
54
|
* Another player who has been seen on at least one of this player\'s historical connections — i.e. an alt account candidate.
|
|
18
55
|
*/
|
|
@@ -724,6 +761,68 @@ export interface AdminIpSearchResult {
|
|
|
724
761
|
*/
|
|
725
762
|
'players': Array<AdminPlayerSearchResult>;
|
|
726
763
|
}
|
|
764
|
+
/**
|
|
765
|
+
* Configuration metadata for a runnable job (fields + submit path).
|
|
766
|
+
*/
|
|
767
|
+
export interface AdminJobConfig {
|
|
768
|
+
/**
|
|
769
|
+
* JobType name
|
|
770
|
+
*/
|
|
771
|
+
'jobType'?: string;
|
|
772
|
+
/**
|
|
773
|
+
* Display title
|
|
774
|
+
*/
|
|
775
|
+
'title'?: string;
|
|
776
|
+
/**
|
|
777
|
+
* Display description
|
|
778
|
+
*/
|
|
779
|
+
'description'?: string;
|
|
780
|
+
/**
|
|
781
|
+
* Path the filled-in {key:value} body is POSTed to
|
|
782
|
+
*/
|
|
783
|
+
'submitPath'?: string;
|
|
784
|
+
/**
|
|
785
|
+
* Whether running this job requires Administrator rank
|
|
786
|
+
*/
|
|
787
|
+
'requiresAdmin'?: boolean;
|
|
788
|
+
/**
|
|
789
|
+
* Fields to render, in order
|
|
790
|
+
*/
|
|
791
|
+
'fields'?: Array<AdminJobField>;
|
|
792
|
+
}
|
|
793
|
+
/**
|
|
794
|
+
* One configurable field of a runnable job.
|
|
795
|
+
*/
|
|
796
|
+
export interface AdminJobField {
|
|
797
|
+
/**
|
|
798
|
+
* Field key; also the JSON property name submitted to the job\'s endpoint
|
|
799
|
+
*/
|
|
800
|
+
'key'?: string;
|
|
801
|
+
/**
|
|
802
|
+
* Human label for the input
|
|
803
|
+
*/
|
|
804
|
+
'label'?: string;
|
|
805
|
+
/**
|
|
806
|
+
* Input type
|
|
807
|
+
*/
|
|
808
|
+
'type'?: JobFieldType;
|
|
809
|
+
/**
|
|
810
|
+
* Whether the field must be provided
|
|
811
|
+
*/
|
|
812
|
+
'required'?: boolean;
|
|
813
|
+
/**
|
|
814
|
+
* Default value, string form (booleans use \"true\"/\"false\")
|
|
815
|
+
*/
|
|
816
|
+
'defaultValue'?: string | null;
|
|
817
|
+
/**
|
|
818
|
+
* Placeholder text
|
|
819
|
+
*/
|
|
820
|
+
'placeholder'?: string | null;
|
|
821
|
+
/**
|
|
822
|
+
* Optional helper text shown under the input
|
|
823
|
+
*/
|
|
824
|
+
'helpText'?: string | null;
|
|
825
|
+
}
|
|
727
826
|
/**
|
|
728
827
|
* Full player detail including punishment history and all known usernames
|
|
729
828
|
*/
|
|
@@ -1496,6 +1595,16 @@ export declare const GameType: {
|
|
|
1496
1595
|
readonly Classic: "CLASSIC";
|
|
1497
1596
|
};
|
|
1498
1597
|
export type GameType = typeof GameType[keyof typeof GameType];
|
|
1598
|
+
/**
|
|
1599
|
+
* Input type
|
|
1600
|
+
*/
|
|
1601
|
+
export declare const JobFieldType: {
|
|
1602
|
+
readonly Text: "TEXT";
|
|
1603
|
+
readonly Number: "NUMBER";
|
|
1604
|
+
readonly Password: "PASSWORD";
|
|
1605
|
+
readonly Boolean: "BOOLEAN";
|
|
1606
|
+
};
|
|
1607
|
+
export type JobFieldType = typeof JobFieldType[keyof typeof JobFieldType];
|
|
1499
1608
|
/**
|
|
1500
1609
|
* Current lifecycle state.
|
|
1501
1610
|
*/
|
|
@@ -3097,6 +3206,58 @@ export declare class AdminDashboardApi extends BaseAPI {
|
|
|
3097
3206
|
*/
|
|
3098
3207
|
trustDistribution(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminDashboardTrustBucket[], any, {}>>;
|
|
3099
3208
|
}
|
|
3209
|
+
/**
|
|
3210
|
+
* AdminImportApi - axios parameter creator
|
|
3211
|
+
*/
|
|
3212
|
+
export declare const AdminImportApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3213
|
+
/**
|
|
3214
|
+
* Connects to the supplied AdvancedBan MySQL database, reads its active and history punishment tables, and imports each as a Reborn punishment. Idempotent: rows already imported (matched on import_source + the AdvancedBan row id) are skipped, so existing punishments are never overridden. Runs as an async job — poll /admin/job/{id} for progress and the result payload.
|
|
3215
|
+
* @summary Import punishments from an AdvancedBan MySQL database
|
|
3216
|
+
* @param {AdminAdvancedBanImportRequest} adminAdvancedBanImportRequest
|
|
3217
|
+
* @param {*} [options] Override http request option.
|
|
3218
|
+
* @throws {RequiredError}
|
|
3219
|
+
*/
|
|
3220
|
+
importAdvancedBan: (adminAdvancedBanImportRequest: AdminAdvancedBanImportRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3221
|
+
};
|
|
3222
|
+
/**
|
|
3223
|
+
* AdminImportApi - functional programming interface
|
|
3224
|
+
*/
|
|
3225
|
+
export declare const AdminImportApiFp: (configuration?: Configuration) => {
|
|
3226
|
+
/**
|
|
3227
|
+
* Connects to the supplied AdvancedBan MySQL database, reads its active and history punishment tables, and imports each as a Reborn punishment. Idempotent: rows already imported (matched on import_source + the AdvancedBan row id) are skipped, so existing punishments are never overridden. Runs as an async job — poll /admin/job/{id} for progress and the result payload.
|
|
3228
|
+
* @summary Import punishments from an AdvancedBan MySQL database
|
|
3229
|
+
* @param {AdminAdvancedBanImportRequest} adminAdvancedBanImportRequest
|
|
3230
|
+
* @param {*} [options] Override http request option.
|
|
3231
|
+
* @throws {RequiredError}
|
|
3232
|
+
*/
|
|
3233
|
+
importAdvancedBan(adminAdvancedBanImportRequest: AdminAdvancedBanImportRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAsyncJobStartResponse>>;
|
|
3234
|
+
};
|
|
3235
|
+
/**
|
|
3236
|
+
* AdminImportApi - factory interface
|
|
3237
|
+
*/
|
|
3238
|
+
export declare const AdminImportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3239
|
+
/**
|
|
3240
|
+
* Connects to the supplied AdvancedBan MySQL database, reads its active and history punishment tables, and imports each as a Reborn punishment. Idempotent: rows already imported (matched on import_source + the AdvancedBan row id) are skipped, so existing punishments are never overridden. Runs as an async job — poll /admin/job/{id} for progress and the result payload.
|
|
3241
|
+
* @summary Import punishments from an AdvancedBan MySQL database
|
|
3242
|
+
* @param {AdminAdvancedBanImportRequest} adminAdvancedBanImportRequest
|
|
3243
|
+
* @param {*} [options] Override http request option.
|
|
3244
|
+
* @throws {RequiredError}
|
|
3245
|
+
*/
|
|
3246
|
+
importAdvancedBan(adminAdvancedBanImportRequest: AdminAdvancedBanImportRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAsyncJobStartResponse>;
|
|
3247
|
+
};
|
|
3248
|
+
/**
|
|
3249
|
+
* AdminImportApi - object-oriented interface
|
|
3250
|
+
*/
|
|
3251
|
+
export declare class AdminImportApi extends BaseAPI {
|
|
3252
|
+
/**
|
|
3253
|
+
* Connects to the supplied AdvancedBan MySQL database, reads its active and history punishment tables, and imports each as a Reborn punishment. Idempotent: rows already imported (matched on import_source + the AdvancedBan row id) are skipped, so existing punishments are never overridden. Runs as an async job — poll /admin/job/{id} for progress and the result payload.
|
|
3254
|
+
* @summary Import punishments from an AdvancedBan MySQL database
|
|
3255
|
+
* @param {AdminAdvancedBanImportRequest} adminAdvancedBanImportRequest
|
|
3256
|
+
* @param {*} [options] Override http request option.
|
|
3257
|
+
* @throws {RequiredError}
|
|
3258
|
+
*/
|
|
3259
|
+
importAdvancedBan(adminAdvancedBanImportRequest: AdminAdvancedBanImportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAsyncJobStartResponse, any, {}>>;
|
|
3260
|
+
}
|
|
3100
3261
|
/**
|
|
3101
3262
|
* AdminJobsApi - axios parameter creator
|
|
3102
3263
|
*/
|
|
@@ -3109,6 +3270,13 @@ export declare const AdminJobsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3109
3270
|
* @throws {RequiredError}
|
|
3110
3271
|
*/
|
|
3111
3272
|
cancel: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3273
|
+
/**
|
|
3274
|
+
* Metadata for jobs that take configuration: the fields the configure dialog should render and the path to POST the filled values to. Field keys match the target endpoint\'s request body. Paramless jobs are not listed here.
|
|
3275
|
+
* @summary List configurable jobs
|
|
3276
|
+
* @param {*} [options] Override http request option.
|
|
3277
|
+
* @throws {RequiredError}
|
|
3278
|
+
*/
|
|
3279
|
+
config: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3112
3280
|
/**
|
|
3113
3281
|
* Returns the CSV emitted by the job — typically one row per record the job touched. The first line is a header; subsequent lines are RFC-4180 escaped data rows. 404 when the job has no artifact (either it didn\'t emit one, or it hasn\'t finished yet).
|
|
3114
3282
|
* @summary Download a job\'s CSV artifact
|
|
@@ -3147,6 +3315,13 @@ export declare const AdminJobsApiFp: (configuration?: Configuration) => {
|
|
|
3147
3315
|
* @throws {RequiredError}
|
|
3148
3316
|
*/
|
|
3149
3317
|
cancel(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3318
|
+
/**
|
|
3319
|
+
* Metadata for jobs that take configuration: the fields the configure dialog should render and the path to POST the filled values to. Field keys match the target endpoint\'s request body. Paramless jobs are not listed here.
|
|
3320
|
+
* @summary List configurable jobs
|
|
3321
|
+
* @param {*} [options] Override http request option.
|
|
3322
|
+
* @throws {RequiredError}
|
|
3323
|
+
*/
|
|
3324
|
+
config(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AdminJobConfig>>>;
|
|
3150
3325
|
/**
|
|
3151
3326
|
* Returns the CSV emitted by the job — typically one row per record the job touched. The first line is a header; subsequent lines are RFC-4180 escaped data rows. 404 when the job has no artifact (either it didn\'t emit one, or it hasn\'t finished yet).
|
|
3152
3327
|
* @summary Download a job\'s CSV artifact
|
|
@@ -3185,6 +3360,13 @@ export declare const AdminJobsApiFactory: (configuration?: Configuration, basePa
|
|
|
3185
3360
|
* @throws {RequiredError}
|
|
3186
3361
|
*/
|
|
3187
3362
|
cancel(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3363
|
+
/**
|
|
3364
|
+
* Metadata for jobs that take configuration: the fields the configure dialog should render and the path to POST the filled values to. Field keys match the target endpoint\'s request body. Paramless jobs are not listed here.
|
|
3365
|
+
* @summary List configurable jobs
|
|
3366
|
+
* @param {*} [options] Override http request option.
|
|
3367
|
+
* @throws {RequiredError}
|
|
3368
|
+
*/
|
|
3369
|
+
config(options?: RawAxiosRequestConfig): AxiosPromise<Array<AdminJobConfig>>;
|
|
3188
3370
|
/**
|
|
3189
3371
|
* Returns the CSV emitted by the job — typically one row per record the job touched. The first line is a header; subsequent lines are RFC-4180 escaped data rows. 404 when the job has no artifact (either it didn\'t emit one, or it hasn\'t finished yet).
|
|
3190
3372
|
* @summary Download a job\'s CSV artifact
|
|
@@ -3223,6 +3405,13 @@ export declare class AdminJobsApi extends BaseAPI {
|
|
|
3223
3405
|
* @throws {RequiredError}
|
|
3224
3406
|
*/
|
|
3225
3407
|
cancel(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
3408
|
+
/**
|
|
3409
|
+
* Metadata for jobs that take configuration: the fields the configure dialog should render and the path to POST the filled values to. Field keys match the target endpoint\'s request body. Paramless jobs are not listed here.
|
|
3410
|
+
* @summary List configurable jobs
|
|
3411
|
+
* @param {*} [options] Override http request option.
|
|
3412
|
+
* @throws {RequiredError}
|
|
3413
|
+
*/
|
|
3414
|
+
config(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminJobConfig[], any, {}>>;
|
|
3226
3415
|
/**
|
|
3227
3416
|
* Returns the CSV emitted by the job — typically one row per record the job touched. The first line is a header; subsequent lines are RFC-4180 escaped data rows. 404 when the job has no artifact (either it didn\'t emit one, or it hasn\'t finished yet).
|
|
3228
3417
|
* @summary Download a job\'s CSV artifact
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Reborn API
|
|
5
5
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 4.9.
|
|
7
|
+
* The version of the OpenAPI document: 4.9.4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -40,6 +40,15 @@ export const GameType = {
|
|
|
40
40
|
Legacy: 'LEGACY',
|
|
41
41
|
Classic: 'CLASSIC'
|
|
42
42
|
};
|
|
43
|
+
/**
|
|
44
|
+
* Input type
|
|
45
|
+
*/
|
|
46
|
+
export const JobFieldType = {
|
|
47
|
+
Text: 'TEXT',
|
|
48
|
+
Number: 'NUMBER',
|
|
49
|
+
Password: 'PASSWORD',
|
|
50
|
+
Boolean: 'BOOLEAN'
|
|
51
|
+
};
|
|
43
52
|
/**
|
|
44
53
|
* Current lifecycle state.
|
|
45
54
|
*/
|
|
@@ -2140,6 +2149,104 @@ export class AdminDashboardApi extends BaseAPI {
|
|
|
2140
2149
|
return AdminDashboardApiFp(this.configuration).trustDistribution(options).then((request) => request(this.axios, this.basePath));
|
|
2141
2150
|
}
|
|
2142
2151
|
}
|
|
2152
|
+
/**
|
|
2153
|
+
* AdminImportApi - axios parameter creator
|
|
2154
|
+
*/
|
|
2155
|
+
export const AdminImportApiAxiosParamCreator = function (configuration) {
|
|
2156
|
+
return {
|
|
2157
|
+
/**
|
|
2158
|
+
* Connects to the supplied AdvancedBan MySQL database, reads its active and history punishment tables, and imports each as a Reborn punishment. Idempotent: rows already imported (matched on import_source + the AdvancedBan row id) are skipped, so existing punishments are never overridden. Runs as an async job — poll /admin/job/{id} for progress and the result payload.
|
|
2159
|
+
* @summary Import punishments from an AdvancedBan MySQL database
|
|
2160
|
+
* @param {AdminAdvancedBanImportRequest} adminAdvancedBanImportRequest
|
|
2161
|
+
* @param {*} [options] Override http request option.
|
|
2162
|
+
* @throws {RequiredError}
|
|
2163
|
+
*/
|
|
2164
|
+
importAdvancedBan: (adminAdvancedBanImportRequest_1, ...args_1) => __awaiter(this, [adminAdvancedBanImportRequest_1, ...args_1], void 0, function* (adminAdvancedBanImportRequest, options = {}) {
|
|
2165
|
+
// verify required parameter 'adminAdvancedBanImportRequest' is not null or undefined
|
|
2166
|
+
assertParamExists('importAdvancedBan', 'adminAdvancedBanImportRequest', adminAdvancedBanImportRequest);
|
|
2167
|
+
const localVarPath = `/admin/import/advancedban`;
|
|
2168
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2169
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2170
|
+
let baseOptions;
|
|
2171
|
+
if (configuration) {
|
|
2172
|
+
baseOptions = configuration.baseOptions;
|
|
2173
|
+
}
|
|
2174
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
2175
|
+
const localVarHeaderParameter = {};
|
|
2176
|
+
const localVarQueryParameter = {};
|
|
2177
|
+
// authentication DiscordAuth required
|
|
2178
|
+
// http bearer authentication required
|
|
2179
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2180
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2181
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2182
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2183
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2184
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2185
|
+
localVarRequestOptions.data = serializeDataIfNeeded(adminAdvancedBanImportRequest, localVarRequestOptions, configuration);
|
|
2186
|
+
return {
|
|
2187
|
+
url: toPathString(localVarUrlObj),
|
|
2188
|
+
options: localVarRequestOptions,
|
|
2189
|
+
};
|
|
2190
|
+
}),
|
|
2191
|
+
};
|
|
2192
|
+
};
|
|
2193
|
+
/**
|
|
2194
|
+
* AdminImportApi - functional programming interface
|
|
2195
|
+
*/
|
|
2196
|
+
export const AdminImportApiFp = function (configuration) {
|
|
2197
|
+
const localVarAxiosParamCreator = AdminImportApiAxiosParamCreator(configuration);
|
|
2198
|
+
return {
|
|
2199
|
+
/**
|
|
2200
|
+
* Connects to the supplied AdvancedBan MySQL database, reads its active and history punishment tables, and imports each as a Reborn punishment. Idempotent: rows already imported (matched on import_source + the AdvancedBan row id) are skipped, so existing punishments are never overridden. Runs as an async job — poll /admin/job/{id} for progress and the result payload.
|
|
2201
|
+
* @summary Import punishments from an AdvancedBan MySQL database
|
|
2202
|
+
* @param {AdminAdvancedBanImportRequest} adminAdvancedBanImportRequest
|
|
2203
|
+
* @param {*} [options] Override http request option.
|
|
2204
|
+
* @throws {RequiredError}
|
|
2205
|
+
*/
|
|
2206
|
+
importAdvancedBan(adminAdvancedBanImportRequest, options) {
|
|
2207
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2208
|
+
var _a, _b, _c;
|
|
2209
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.importAdvancedBan(adminAdvancedBanImportRequest, options);
|
|
2210
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2211
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AdminImportApi.importAdvancedBan']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2212
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2213
|
+
});
|
|
2214
|
+
},
|
|
2215
|
+
};
|
|
2216
|
+
};
|
|
2217
|
+
/**
|
|
2218
|
+
* AdminImportApi - factory interface
|
|
2219
|
+
*/
|
|
2220
|
+
export const AdminImportApiFactory = function (configuration, basePath, axios) {
|
|
2221
|
+
const localVarFp = AdminImportApiFp(configuration);
|
|
2222
|
+
return {
|
|
2223
|
+
/**
|
|
2224
|
+
* Connects to the supplied AdvancedBan MySQL database, reads its active and history punishment tables, and imports each as a Reborn punishment. Idempotent: rows already imported (matched on import_source + the AdvancedBan row id) are skipped, so existing punishments are never overridden. Runs as an async job — poll /admin/job/{id} for progress and the result payload.
|
|
2225
|
+
* @summary Import punishments from an AdvancedBan MySQL database
|
|
2226
|
+
* @param {AdminAdvancedBanImportRequest} adminAdvancedBanImportRequest
|
|
2227
|
+
* @param {*} [options] Override http request option.
|
|
2228
|
+
* @throws {RequiredError}
|
|
2229
|
+
*/
|
|
2230
|
+
importAdvancedBan(adminAdvancedBanImportRequest, options) {
|
|
2231
|
+
return localVarFp.importAdvancedBan(adminAdvancedBanImportRequest, options).then((request) => request(axios, basePath));
|
|
2232
|
+
},
|
|
2233
|
+
};
|
|
2234
|
+
};
|
|
2235
|
+
/**
|
|
2236
|
+
* AdminImportApi - object-oriented interface
|
|
2237
|
+
*/
|
|
2238
|
+
export class AdminImportApi extends BaseAPI {
|
|
2239
|
+
/**
|
|
2240
|
+
* Connects to the supplied AdvancedBan MySQL database, reads its active and history punishment tables, and imports each as a Reborn punishment. Idempotent: rows already imported (matched on import_source + the AdvancedBan row id) are skipped, so existing punishments are never overridden. Runs as an async job — poll /admin/job/{id} for progress and the result payload.
|
|
2241
|
+
* @summary Import punishments from an AdvancedBan MySQL database
|
|
2242
|
+
* @param {AdminAdvancedBanImportRequest} adminAdvancedBanImportRequest
|
|
2243
|
+
* @param {*} [options] Override http request option.
|
|
2244
|
+
* @throws {RequiredError}
|
|
2245
|
+
*/
|
|
2246
|
+
importAdvancedBan(adminAdvancedBanImportRequest, options) {
|
|
2247
|
+
return AdminImportApiFp(this.configuration).importAdvancedBan(adminAdvancedBanImportRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2248
|
+
}
|
|
2249
|
+
}
|
|
2143
2250
|
/**
|
|
2144
2251
|
* AdminJobsApi - axios parameter creator
|
|
2145
2252
|
*/
|
|
@@ -2177,6 +2284,35 @@ export const AdminJobsApiAxiosParamCreator = function (configuration) {
|
|
|
2177
2284
|
options: localVarRequestOptions,
|
|
2178
2285
|
};
|
|
2179
2286
|
}),
|
|
2287
|
+
/**
|
|
2288
|
+
* Metadata for jobs that take configuration: the fields the configure dialog should render and the path to POST the filled values to. Field keys match the target endpoint\'s request body. Paramless jobs are not listed here.
|
|
2289
|
+
* @summary List configurable jobs
|
|
2290
|
+
* @param {*} [options] Override http request option.
|
|
2291
|
+
* @throws {RequiredError}
|
|
2292
|
+
*/
|
|
2293
|
+
config: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
2294
|
+
const localVarPath = `/admin/job/config`;
|
|
2295
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2296
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2297
|
+
let baseOptions;
|
|
2298
|
+
if (configuration) {
|
|
2299
|
+
baseOptions = configuration.baseOptions;
|
|
2300
|
+
}
|
|
2301
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2302
|
+
const localVarHeaderParameter = {};
|
|
2303
|
+
const localVarQueryParameter = {};
|
|
2304
|
+
// authentication DiscordAuth required
|
|
2305
|
+
// http bearer authentication required
|
|
2306
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2307
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2308
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2309
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2310
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2311
|
+
return {
|
|
2312
|
+
url: toPathString(localVarUrlObj),
|
|
2313
|
+
options: localVarRequestOptions,
|
|
2314
|
+
};
|
|
2315
|
+
}),
|
|
2180
2316
|
/**
|
|
2181
2317
|
* Returns the CSV emitted by the job — typically one row per record the job touched. The first line is a header; subsequent lines are RFC-4180 escaped data rows. 404 when the job has no artifact (either it didn\'t emit one, or it hasn\'t finished yet).
|
|
2182
2318
|
* @summary Download a job\'s CSV artifact
|
|
@@ -2306,6 +2442,21 @@ export const AdminJobsApiFp = function (configuration) {
|
|
|
2306
2442
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2307
2443
|
});
|
|
2308
2444
|
},
|
|
2445
|
+
/**
|
|
2446
|
+
* Metadata for jobs that take configuration: the fields the configure dialog should render and the path to POST the filled values to. Field keys match the target endpoint\'s request body. Paramless jobs are not listed here.
|
|
2447
|
+
* @summary List configurable jobs
|
|
2448
|
+
* @param {*} [options] Override http request option.
|
|
2449
|
+
* @throws {RequiredError}
|
|
2450
|
+
*/
|
|
2451
|
+
config(options) {
|
|
2452
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2453
|
+
var _a, _b, _c;
|
|
2454
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.config(options);
|
|
2455
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2456
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AdminJobsApi.config']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2457
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2458
|
+
});
|
|
2459
|
+
},
|
|
2309
2460
|
/**
|
|
2310
2461
|
* Returns the CSV emitted by the job — typically one row per record the job touched. The first line is a header; subsequent lines are RFC-4180 escaped data rows. 404 when the job has no artifact (either it didn\'t emit one, or it hasn\'t finished yet).
|
|
2311
2462
|
* @summary Download a job\'s CSV artifact
|
|
@@ -2373,6 +2524,15 @@ export const AdminJobsApiFactory = function (configuration, basePath, axios) {
|
|
|
2373
2524
|
cancel(id, options) {
|
|
2374
2525
|
return localVarFp.cancel(id, options).then((request) => request(axios, basePath));
|
|
2375
2526
|
},
|
|
2527
|
+
/**
|
|
2528
|
+
* Metadata for jobs that take configuration: the fields the configure dialog should render and the path to POST the filled values to. Field keys match the target endpoint\'s request body. Paramless jobs are not listed here.
|
|
2529
|
+
* @summary List configurable jobs
|
|
2530
|
+
* @param {*} [options] Override http request option.
|
|
2531
|
+
* @throws {RequiredError}
|
|
2532
|
+
*/
|
|
2533
|
+
config(options) {
|
|
2534
|
+
return localVarFp.config(options).then((request) => request(axios, basePath));
|
|
2535
|
+
},
|
|
2376
2536
|
/**
|
|
2377
2537
|
* Returns the CSV emitted by the job — typically one row per record the job touched. The first line is a header; subsequent lines are RFC-4180 escaped data rows. 404 when the job has no artifact (either it didn\'t emit one, or it hasn\'t finished yet).
|
|
2378
2538
|
* @summary Download a job\'s CSV artifact
|
|
@@ -2420,6 +2580,15 @@ export class AdminJobsApi extends BaseAPI {
|
|
|
2420
2580
|
cancel(id, options) {
|
|
2421
2581
|
return AdminJobsApiFp(this.configuration).cancel(id, options).then((request) => request(this.axios, this.basePath));
|
|
2422
2582
|
}
|
|
2583
|
+
/**
|
|
2584
|
+
* Metadata for jobs that take configuration: the fields the configure dialog should render and the path to POST the filled values to. Field keys match the target endpoint\'s request body. Paramless jobs are not listed here.
|
|
2585
|
+
* @summary List configurable jobs
|
|
2586
|
+
* @param {*} [options] Override http request option.
|
|
2587
|
+
* @throws {RequiredError}
|
|
2588
|
+
*/
|
|
2589
|
+
config(options) {
|
|
2590
|
+
return AdminJobsApiFp(this.configuration).config(options).then((request) => request(this.axios, this.basePath));
|
|
2591
|
+
}
|
|
2423
2592
|
/**
|
|
2424
2593
|
* Returns the CSV emitted by the job — typically one row per record the job touched. The first line is a header; subsequent lines are RFC-4180 escaped data rows. 404 when the job has no artifact (either it didn\'t emit one, or it hasn\'t finished yet).
|
|
2425
2594
|
* @summary Download a job\'s CSV artifact
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
3
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 4.9.
|
|
5
|
+
* The version of the OpenAPI document: 4.9.4
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Reborn API
|
|
5
5
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 4.9.
|
|
7
|
+
* The version of the OpenAPI document: 4.9.4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
3
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 4.9.
|
|
5
|
+
* The version of the OpenAPI document: 4.9.4
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Reborn API
|
|
5
5
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 4.9.
|
|
7
|
+
* The version of the OpenAPI document: 4.9.4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
3
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 4.9.
|
|
5
|
+
* The version of the OpenAPI document: 4.9.4
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Reborn API
|
|
4
4
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 4.9.
|
|
6
|
+
* The version of the OpenAPI document: 4.9.4
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
3
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 4.9.
|
|
5
|
+
* The version of the OpenAPI document: 4.9.4
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Reborn API
|
|
5
5
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 4.9.
|
|
7
|
+
* The version of the OpenAPI document: 4.9.4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
3
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 4.9.
|
|
5
|
+
* The version of the OpenAPI document: 4.9.4
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Reborn API
|
|
6
6
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 4.9.
|
|
8
|
+
* The version of the OpenAPI document: 4.9.4
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# AdminAdvancedBanImportRequest
|
|
2
|
+
|
|
3
|
+
Source AdvancedBan MySQL connection details for a punishment import.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**host** | **string** | MySQL host | [default to undefined]
|
|
10
|
+
**port** | **number** | MySQL port (default 3306) | [optional] [default to undefined]
|
|
11
|
+
**database** | **string** | Database / schema name | [default to undefined]
|
|
12
|
+
**username** | **string** | MySQL username | [default to undefined]
|
|
13
|
+
**password** | **string** | MySQL password | [optional] [default to undefined]
|
|
14
|
+
**activeTable** | **string** | Active punishments table (default \'Punishments\') | [optional] [default to undefined]
|
|
15
|
+
**historyTable** | **string** | History table (default \'PunishmentHistory\') | [optional] [default to undefined]
|
|
16
|
+
**useSsl** | **boolean** | Use TLS for the MySQL connection (default false) | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { AdminAdvancedBanImportRequest } from '@rebornteam/reborn-api';
|
|
22
|
+
|
|
23
|
+
const instance: AdminAdvancedBanImportRequest = {
|
|
24
|
+
host,
|
|
25
|
+
port,
|
|
26
|
+
database,
|
|
27
|
+
username,
|
|
28
|
+
password,
|
|
29
|
+
activeTable,
|
|
30
|
+
historyTable,
|
|
31
|
+
useSsl,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|