@takaro/apiclient 0.0.0-dev.8a7d47e → 0.0.0-dev.8abe2d5

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.
@@ -7196,6 +7196,32 @@ export interface LoginOutputDTOAPI {
7196
7196
  */
7197
7197
  meta: MetadataOutput;
7198
7198
  }
7199
+ /**
7200
+ *
7201
+ * @export
7202
+ * @interface LoginQueryParams
7203
+ */
7204
+ export interface LoginQueryParams {
7205
+ /**
7206
+ *
7207
+ * @type {string}
7208
+ * @memberof LoginQueryParams
7209
+ */
7210
+ redirect?: string;
7211
+ }
7212
+ /**
7213
+ *
7214
+ * @export
7215
+ * @interface LogoutQueryParams
7216
+ */
7217
+ export interface LogoutQueryParams {
7218
+ /**
7219
+ *
7220
+ * @type {string}
7221
+ * @memberof LogoutQueryParams
7222
+ */
7223
+ redirect?: string;
7224
+ }
7199
7225
  /**
7200
7226
  *
7201
7227
  * @export
@@ -7819,6 +7845,94 @@ export interface ModuleInstallParamId {
7819
7845
  */
7820
7846
  gameServerId: string;
7821
7847
  }
7848
+ /**
7849
+ *
7850
+ * @export
7851
+ * @interface ModuleInstallationKpisDTO
7852
+ */
7853
+ export interface ModuleInstallationKpisDTO {
7854
+ /**
7855
+ *
7856
+ * @type {number}
7857
+ * @memberof ModuleInstallationKpisDTO
7858
+ */
7859
+ runs: number;
7860
+ /**
7861
+ *
7862
+ * @type {number}
7863
+ * @memberof ModuleInstallationKpisDTO
7864
+ */
7865
+ failures: number;
7866
+ /**
7867
+ *
7868
+ * @type {number}
7869
+ * @memberof ModuleInstallationKpisDTO
7870
+ */
7871
+ successRate: number;
7872
+ }
7873
+ /**
7874
+ *
7875
+ * @export
7876
+ * @interface ModuleInstallationKpisDTOAPI
7877
+ */
7878
+ export interface ModuleInstallationKpisDTOAPI {
7879
+ /**
7880
+ *
7881
+ * @type {ModuleInstallationKpisDTO}
7882
+ * @memberof ModuleInstallationKpisDTOAPI
7883
+ */
7884
+ data: ModuleInstallationKpisDTO;
7885
+ /**
7886
+ *
7887
+ * @type {MetadataOutput}
7888
+ * @memberof ModuleInstallationKpisDTOAPI
7889
+ */
7890
+ meta: MetadataOutput;
7891
+ }
7892
+ /**
7893
+ *
7894
+ * @export
7895
+ * @interface ModuleInstallationKpisQueryDTO
7896
+ */
7897
+ export interface ModuleInstallationKpisQueryDTO {
7898
+ /**
7899
+ *
7900
+ * @type {string}
7901
+ * @memberof ModuleInstallationKpisQueryDTO
7902
+ */
7903
+ startDate?: string;
7904
+ /**
7905
+ *
7906
+ * @type {string}
7907
+ * @memberof ModuleInstallationKpisQueryDTO
7908
+ */
7909
+ endDate?: string;
7910
+ /**
7911
+ *
7912
+ * @type {string}
7913
+ * @memberof ModuleInstallationKpisQueryDTO
7914
+ */
7915
+ gameServerId: string;
7916
+ /**
7917
+ *
7918
+ * @type {string}
7919
+ * @memberof ModuleInstallationKpisQueryDTO
7920
+ */
7921
+ moduleId: string;
7922
+ /**
7923
+ *
7924
+ * @type {string}
7925
+ * @memberof ModuleInstallationKpisQueryDTO
7926
+ */
7927
+ period?: ModuleInstallationKpisQueryDTOPeriodEnum;
7928
+ }
7929
+ export declare const ModuleInstallationKpisQueryDTOPeriodEnum: {
7930
+ readonly _24h: "24h";
7931
+ readonly _7d: "7d";
7932
+ readonly _30d: "30d";
7933
+ readonly _90d: "90d";
7934
+ };
7935
+ export type ModuleInstallationKpisQueryDTOPeriodEnum = (typeof ModuleInstallationKpisQueryDTOPeriodEnum)[keyof typeof ModuleInstallationKpisQueryDTOPeriodEnum];
7822
7936
  /**
7823
7937
  *
7824
7938
  * @export
@@ -17313,6 +17427,18 @@ export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configurati
17313
17427
  * @throws {RequiredError}
17314
17428
  */
