@snokam/platform-client 1.0.0

package/dist/models/index.js

@@ -0,0 +1,339 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SlugSanityTypeEnum = exports.SanityTvCategoryDashboardsInnerBackgroundImageAssetSanityTypeEnum = exports.SanityTvCategoryDashboardsInnerBackgroundImageSanityTypeEnum = exports.SanityTechnologyWithRelationsProjectsInnerTechnologiesInnerSanityTypeEnum = exports.SanityTechnologyWithRelationsEmployeesInnerTagsInnerSanityTypeEnum = exports.SanityTechnologyWithRelationsArticlesInnerMediaOneOfSanityTypeEnum = exports.SanitySystemsInnerDescriptionInnerStyleEnum = exports.SanitySystemsInnerDescriptionInnerSanityTypeEnum = exports.SanitySystemsInnerDescriptionInnerListItemEnum = exports.SanityPatchPageMetaImageSanityTypeEnum = exports.SanityImageHotspotSanityTypeEnum = exports.SanityImageCropSanityTypeEnum = exports.SanityImageAssetReferenceSanityTypeEnum = exports.SanityEmployeeSettingsColorSchemeEnum = exports.SanityEmployeeSalaryConfigModelEnum = exports.SanityEmployeeNextOfKinInnerSanityTypeEnum = exports.SanityEmployeeManagerSanityTypeEnum = exports.SanityEmployeeGroupsInnerSanityTypeEnum = exports.SanityEmployeeEquipmentInnerSanityTypeEnum = exports.SanityEmployeeCommissionTierSanityTypeEnum = exports.SanityEmployeeCliftonStrengthsInnerSanityTypeEnum = exports.SanityEmployeeCliftonStrengthsInnerDomainEnum = exports.SanityCreateEmployeeTechnologiesInnerSanityTypeEnum = exports.SanityCreateEmployeeTagsInnerSanityTypeEnum = exports.SanityCreateEmployeeGroupsInnerSanityTypeEnum = exports.SanityCreateEmployeeCliftonStrengthsInnerSanityTypeEnum = exports.ProtectedEmployeeSanityTypeEnum = exports.ProtectedEmployeeParentalLeaveCoverageEnum = exports.ProtectedEmployeeMaritalStatusEnum = exports.ProtectedEmployeeGenderEnum = exports.PlatformIntegrationKindEnum = exports.PickSanityPatchEmployeeExcludeKeyofSanityPatchEmployeeScopeGrantsSettingsColorSchemeEnum = exports.PickSanityPatchEmployeeExcludeKeyofSanityPatchEmployeeScopeGrantsSalaryConfigModelEnum = exports.PatchEmployeeSanityTypeEnum = exports.PatchEmployeeParentalLeaveCoverageEnum = exports.PatchEmployeeMaritalStatusEnum = exports.PatchEmployeeGenderEnum = exports.PatchBusinessRequestStatusEnum = exports.PageEquipmentInnerSanityTypeEnum = exports.PageEmployeeOrderInnerSanityTypeEnum = exports.OnboardBusinessRequestStatusEnum = exports.IntegrationSummaryAuthMethodEnum = exports.IntegrationCheckResultStatusEnum = exports.EmployeeReferenceSanityTypeEnum = exports.ComponentBlocksInnerOneOfMarkDefsInnerSanityTypeEnum = exports.ComponentBlocksInnerOneOfChildrenInnerSanityTypeEnum = exports.CommissionTierReferenceSanityTypeEnum = exports.BusinessStatusEnum = void 0;
+/**
+ * @export
+ */
+exports.BusinessStatusEnum = {
+    PendingReview: 'PendingReview',
+    Approved: 'Approved',
+    Provisioning: 'Provisioning',
+    Active: 'Active',
+    Failed: 'Failed',
+    Suspended: 'Suspended'
+};
+/**
+ * @export
+ */
+exports.CommissionTierReferenceSanityTypeEnum = {
+    Reference: 'reference'
+};
+/**
+ * @export
+ */
+exports.ComponentBlocksInnerOneOfChildrenInnerSanityTypeEnum = {
+    Span: 'span'
+};
+/**
+ * @export
+ */
+exports.ComponentBlocksInnerOneOfMarkDefsInnerSanityTypeEnum = {
+    Link: 'link'
+};
+/**
+ * @export
+ */
+exports.EmployeeReferenceSanityTypeEnum = {
+    Reference: 'reference'
+};
+/**
+ * @export
+ */
+exports.IntegrationCheckResultStatusEnum = {
+    NotConfigured: 'not_configured',
+    Configured: 'configured',
+    Ok: 'ok',
+    Fail: 'fail'
+};
+/**
+ * @export
+ */
+exports.IntegrationSummaryAuthMethodEnum = {
+    ApiKey: 'api-key',
+    Oauth: 'oauth'
+};
+/**
+ * @export
+ */
+exports.OnboardBusinessRequestStatusEnum = {
+    PendingReview: 'PendingReview',
+    Approved: 'Approved',
+    Provisioning: 'Provisioning',
+    Active: 'Active',
+    Failed: 'Failed',
+    Suspended: 'Suspended'
+};
+/**
+ * @export
+ */
+exports.PageEmployeeOrderInnerSanityTypeEnum = {
+    Reference: 'reference'
+};
+/**
+ * @export
+ */
+exports.PageEquipmentInnerSanityTypeEnum = {
+    Reference: 'reference'
+};
+/**
+ * @export
+ */
+exports.PatchBusinessRequestStatusEnum = {
+    PendingReview: 'PendingReview',
+    Approved: 'Approved',
+    Provisioning: 'Provisioning',
+    Active: 'Active',
+    Failed: 'Failed',
+    Suspended: 'Suspended'
+};
+/**
+ * @export
+ */
+exports.PatchEmployeeGenderEnum = {
+    Male: 'male',
+    Female: 'female',
+    TheseAreNotTheGendersYouAreLookingFor: 'These are not the genders you are looking for'
+};
+/**
+ * @export
+ */
+exports.PatchEmployeeMaritalStatusEnum = {
+    Single: 'single',
+    Married: 'married',
+    Cohabitant: 'cohabitant'
+};
+/**
+ * @export
+ */
+exports.PatchEmployeeParentalLeaveCoverageEnum = {
+    _80: '80',
+    _100: '100'
+};
+/**
+ * @export
+ */
+exports.PatchEmployeeSanityTypeEnum = {
+    Employee: 'employee'
+};
+/**
+ * @export
+ */
+exports.PickSanityPatchEmployeeExcludeKeyofSanityPatchEmployeeScopeGrantsSalaryConfigModelEnum = {
+    SnokamCeo: 'snokam.ceo',
+    SnokamEmployee: 'snokam.employee'
+};
+/**
+ * @export
+ */
+exports.PickSanityPatchEmployeeExcludeKeyofSanityPatchEmployeeScopeGrantsSettingsColorSchemeEnum = {
+    Dark: 'dark',
+    Light: 'light',
+    System: 'system'
+};
+/**
+ * @export
+ */
+exports.PlatformIntegrationKindEnum = {
+    ApiKey: 'api-key',
+    Oauth: 'oauth',
+    Platform: 'platform'
+};
+/**
+ * @export
+ */
+exports.ProtectedEmployeeGenderEnum = {
+    Female: 'female',
+    Male: 'male',
+    TheseAreNotTheGendersYouAreLookingFor: 'These are not the genders you are looking for'
+};
+/**
+ * @export
+ */
+exports.ProtectedEmployeeMaritalStatusEnum = {
+    Cohabitant: 'cohabitant',
+    Married: 'married',
+    Single: 'single'
+};
+/**
+ * @export
+ */
+exports.ProtectedEmployeeParentalLeaveCoverageEnum = {
+    _80: '80',
+    _100: '100'
+};
+/**
+ * @export
+ */
+exports.ProtectedEmployeeSanityTypeEnum = {
+    Employee: 'employee'
+};
+/**
+ * @export
+ */
+exports.SanityCreateEmployeeCliftonStrengthsInnerSanityTypeEnum = {
+    Reference: 'reference'
+};
+/**
+ * @export
+ */
+exports.SanityCreateEmployeeGroupsInnerSanityTypeEnum = {
+    Reference: 'reference'
+};
+/**
+ * @export
+ */
+exports.SanityCreateEmployeeTagsInnerSanityTypeEnum = {
+    Reference: 'reference'
+};
+/**
+ * @export
+ */
+exports.SanityCreateEmployeeTechnologiesInnerSanityTypeEnum = {
+    Reference: 'reference'
+};
+/**
+ * @export
+ */
+exports.SanityEmployeeCliftonStrengthsInnerDomainEnum = {
+    Executing: 'executing',
+    Influencing: 'influencing',
+    RelationshipBuilding: 'relationship_building',
+    StrategicThinking: 'strategic_thinking'
+};
+/**
+ * @export
+ */
+exports.SanityEmployeeCliftonStrengthsInnerSanityTypeEnum = {
+    CliftonStrength: 'cliftonStrength'
+};
+/**
+ * @export
+ */
+exports.SanityEmployeeCommissionTierSanityTypeEnum = {
+    CommissionTier: 'commissionTier'
+};
+/**
+ * @export
+ */
+exports.SanityEmployeeEquipmentInnerSanityTypeEnum = {
+    Equipment: 'equipment'
+};
+/**
+ * @export
+ */
+exports.SanityEmployeeGroupsInnerSanityTypeEnum = {
+    Group: 'group'
+};
+/**
+ * @export
+ */
+exports.SanityEmployeeManagerSanityTypeEnum = {
+    Employee: 'employee'
+};
+/**
+ * @export
+ */
+exports.SanityEmployeeNextOfKinInnerSanityTypeEnum = {
+    Nextofkin: 'nextofkin'
+};
+/**
+ * @export
+ */
+exports.SanityEmployeeSalaryConfigModelEnum = {
+    SnokamCeo: 'snokam.ceo',
+    SnokamEmployee: 'snokam.employee'
+};
+/**
+ * @export
+ */
+exports.SanityEmployeeSettingsColorSchemeEnum = {
+    Dark: 'dark',
+    Light: 'light',
+    System: 'system'
+};
+/**
+ * @export
+ */
+exports.SanityImageAssetReferenceSanityTypeEnum = {
+    Reference: 'reference'
+};
+/**
+ * @export
+ */
+exports.SanityImageCropSanityTypeEnum = {
+    SanityImageCrop: 'sanity.imageCrop'
+};
+/**
+ * @export
+ */
+exports.SanityImageHotspotSanityTypeEnum = {
+    SanityImageHotspot: 'sanity.imageHotspot'
+};
+/**
+ * @export
+ */
+exports.SanityPatchPageMetaImageSanityTypeEnum = {
+    Image: 'image'
+};
+/**
+ * @export
+ */
+exports.SanitySystemsInnerDescriptionInnerListItemEnum = {
+    Bullet: 'bullet',
+    Number: 'number'
+};
+/**
+ * @export
+ */
+exports.SanitySystemsInnerDescriptionInnerSanityTypeEnum = {
+    Block: 'block'
+};
+/**
+ * @export
+ */
+exports.SanitySystemsInnerDescriptionInnerStyleEnum = {
+    Blockquote: 'blockquote',
+    H1: 'h1',
+    H2: 'h2',
+    H3: 'h3',
+    H4: 'h4',
+    H5: 'h5',
+    H6: 'h6',
+    Normal: 'normal'
+};
+/**
+ * @export
+ */
+exports.SanityTechnologyWithRelationsArticlesInnerMediaOneOfSanityTypeEnum = {
+    Image: 'image'
+};
+/**
+ * @export
+ */
+exports.SanityTechnologyWithRelationsEmployeesInnerTagsInnerSanityTypeEnum = {
+    Tag: 'tag'
+};
+/**
+ * @export
+ */
+exports.SanityTechnologyWithRelationsProjectsInnerTechnologiesInnerSanityTypeEnum = {
+    Technology: 'technology'
+};
+/**
+ * @export
+ */
+exports.SanityTvCategoryDashboardsInnerBackgroundImageSanityTypeEnum = {
+    Image: 'image'
+};
+/**
+ * @export
+ */
+exports.SanityTvCategoryDashboardsInnerBackgroundImageAssetSanityTypeEnum = {
+    SanityImageAsset: 'sanity.imageAsset'
+};
+/**
+ * @export
+ */
+exports.SlugSanityTypeEnum = {
+    Slug: 'slug'
+};

package/dist/runtime.d.ts

@@ -0,0 +1,181 @@
+/**
+ * Platform API
+ * Self-service business platform management API
+ *
+ * The version of the OpenAPI document: v1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function exists(json: any, key: string): boolean;
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}