@spaciv/sdk 0.0.0 → 0.1.0

package/dist/esm/apis/BrandingApi.d.ts

@@ -0,0 +1,303 @@
+/**
+ * spaciv API
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires.  ## Getting started  1. Exchange credentials for an access token using one of the operations under    **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one    before the old one expires.  ## Conventions  Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for.  Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for.  Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@spaciv.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { Branding } from '../models/index';
+export interface BrandingApiDeleteAccountLogoRequest {
+    type?: BrandingApiDeleteAccountLogoTypeEnum;
+}
+export interface BrandingApiGetRequest {
+    hostname: string;
+}
+export interface BrandingApiGetAccountLogoRequest {
+    type?: BrandingApiGetAccountLogoTypeEnum;
+    id?: number;
+    noFallback?: boolean;
+}
+export interface BrandingApiGetLoginBackgroundRequest {
+    hostname: string;
+    v?: string;
+    ifNoneMatch?: string;
+}
+export interface BrandingApiGetLogoRequest {
+    hostname: string;
+    type?: BrandingApiGetLogoTypeEnum;
+    v?: string;
+    ifNoneMatch?: string;
+}
+export interface BrandingApiUpdateAccountLoginBackgroundRequest {
+    filename?: Blob;
+    name?: string;
+}
+export interface BrandingApiUpdateAccountLogoRequest {
+    filename?: Blob;
+    name?: string;
+}
+/**
+ * BrandingApi - interface
+ *
+ * @export
+ * @interface BrandingApiInterface
+ */
+export interface BrandingApiInterface {
+    /**
+     * Removes the account\'s sign-in page background, so the sign-in page falls back to the default Spaciv background. Requires the *Manage my account* permission.
+     * @summary Delete the sign-in page background
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BrandingApiInterface
+     */
+    deleteAccountLoginBackgroundRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Removes the account\'s sign-in page background, so the sign-in page falls back to the default Spaciv background. Requires the *Manage my account* permission.
+     * Delete the sign-in page background
+     */
+    deleteAccountLoginBackground(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Removes the stored `light` or `dark` logo variant for the account. Requires the *Manage my account* permission.
+     * @summary Delete the account logo
+     * @param {'light' | 'dark'} [type]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BrandingApiInterface
+     */
+    deleteAccountLogoRaw(requestParameters: BrandingApiDeleteAccountLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Removes the stored `light` or `dark` logo variant for the account. Requires the *Manage my account* permission.
+     * Delete the account logo
+     */
+    deleteAccountLogo(requestParameters: BrandingApiDeleteAccountLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns the account name and which branding images exist for the account on a given hostname, so a sign-in page can render the account\'s branding without probing for images. An unknown hostname returns an empty account name and no images. Open to unauthenticated callers.
+     * @summary Get sign-in page branding for a hostname
+     * @param {string} hostname Subdomain the user is signing in on.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BrandingApiInterface
+     */
+    getRaw(requestParameters: BrandingApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Branding>>;
+    /**
+     * Returns the account name and which branding images exist for the account on a given hostname, so a sign-in page can render the account\'s branding without probing for images. An unknown hostname returns an empty account name and no images. Open to unauthenticated callers.
+     * Get sign-in page branding for a hostname
+     */
+    get(requestParameters: BrandingApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Branding>;
+    /**
+     * Returns the raw image bytes of the account\'s sign-in page background, or `404` when none has been uploaded. Requires the *View account overview* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * @summary Get the sign-in page background
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BrandingApiInterface
+     */
+    getAccountLoginBackgroundRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Returns the raw image bytes of the account\'s sign-in page background, or `404` when none has been uploaded. Requires the *View account overview* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get the sign-in page background
+     */
+    getAccountLoginBackground(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Returns the raw image bytes for the account\'s `light` or `dark` logo variant. If the requested variant has no logo and `noFallback` is false, the opposite variant is returned instead. Requires the *View account overview* permission. A variant that a rescan found to match a virus signature is quarantined: it is skipped in favour of the opposite variant unless `noFallback` is true, and returns `403` (`file quarantined: it matched a virus signature`) otherwise.
+     * @summary Get the account logo
+     * @param {'light' | 'dark'} [type] Which logo variant to retrieve. Falls back to the opposite variant unless noFallback is true.
+     * @param {number} [id] Account ID to retrieve the logo for. Only honoured when the caller has the *Manage accounts* permission; otherwise the caller\&#39;s own account is used.
+     * @param {boolean} [noFallback] When true, returns 404 instead of falling back to the opposite variant if the requested type has no logo.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BrandingApiInterface
+     */
+    getAccountLogoRaw(requestParameters: BrandingApiGetAccountLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Returns the raw image bytes for the account\'s `light` or `dark` logo variant. If the requested variant has no logo and `noFallback` is false, the opposite variant is returned instead. Requires the *View account overview* permission. A variant that a rescan found to match a virus signature is quarantined: it is skipped in favour of the opposite variant unless `noFallback` is true, and returns `403` (`file quarantined: it matched a virus signature`) otherwise.
+     * Get the account logo
+     */
+    getAccountLogo(requestParameters: BrandingApiGetAccountLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Returns the raw image bytes of the sign-in page background of the account on a given hostname. Returns `404` when the account has no background or the hostname is unknown. Supports `If-None-Match`. Open to unauthenticated callers. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * @summary Get the sign-in page background for a hostname
+     * @param {string} hostname Subdomain the user is signing in on.
+     * @param {string} [v] The backgroundVersion from GET /v1/branding/:hostname, used only to bust caches.
+     * @param {string} [ifNoneMatch]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BrandingApiInterface
+     */
+    getLoginBackgroundRaw(requestParameters: BrandingApiGetLoginBackgroundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Returns the raw image bytes of the sign-in page background of the account on a given hostname. Returns `404` when the account has no background or the hostname is unknown. Supports `If-None-Match`. Open to unauthenticated callers. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get the sign-in page background for a hostname
+     */
+    getLoginBackground(requestParameters: BrandingApiGetLoginBackgroundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Returns the raw image bytes of the `light` or `dark` logo of the account on a given hostname, falling back to the opposite variant. Returns `404` when the account has no logo or the hostname is unknown. Supports `If-None-Match`. Open to unauthenticated callers. A variant that a rescan found to match a virus signature is quarantined: it is skipped in favour of the opposite variant, and returns `403` (`file quarantined: it matched a virus signature`) otherwise.
+     * @summary Get the account logo for a hostname
+     * @param {string} hostname Subdomain the user is signing in on.
+     * @param {'light' | 'dark'} [type] Which logo variant to retrieve. Falls back to the opposite variant when the requested one has no logo.
+     * @param {string} [v] The logoVersion from GET /v1/branding/:hostname, used only to bust caches.
+     * @param {string} [ifNoneMatch]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BrandingApiInterface
+     */
+    getLogoRaw(requestParameters: BrandingApiGetLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Returns the raw image bytes of the `light` or `dark` logo of the account on a given hostname, falling back to the opposite variant. Returns `404` when the account has no logo or the hostname is unknown. Supports `If-None-Match`. Open to unauthenticated callers. A variant that a rescan found to match a virus signature is quarantined: it is skipped in favour of the opposite variant, and returns `403` (`file quarantined: it matched a virus signature`) otherwise.
+     * Get the account logo for a hostname
+     */
+    getLogo(requestParameters: BrandingApiGetLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Replaces the full-screen background image shown on the account\'s sign-in page. The request must be `multipart/form-data` with a single file field named `login-background`. Accepted MIME types: `image/png`, `image/jpeg`, `image/webp` (detected from file bytes). Maximum file size is 8 MiB. Requires the *Manage my account* permission.
+     * @summary Upload the sign-in page background
+     * @param {Blob} [filename] filename of the file being uploaded
+     * @param {string} [name] general purpose name for multipart form value
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BrandingApiInterface
+     */
+    updateAccountLoginBackgroundRaw(requestParameters: BrandingApiUpdateAccountLoginBackgroundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Replaces the full-screen background image shown on the account\'s sign-in page. The request must be `multipart/form-data` with a single file field named `login-background`. Accepted MIME types: `image/png`, `image/jpeg`, `image/webp` (detected from file bytes). Maximum file size is 8 MiB. Requires the *Manage my account* permission.
+     * Upload the sign-in page background
+     */
+    updateAccountLoginBackground(requestParameters: BrandingApiUpdateAccountLoginBackgroundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Replaces the account\'s logo with the uploaded image. The request must be `multipart/form-data` with a single file field named `logo-dark` or `logo-light`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Maximum file size is 4 MiB. Requires the *Manage my account* permission.
+     * @summary Upload the account logo
+     * @param {Blob} [filename] filename of the file being uploaded
+     * @param {string} [name] general purpose name for multipart form value
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BrandingApiInterface
+     */
+    updateAccountLogoRaw(requestParameters: BrandingApiUpdateAccountLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Replaces the account\'s logo with the uploaded image. The request must be `multipart/form-data` with a single file field named `logo-dark` or `logo-light`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Maximum file size is 4 MiB. Requires the *Manage my account* permission.
+     * Upload the account logo
+     */
+    updateAccountLogo(requestParameters: BrandingApiUpdateAccountLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class BrandingApi extends runtime.BaseAPI implements BrandingApiInterface {
+    /**
+     * Removes the account\'s sign-in page background, so the sign-in page falls back to the default Spaciv background. Requires the *Manage my account* permission.
+     * Delete the sign-in page background
+     */
+    deleteAccountLoginBackgroundRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Removes the account\'s sign-in page background, so the sign-in page falls back to the default Spaciv background. Requires the *Manage my account* permission.
+     * Delete the sign-in page background
+     */
+    deleteAccountLoginBackground(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Removes the stored `light` or `dark` logo variant for the account. Requires the *Manage my account* permission.
+     * Delete the account logo
+     */
+    deleteAccountLogoRaw(requestParameters: BrandingApiDeleteAccountLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Removes the stored `light` or `dark` logo variant for the account. Requires the *Manage my account* permission.
+     * Delete the account logo
+     */
+    deleteAccountLogo(requestParameters?: BrandingApiDeleteAccountLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns the account name and which branding images exist for the account on a given hostname, so a sign-in page can render the account\'s branding without probing for images. An unknown hostname returns an empty account name and no images. Open to unauthenticated callers.
+     * Get sign-in page branding for a hostname
+     */
+    getRaw(requestParameters: BrandingApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Branding>>;
+    /**
+     * Returns the account name and which branding images exist for the account on a given hostname, so a sign-in page can render the account\'s branding without probing for images. An unknown hostname returns an empty account name and no images. Open to unauthenticated callers.
+     * Get sign-in page branding for a hostname
+     */
+    get(requestParameters: BrandingApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Branding>;
+    /**
+     * Returns the raw image bytes of the account\'s sign-in page background, or `404` when none has been uploaded. Requires the *View account overview* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get the sign-in page background
+     */
+    getAccountLoginBackgroundRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Returns the raw image bytes of the account\'s sign-in page background, or `404` when none has been uploaded. Requires the *View account overview* permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get the sign-in page background
+     */
+    getAccountLoginBackground(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Returns the raw image bytes for the account\'s `light` or `dark` logo variant. If the requested variant has no logo and `noFallback` is false, the opposite variant is returned instead. Requires the *View account overview* permission. A variant that a rescan found to match a virus signature is quarantined: it is skipped in favour of the opposite variant unless `noFallback` is true, and returns `403` (`file quarantined: it matched a virus signature`) otherwise.
+     * Get the account logo
+     */
+    getAccountLogoRaw(requestParameters: BrandingApiGetAccountLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Returns the raw image bytes for the account\'s `light` or `dark` logo variant. If the requested variant has no logo and `noFallback` is false, the opposite variant is returned instead. Requires the *View account overview* permission. A variant that a rescan found to match a virus signature is quarantined: it is skipped in favour of the opposite variant unless `noFallback` is true, and returns `403` (`file quarantined: it matched a virus signature`) otherwise.
+     * Get the account logo
+     */
+    getAccountLogo(requestParameters?: BrandingApiGetAccountLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Returns the raw image bytes of the sign-in page background of the account on a given hostname. Returns `404` when the account has no background or the hostname is unknown. Supports `If-None-Match`. Open to unauthenticated callers. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get the sign-in page background for a hostname
+     */
+    getLoginBackgroundRaw(requestParameters: BrandingApiGetLoginBackgroundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Returns the raw image bytes of the sign-in page background of the account on a given hostname. Returns `404` when the account has no background or the hostname is unknown. Supports `If-None-Match`. Open to unauthenticated callers. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get the sign-in page background for a hostname
+     */
+    getLoginBackground(requestParameters: BrandingApiGetLoginBackgroundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Returns the raw image bytes of the `light` or `dark` logo of the account on a given hostname, falling back to the opposite variant. Returns `404` when the account has no logo or the hostname is unknown. Supports `If-None-Match`. Open to unauthenticated callers. A variant that a rescan found to match a virus signature is quarantined: it is skipped in favour of the opposite variant, and returns `403` (`file quarantined: it matched a virus signature`) otherwise.
+     * Get the account logo for a hostname
+     */
+    getLogoRaw(requestParameters: BrandingApiGetLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Returns the raw image bytes of the `light` or `dark` logo of the account on a given hostname, falling back to the opposite variant. Returns `404` when the account has no logo or the hostname is unknown. Supports `If-None-Match`. Open to unauthenticated callers. A variant that a rescan found to match a virus signature is quarantined: it is skipped in favour of the opposite variant, and returns `403` (`file quarantined: it matched a virus signature`) otherwise.
+     * Get the account logo for a hostname
+     */
+    getLogo(requestParameters: BrandingApiGetLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Replaces the full-screen background image shown on the account\'s sign-in page. The request must be `multipart/form-data` with a single file field named `login-background`. Accepted MIME types: `image/png`, `image/jpeg`, `image/webp` (detected from file bytes). Maximum file size is 8 MiB. Requires the *Manage my account* permission.
+     * Upload the sign-in page background
+     */
+    updateAccountLoginBackgroundRaw(requestParameters: BrandingApiUpdateAccountLoginBackgroundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Replaces the full-screen background image shown on the account\'s sign-in page. The request must be `multipart/form-data` with a single file field named `login-background`. Accepted MIME types: `image/png`, `image/jpeg`, `image/webp` (detected from file bytes). Maximum file size is 8 MiB. Requires the *Manage my account* permission.
+     * Upload the sign-in page background
+     */
+    updateAccountLoginBackground(requestParameters?: BrandingApiUpdateAccountLoginBackgroundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Replaces the account\'s logo with the uploaded image. The request must be `multipart/form-data` with a single file field named `logo-dark` or `logo-light`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Maximum file size is 4 MiB. Requires the *Manage my account* permission.
+     * Upload the account logo
+     */
+    updateAccountLogoRaw(requestParameters: BrandingApiUpdateAccountLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Replaces the account\'s logo with the uploaded image. The request must be `multipart/form-data` with a single file field named `logo-dark` or `logo-light`. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Maximum file size is 4 MiB. Requires the *Manage my account* permission.
+     * Upload the account logo
+     */
+    updateAccountLogo(requestParameters?: BrandingApiUpdateAccountLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ * @export
+ */
+export declare const BrandingApiDeleteAccountLogoTypeEnum: {
+    readonly Light: "light";
+    readonly Dark: "dark";
+};
+export type BrandingApiDeleteAccountLogoTypeEnum = typeof BrandingApiDeleteAccountLogoTypeEnum[keyof typeof BrandingApiDeleteAccountLogoTypeEnum];
+/**
+ * @export
+ */
+export declare const BrandingApiGetAccountLogoTypeEnum: {
+    readonly Light: "light";
+    readonly Dark: "dark";
+};
+export type BrandingApiGetAccountLogoTypeEnum = typeof BrandingApiGetAccountLogoTypeEnum[keyof typeof BrandingApiGetAccountLogoTypeEnum];
+/**
+ * @export
+ */
+export declare const BrandingApiGetLogoTypeEnum: {
+    readonly Light: "light";
+    readonly Dark: "dark";
+};
+export type BrandingApiGetLogoTypeEnum = typeof BrandingApiGetLogoTypeEnum[keyof typeof BrandingApiGetLogoTypeEnum];