17315
17429
  analyticsControllerGetModuleHealth: (startDate?: string, endDate?: string, gameServerId?: string, period?: AnalyticsControllerGetModuleHealthPeriodEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
17430
+ /**
17431
+ * Runs, failures and success rate for one module on one game server. Both gameServerId and moduleId are required. Required permissions: `READ_EVENTS`<br> OperationId: `AnalyticsControllerGetModuleInstallationKpis`
17432
+ * @summary Get per-installation module KPIs
17433
+ * @param {string} gameServerId
17434
+ * @param {string} moduleId
17435
+ * @param {string} [startDate]
17436
+ * @param {string} [endDate]
17437
+ * @param {AnalyticsControllerGetModuleInstallationKpisPeriodEnum} [period]
17438
+ * @param {*} [options] Override http request option.
17439
+ * @throws {RequiredError}
17440
+ */
17441
+ analyticsControllerGetModuleInstallationKpis: (gameServerId: string, moduleId: string, startDate?: string, endDate?: string, period?: AnalyticsControllerGetModuleInstallationKpisPeriodEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
17316
17442
  /**
17317
17443
  * Unified failure leaderboard across all module-item types (hooks, crons, commands, shop actions). Each row carries a `type` discriminator alongside runs, failures, and failure rate. Required permissions: `READ_EVENTS`<br> OperationId: `AnalyticsControllerGetModuleItemFailureLeaderboard`
17318
17444
  * @summary Get module item failure aggregate
@@ -17690,6 +17816,18 @@ export declare const AnalyticsApiFp: (configuration?: Configuration) => {
17690
17816
  * @throws {RequiredError}
17691
17817
  */
17692
17818
  analyticsControllerGetModuleHealth(startDate?: string, endDate?: string, gameServerId?: string, period?: AnalyticsControllerGetModuleHealthPeriodEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModuleHealthEntryDTOAPI>>;
17819
+ /**
17820
+ * Runs, failures and success rate for one module on one game server. Both gameServerId and moduleId are required. Required permissions: `READ_EVENTS`<br> OperationId: `AnalyticsControllerGetModuleInstallationKpis`
17821
+ * @summary Get per-installation module KPIs
17822
+ * @param {string} gameServerId
17823
+ * @param {string} moduleId
17824
+ * @param {string} [startDate]
17825
+ * @param {string} [endDate]
17826
+ * @param {AnalyticsControllerGetModuleInstallationKpisPeriodEnum} [period]
17827
+ * @param {*} [options] Override http request option.
17828
+ * @throws {RequiredError}
17829
+ */
17830
+ analyticsControllerGetModuleInstallationKpis(gameServerId: string, moduleId: string, startDate?: string, endDate?: string, period?: AnalyticsControllerGetModuleInstallationKpisPeriodEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModuleInstallationKpisDTOAPI>>;
17693
17831
  /**
17694
17832
  * Unified failure leaderboard across all module-item types (hooks, crons, commands, shop actions). Each row carries a `type` discriminator alongside runs, failures, and failure rate. Required permissions: `READ_EVENTS`<br> OperationId: `AnalyticsControllerGetModuleItemFailureLeaderboard`
17695
17833
  * @summary Get module item failure aggregate
@@ -18067,6 +18205,18 @@ export declare const AnalyticsApiFactory: (configuration?: Configuration, basePa
18067
18205
  * @throws {RequiredError}
18068
18206
  */
18069
18207
  analyticsControllerGetModuleHealth(startDate?: string, endDate?: string, gameServerId?: string, period?: AnalyticsControllerGetModuleHealthPeriodEnum, options?: RawAxiosRequestConfig): AxiosPromise<ModuleHealthEntryDTOAPI>;
18208
+ /**
18209
+ * Runs, failures and success rate for one module on one game server. Both gameServerId and moduleId are required. Required permissions: `READ_EVENTS`<br> OperationId: `AnalyticsControllerGetModuleInstallationKpis`
18210
+ * @summary Get per-installation module KPIs
18211
+ * @param {string} gameServerId
18212
+ * @param {string} moduleId
18213
+ * @param {string} [startDate]
18214
+ * @param {string} [endDate]
18215
+ * @param {AnalyticsControllerGetModuleInstallationKpisPeriodEnum} [period]
18216
+ * @param {*} [options] Override http request option.
18217
+ * @throws {RequiredError}
18218
+ */
18219
+ analyticsControllerGetModuleInstallationKpis(gameServerId: string, moduleId: string, startDate?: string, endDate?: string, period?: AnalyticsControllerGetModuleInstallationKpisPeriodEnum, options?: RawAxiosRequestConfig): AxiosPromise<ModuleInstallationKpisDTOAPI>;
18070
18220
  /**
18071
18221
  * Unified failure leaderboard across all module-item types (hooks, crons, commands, shop actions). Each row carries a `type` discriminator alongside runs, failures, and failure rate. Required permissions: `READ_EVENTS`<br> OperationId: `AnalyticsControllerGetModuleItemFailureLeaderboard`
18072
18222
  * @summary Get module item failure aggregate
@@ -18459,6 +18609,19 @@ export declare class AnalyticsApi extends BaseAPI {
18459
18609
  * @memberof AnalyticsApi
18460
18610
  */
18461
18611
  analyticsControllerGetModuleHealth(startDate?: string, endDate?: string, gameServerId?: string, period?: AnalyticsControllerGetModuleHealthPeriodEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ModuleHealthEntryDTOAPI, any>>;
18612
+ /**
18613
+ * Runs, failures and success rate for one module on one game server. Both gameServerId and moduleId are required. Required permissions: `READ_EVENTS`<br> OperationId: `AnalyticsControllerGetModuleInstallationKpis`
18614
+ * @summary Get per-installation module KPIs
18615
+ * @param {string} gameServerId
18616
+ * @param {string} moduleId
18617
+ * @param {string} [startDate]
18618
+ * @param {string} [endDate]
18619
+ * @param {AnalyticsControllerGetModuleInstallationKpisPeriodEnum} [period]
18620
+ * @param {*} [options] Override http request option.
18621
+ * @throws {RequiredError}
18622
+ * @memberof AnalyticsApi
18623
+ */
18624
+ analyticsControllerGetModuleInstallationKpis(gameServerId: string, moduleId: string, startDate?: string, endDate?: string, period?: AnalyticsControllerGetModuleInstallationKpisPeriodEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ModuleInstallationKpisDTOAPI, any>>;
18462
18625
  /**
18463
18626
  * Unified failure leaderboard across all module-item types (hooks, crons, commands, shop actions). Each row carries a `type` discriminator alongside runs, failures, and failure rate. Required permissions: `READ_EVENTS`<br> OperationId: `AnalyticsControllerGetModuleItemFailureLeaderboard`
18464
18627
  * @summary Get module item failure aggregate
@@ -18832,6 +18995,16 @@ export declare const AnalyticsControllerGetModuleHealthPeriodEnum: {
18832
18995
  readonly _90d: "90d";
18833
18996
  };
18834
18997
  export type AnalyticsControllerGetModuleHealthPeriodEnum = (typeof AnalyticsControllerGetModuleHealthPeriodEnum)[keyof typeof AnalyticsControllerGetModuleHealthPeriodEnum];
18998
+ /**
18999
+ * @export
19000
+ */
19001
+ export declare const AnalyticsControllerGetModuleInstallationKpisPeriodEnum: {
19002
+ readonly _24h: "24h";
19003
+ readonly _7d: "7d";
19004
+ readonly _30d: "30d";
19005
+ readonly _90d: "90d";
19006
+ };
19007
+ export type AnalyticsControllerGetModuleInstallationKpisPeriodEnum = (typeof AnalyticsControllerGetModuleInstallationKpisPeriodEnum)[keyof typeof AnalyticsControllerGetModuleInstallationKpisPeriodEnum];
18835
19008
  /**
18836
19009
  * @export
18837
19010
  */
@@ -19042,6 +19215,156 @@ export declare const AnalyticsControllerGetTopServersPeriodEnum: {
19042
19215
  readonly _90d: "90d";
19043
19216
  };
19044
19217
  export type AnalyticsControllerGetTopServersPeriodEnum = (typeof AnalyticsControllerGetTopServersPeriodEnum)[keyof typeof AnalyticsControllerGetTopServersPeriodEnum];
19218
+ /**
19219
+ * AuthApi - axios parameter creator
19220
+ * @export
19221
+ */
19222
+ export declare const AuthApiAxiosParamCreator: (configuration?: Configuration) => {
19223
+ /**
19224
+ * <br> OperationId: `AuthControllerAccount`
19225
+ * @summary Account
19226
+ * @param {*} [options] Override http request option.
19227
+ * @throws {RequiredError}
19228
+ */
19229
+ authControllerAccount: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19230
+ /**
19231
+ * <br> OperationId: `AuthControllerCallback`
19232
+ * @summary Callback
19233
+ * @param {*} [options] Override http request option.
19234
+ * @throws {RequiredError}
19235
+ */
19236
+ authControllerCallback: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19237
+ /**
19238
+ * <br> OperationId: `AuthControllerLogin`
19239
+ * @summary Login
19240
+ * @param {string} [redirect]
19241
+ * @param {*} [options] Override http request option.
19242
+ * @throws {RequiredError}
19243
+ */
19244
+ authControllerLogin: (redirect?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19245
+ /**
19246
+ * <br> OperationId: `AuthControllerLogout`
19247
+ * @summary Logout
19248
+ * @param {string} [redirect]
19249
+ * @param {*} [options] Override http request option.
19250
+ * @throws {RequiredError}
19251
+ */
19252
+ authControllerLogout: (redirect?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19253
+ };
19254
+ /**
19255
+ * AuthApi - functional programming interface
19256
+ * @export
19257
+ */
19258
+ export declare const AuthApiFp: (configuration?: Configuration) => {
19259
+ /**
19260
+ * <br> OperationId: `AuthControllerAccount`
19261
+ * @summary Account
19262
+ * @param {*} [options] Override http request option.
19263
+ * @throws {RequiredError}
19264
+ */
19265
+ authControllerAccount(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
19266
+ /**
19267
+ * <br> OperationId: `AuthControllerCallback`
19268
+ * @summary Callback
19269
+ * @param {*} [options] Override http request option.
19270
+ * @throws {RequiredError}
19271
+ */
19272
+ authControllerCallback(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
19273
+ /**
19274
+ * <br> OperationId: `AuthControllerLogin`
19275
+ * @summary Login
19276
+ * @param {string} [redirect]
19277
+ * @param {*} [options] Override http request option.
19278
+ * @throws {RequiredError}
19279
+ */
19280
+ authControllerLogin(redirect?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
19281
+ /**
19282
+ * <br> OperationId: `AuthControllerLogout`
19283
+ * @summary Logout
19284
+ * @param {string} [redirect]
19285
+ * @param {*} [options] Override http request option.
19286
+ * @throws {RequiredError}
19287
+ */
19288
+ authControllerLogout(redirect?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
19289
+ };
19290
+ /**
19291
+ * AuthApi - factory interface
19292
+ * @export
19293
+ */
19294
+ export declare const AuthApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
19295
+ /**
19296
+ * <br> OperationId: `AuthControllerAccount`
19297
+ * @summary Account
19298
+ * @param {*} [options] Override http request option.
19299
+ * @throws {RequiredError}
19300
+ */
19301
+ authControllerAccount(options?: RawAxiosRequestConfig): AxiosPromise<void>;
19302
+ /**
19303
+ * <br> OperationId: `AuthControllerCallback`
19304
+ * @summary Callback
19305
+ * @param {*} [options] Override http request option.
19306
+ * @throws {RequiredError}
19307
+ */
19308
+ authControllerCallback(options?: RawAxiosRequestConfig): AxiosPromise<void>;
19309
+ /**
19310
+ * <br> OperationId: `AuthControllerLogin`
19311
+ * @summary Login
19312
+ * @param {string} [redirect]
19313
+ * @param {*} [options] Override http request option.
19314
+ * @throws {RequiredError}
19315
+ */
19316
+ authControllerLogin(redirect?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
19317
+ /**
19318
+ * <br> OperationId: `AuthControllerLogout`
19319
+ * @summary Logout
19320
+ * @param {string} [redirect]
19321
+ * @param {*} [options] Override http request option.
19322
+ * @throws {RequiredError}
19323
+ */
19324
+ authControllerLogout(redirect?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
19325
+ };
19326
+ /**
19327
+ * AuthApi - object-oriented interface
19328
+ * @export
19329
+ * @class AuthApi
19330
+ * @extends {BaseAPI}
19331
+ */
19332
+ export declare class AuthApi extends BaseAPI {
19333
+ /**
19334
+ * <br> OperationId: `AuthControllerAccount`
19335
+ * @summary Account
19336
+ * @param {*} [options] Override http request option.
19337
+ * @throws {RequiredError}
19338
+ * @memberof AuthApi
19339
+ */
19340
+ authControllerAccount(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
19341
+ /**
19342
+ * <br> OperationId: `AuthControllerCallback`
19343
+ * @summary Callback
19344
+ * @param {*} [options] Override http request option.
19345
+ * @throws {RequiredError}
19346
+ * @memberof AuthApi
19347
+ */
19348
+ authControllerCallback(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
19349
+ /**
19350
+ * <br> OperationId: `AuthControllerLogin`
19351
+ * @summary Login
19352
+ * @param {string} [redirect]
19353
+ * @param {*} [options] Override http request option.
19354
+ * @throws {RequiredError}
19355
+ * @memberof AuthApi
19356
+ */
19357
+ authControllerLogin(redirect?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
19358
+ /**
19359
+ * <br> OperationId: `AuthControllerLogout`
19360
+ * @summary Logout
19361
+ * @param {string} [redirect]
19362
+ * @param {*} [options] Override http request option.
19363
+ * @throws {RequiredError}
19364
+ * @memberof AuthApi
19365
+ */
19366
+ authControllerLogout(redirect?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
19367
+ }
19045
19368
  /**
19046
19369
  * CommandApi - axios parameter creator
19047
19370
  * @export