@triveria/admin 0.0.0-dev-f2e5999

package/api.d.ts

@@ -0,0 +1,348 @@
+/**
+ * Triveria Admin API
+ * Triveria Admin API allows to manage Wallet API keys and services.
+ *
+ * The version of the OpenAPI document: dev.f2e5999
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from './configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import type { RequestArgs } from './base';
+import { BaseAPI } from './base';
+export declare const AdminRole: {
+    readonly WalletAdminManagerWallet: "wallet:admin:manager:wallet";
+    readonly WalletAdminManagerUser: "wallet:admin:manager:user";
+};
+export type AdminRole = typeof AdminRole[keyof typeof AdminRole];
+/**
+ * Application to access Wallet API
+ */
+export interface Application {
+    'name': string;
+    'id': string;
+    'secret'?: string;
+}
+export interface ApplicationCreateRequest {
+    'name': string;
+}
+/**
+ * Health status of the system
+ */
+export interface HealthStatus {
+    'status': HealthStatusStatusEnum;
+}
+export declare const HealthStatusStatusEnum: {
+    readonly Ok: "ok";
+    readonly Limited: "limited";
+    readonly Critical: "critical";
+};
+export type HealthStatusStatusEnum = typeof HealthStatusStatusEnum[keyof typeof HealthStatusStatusEnum];
+/**
+ * Common error message
+ */
+export interface ModelError {
+    'Message': string;
+}
+/**
+ * Owner details
+ */
+export interface Owner {
+    'id': string;
+    'tenantId': string;
+    'email'?: string;
+    'name'?: string;
+    'organization'?: string;
+    'created'?: string;
+    'updated'?: string;
+    'lastLogin'?: string;
+    'adminRoles'?: Array<AdminRole>;
+    /**
+     * Customer roles without the \"wallet:customer:\" prefix
+     */
+    'customerRoles'?: Array<string>;
+}
+/**
+ * Owner patch payload
+ */
+export interface OwnerPatchPayload {
+    'tenantId'?: string;
+    /**
+     * Admin Roles delimited by the comma character
+     */
+    'adminRoles'?: string;
+}
+/**
+ * Owner details including M2M apps list
+ */
+export interface OwnerWithExtras {
+    'owner': Owner;
+    'apps'?: Array<Application>;
+    /**
+     * Owner user management URL
+     */
+    'url': string;
+}
+/**
+ * DefaultApi - axios parameter creator
+ */
+export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Creates M2M application / client for the authenticated user
+     * @param {ApplicationCreateRequest} [applicationCreateRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applicationCreate: (applicationCreateRequest?: ApplicationCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Deletes specific M2M application
+     * @param {string} applicationId Application ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applicationDelete: (applicationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves M2M application info
+     * @param {string} applicationId Application ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applicationGet: (applicationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Lists applications / clients for the authenticated user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applicationList: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    healthCheck: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ownerGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves owner info by ID including M2M apps list
+     * @param {string} ownerId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ownerGetById: (ownerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} ownerId
+     * @param {OwnerPatchPayload} [ownerPatchPayload]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ownerUpdate: (ownerId: string, ownerPatchPayload?: OwnerPatchPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves owners
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ownersList: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DefaultApi - functional programming interface
+ */
+export declare const DefaultApiFp: (configuration?: Configuration) => {
+    /**
+     * Creates M2M application / client for the authenticated user
+     * @param {ApplicationCreateRequest} [applicationCreateRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applicationCreate(applicationCreateRequest?: ApplicationCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Application>>;
+    /**
+     * Deletes specific M2M application
+     * @param {string} applicationId Application ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applicationDelete(applicationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieves M2M application info
+     * @param {string} applicationId Application ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applicationGet(applicationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Application>>;
+    /**
+     * Lists applications / clients for the authenticated user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applicationList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Application>>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    healthCheck(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HealthStatus>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ownerGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Owner>>;
+    /**
+     * Retrieves owner info by ID including M2M apps list
+     * @param {string} ownerId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ownerGetById(ownerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OwnerWithExtras>>;
+    /**
+     *
+     * @param {string} ownerId
+     * @param {OwnerPatchPayload} [ownerPatchPayload]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ownerUpdate(ownerId: string, ownerPatchPayload?: OwnerPatchPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieves owners
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ownersList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Owner>>>;
+};
+/**
+ * DefaultApi - factory interface
+ */
+export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Creates M2M application / client for the authenticated user
+     * @param {ApplicationCreateRequest} [applicationCreateRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applicationCreate(applicationCreateRequest?: ApplicationCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise<Application>;
+    /**
+     * Deletes specific M2M application
+     * @param {string} applicationId Application ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applicationDelete(applicationId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Retrieves M2M application info
+     * @param {string} applicationId Application ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applicationGet(applicationId: string, options?: RawAxiosRequestConfig): AxiosPromise<Application>;
+    /**
+     * Lists applications / clients for the authenticated user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applicationList(options?: RawAxiosRequestConfig): AxiosPromise<Array<Application>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    healthCheck(options?: RawAxiosRequestConfig): AxiosPromise<HealthStatus>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ownerGet(options?: RawAxiosRequestConfig): AxiosPromise<Owner>;
+    /**
+     * Retrieves owner info by ID including M2M apps list
+     * @param {string} ownerId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ownerGetById(ownerId: string, options?: RawAxiosRequestConfig): AxiosPromise<OwnerWithExtras>;
+    /**
+     *
+     * @param {string} ownerId
+     * @param {OwnerPatchPayload} [ownerPatchPayload]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ownerUpdate(ownerId: string, ownerPatchPayload?: OwnerPatchPayload, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Retrieves owners
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ownersList(options?: RawAxiosRequestConfig): AxiosPromise<Array<Owner>>;
+};
+/**
+ * DefaultApi - object-oriented interface
+ */
+export declare class DefaultApi extends BaseAPI {
+    /**
+     * Creates M2M application / client for the authenticated user
+     * @param {ApplicationCreateRequest} [applicationCreateRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applicationCreate(applicationCreateRequest?: ApplicationCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Application, any>>;
+    /**
+     * Deletes specific M2M application
+     * @param {string} applicationId Application ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applicationDelete(applicationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Retrieves M2M application info
+     * @param {string} applicationId Application ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applicationGet(applicationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Application, any>>;
+    /**
+     * Lists applications / clients for the authenticated user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    applicationList(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Application[], any>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    healthCheck(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HealthStatus, any>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ownerGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Owner, any>>;
+    /**
+     * Retrieves owner info by ID including M2M apps list
+     * @param {string} ownerId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ownerGetById(ownerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OwnerWithExtras, any>>;
+    /**
+     *
+     * @param {string} ownerId
+     * @param {OwnerPatchPayload} [ownerPatchPayload]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ownerUpdate(ownerId: string, ownerPatchPayload?: OwnerPatchPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Retrieves owners
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ownersList(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Owner[], any>>;
+}