@halo-dev/api-client 2.20.0 → 2.21.0

package/dist/src/models/subject.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,19 +16,19 @@
  */
 export interface Subject {
     /**
-     *
+     * APIGroup holds the API group of the referenced subject.  Defaults to \"\" for ServiceAccount subjects.  Defaults to \"rbac.authorization.halo.run\" for User and Group subjects.
      * @type {string}
      * @memberof Subject
      */
     'apiGroup'?: string;
     /**
-     *
+     * Kind of object being referenced. Values defined by this API group are \"User\", \"Group\",  and \"ServiceAccount\".  If the Authorizer does not recognize the kind value, the Authorizer should report  an error.
      * @type {string}
      * @memberof Subject
      */
     'kind'?: string;
     /**
-     *
+     * Name of the object being referenced.
      * @type {string}
      * @memberof Subject
      */

package/dist/src/models/subscription-subscriber.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/subscription.d.ts

@@ -1,7 +1,7 @@
 import { Metadata } from './metadata';
 import { SubscriptionSpec } from './subscription-spec';
 /**
- *
+ * <p>{@link Subscription Subscription} is a custom extension that defines a subscriber to be notified when a  certain {@link Reason Reason} is triggered.</p>  <p>It holds a {@link Subscriber Subscriber} to the user to be notified, a {@link InterestReason InterestReason} to  subscribe to.</p>
  * @export
  * @interface Subscription
  */

package/dist/src/models/tag-spec.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,7 +16,7 @@
  */
 export interface TagSpec {
     /**
-     *
+     * Color regex explanation.  <pre>  ^                 # start of the line  #                 # start with a number sign `#`  (                 # start of (group 1)    [a-fA-F0-9]{6}  # support z-f, A-F and 0-9, with a length of 6    |               # or    [a-fA-F0-9]{3}  # support z-f, A-F and 0-9, with a length of 3  )                 # end of (group 1)  $                 # end of the line  </pre>
      * @type {string}
      * @memberof TagSpec
      */

package/dist/src/models/tag-status.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/tag-vo.d.ts

@@ -2,7 +2,7 @@ import { Metadata } from './metadata';
 import { TagSpec } from './tag-spec';
 import { TagStatus } from './tag-status';
 /**
- *
+ * A value object for {@link Tag Tag}.
  * @export
  * @interface TagVo
  */

package/dist/src/models/template-content.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/template-descriptor.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * Type used to describe custom template page.
  * @export
  * @interface TemplateDescriptor
  */

package/dist/src/models/test-operation.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/theme-spec.d.ts

@@ -67,13 +67,6 @@ export interface ThemeSpec {
      * @memberof ThemeSpec
      */
     'repo'?: string;
-    /**
-     * Deprecated, use `requires` instead.
-     * @type {string}
-     * @memberof ThemeSpec
-     * @deprecated
-     */
-    'require'?: string;
     /**
      *
      * @type {string}
@@ -91,12 +84,5 @@ export interface ThemeSpec {
      * @type {string}
      * @memberof ThemeSpec
      */
-    'version': string;
-    /**
-     *
-     * @type {string}
-     * @memberof ThemeSpec
-     * @deprecated
-     */
-    'website'?: string;
+    'version'?: string;
 }

package/dist/src/models/theme.d.ts

@@ -2,7 +2,7 @@ import { Metadata } from './metadata';
 import { ThemeSpec } from './theme-spec';
 import { ThemeStatus } from './theme-status';
 /**
- *
+ * <p>Theme extension.</p>
  * @export
  * @interface Theme
  */

package/dist/src/models/thumbnail-spec.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/totp-auth-link-response.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,7 +16,7 @@
  */
 export interface TotpAuthLinkResponse {
     /**
-     *
+     * QR Code with base64 encoded.
      * @type {string}
      * @memberof TotpAuthLinkResponse
      */

package/dist/src/models/totp-request.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/two-factor-auth-settings.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,7 +16,7 @@
  */
 export interface TwoFactorAuthSettings {
     /**
-     *
+     * Check if 2FA is available.
      * @type {boolean}
      * @memberof TwoFactorAuthSettings
      */

package/dist/src/models/uc-upload-request-form-data.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/upgrade-from-uri-request.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/upload-from-url-request.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/user-connection-spec.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,25 +16,25 @@
  */
 export interface UserConnectionSpec {
     /**
-     *
+     * The unique identifier for the user\'s connection to the OAuth provider.  for example, the user\'s GitHub id.
      * @type {string}
      * @memberof UserConnectionSpec
      */
     'providerUserId': string;
     /**
-     *
+     * The name of the OAuth provider (e.g. Google, Facebook, Twitter).
      * @type {string}
      * @memberof UserConnectionSpec
      */
     'registrationId': string;
     /**
-     *
+     * The time when the user connection was last updated.
      * @type {string}
      * @memberof UserConnectionSpec
      */
     'updatedAt'?: string;
     /**
-     *
+     * The {@link Metadata#getName Metadata#getName()} of the user associated with the OAuth connection.
      * @type {string}
      * @memberof UserConnectionSpec
      */

package/dist/src/models/user-connection.d.ts

@@ -1,7 +1,7 @@
 import { Metadata } from './metadata';
 import { UserConnectionSpec } from './user-connection-spec';
 /**
- *
+ * User connection extension.
  * @export
  * @interface UserConnection
  */

package/dist/src/models/user-spec.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/user.d.ts

@@ -2,7 +2,7 @@ import { Metadata } from './metadata';
 import { UserSpec } from './user-spec';
 import { UserStatus } from './user-status';
 /**
- *
+ * The extension represents user details of Halo.
  * @export
  * @interface User
  */

package/dist/src/models/verify-code-request.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/vote-request.d.ts

@@ -2,7 +2,7 @@
  * Halo
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.20.0-SNAPSHOT
+ * The version of the OpenAPI document: 2.21.0-SNAPSHOT
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@halo-dev/api-client",
-  "version": "2.20.0",
+  "version": "2.21.0",
   "description": "API Client for Halo 2",
   "homepage": "https://github.com/halo-dev/halo/tree/main/ui/packages/api-client#readme",
   "bugs": {

package/dist/src/api/api-notification-halo-run-v1alpha1-subscription-api.d.ts

@@ -1,79 +0,0 @@
-import { Configuration } from '../configuration';
-import { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
-import { RequestArgs, BaseAPI } from '../base';
-/**
- * ApiNotificationHaloRunV1alpha1SubscriptionApi - axios parameter creator
- * @export
- */
-export declare const ApiNotificationHaloRunV1alpha1SubscriptionApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     * Unsubscribe a subscription
-     * @param {string} name Subscription name
-     * @param {string} token Unsubscribe token
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    unsubscribe: (name: string, token: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * ApiNotificationHaloRunV1alpha1SubscriptionApi - functional programming interface
- * @export
- */
-export declare const ApiNotificationHaloRunV1alpha1SubscriptionApiFp: (configuration?: Configuration) => {
-    /**
-     * Unsubscribe a subscription
-     * @param {string} name Subscription name
-     * @param {string} token Unsubscribe token
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    unsubscribe(name: string, token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
-};
-/**
- * ApiNotificationHaloRunV1alpha1SubscriptionApi - factory interface
- * @export
- */
-export declare const ApiNotificationHaloRunV1alpha1SubscriptionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     * Unsubscribe a subscription
-     * @param {ApiNotificationHaloRunV1alpha1SubscriptionApiUnsubscribeRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    unsubscribe(requestParameters: ApiNotificationHaloRunV1alpha1SubscriptionApiUnsubscribeRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
-};
-/**
- * Request parameters for unsubscribe operation in ApiNotificationHaloRunV1alpha1SubscriptionApi.
- * @export
- * @interface ApiNotificationHaloRunV1alpha1SubscriptionApiUnsubscribeRequest
- */
-export interface ApiNotificationHaloRunV1alpha1SubscriptionApiUnsubscribeRequest {
-    /**
-     * Subscription name
-     * @type {string}
-     * @memberof ApiNotificationHaloRunV1alpha1SubscriptionApiUnsubscribe
-     */
-    readonly name: string;
-    /**
-     * Unsubscribe token
-     * @type {string}
-     * @memberof ApiNotificationHaloRunV1alpha1SubscriptionApiUnsubscribe
-     */
-    readonly token: string;
-}
-/**
- * ApiNotificationHaloRunV1alpha1SubscriptionApi - object-oriented interface
- * @export
- * @class ApiNotificationHaloRunV1alpha1SubscriptionApi
- * @extends {BaseAPI}
- */
-export declare class ApiNotificationHaloRunV1alpha1SubscriptionApi extends BaseAPI {
-    /**
-     * Unsubscribe a subscription
-     * @param {ApiNotificationHaloRunV1alpha1SubscriptionApiUnsubscribeRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof ApiNotificationHaloRunV1alpha1SubscriptionApi
-     */
-    unsubscribe(requestParameters: ApiNotificationHaloRunV1alpha1SubscriptionApiUnsubscribeRequest, options?: RawAxiosRequestConfig): Promise<import('axios').AxiosResponse<string, any>>;
-}