/**
 * Indicates what attribute an api key, visibile to the user, is made up of
 */
export type ExportedApiKey = {
    /**
    * The Id of the requested space
    */
    spaceId: string;
    /**
    * Value of the Api Key (this is what needs to be used as an header for the delivery api)
    */
    keyValue: string;
    /**
    * Name of the api key, used for distinguish one from the other
    */
    referenceName: string;
    /**
    * Indicates if this api key is barred or not from being used in the preview's delivery api
    */
    previewAccess: boolean;
    /**
    * Indicates if this api key is barred or not from being used in the online's delivery api
    */
    onlineAccess: boolean;
    /**
    * Date when this api key has been created
    */
    createdDate: string;
    /**
    * Whether this api key is disabled in being used in the delivery api
    */
    disabled: boolean;
};

/**
 * Credentials of the requested space
 */
export type ListSpaceApiCredentials = {
    /**
     * The space id related to the api credentials
     */
    spaceId: string;
    /**
     * The space name related to the api credentials
     */
    spaceName: string;
    /**
     * Api keys that have been created for the requested space
     */
    keys: ExportedApiKey[];
};

/**
 * Response of the getSpaceCredentials method on SpaceFacade
 */
export type ListSpaceApiCredentialsResponse = ListSpaceApiCredentials;

/**
 * This type represent the model of a space api credentials
 */
export type SpaceApiCredentials = {
    /**
     * The space id related to the api credentials
     */
    spaceId: string;
    /**
     * The space name related to the api credentials
     */
    spaceName: string;
    /**
     * The online api key for the space
     */
    onlineApiKey: string;
    /**
     * The preview api key for the space
     */
    previewApiKey: string;
};

/**
 * This type represent the model for the space api credentials
 */
export type SpaceApiCredentialsResponse = SpaceApiCredentials;

/**
 * This type represent the model of the content stats for a space
 */
export type ContentStats = {
    /**
     * The total number of unarchived content in the space
     */
    unarchivedContentCount: number;
    /**
     * The total number of archived content in the space
     */
    archivedContentCount: number;
    /**
     * The total number of content in the space
     */
    contentsCount: number;
};

/**
 * This type represent the model of the content repository stats for a space
 */
export type ContentRepositoryStats = {
    /**
     * The total number of content repositories in the space
     */
    repositoriesCount: number;
};

/**
 * This type represent the model of the media gallery stats for a space
 */
export type MediaGalleryStats = {
    /**
     * The total number of media galleries in the space
     */
    mediaGalleriesCount: number;
};

/**
 * This type represent the model for the top content definition of the space
 */
export type TopContentDefinition = {
    /**
     * The unique id of the content definition
     */
    id: number;
    /**
     * The mnemonic id of the content definition
     */
    mnemonic: string;
    /**
     * The name of the content definition
     */
    name: string;
    /**
     * The number of unarchived contents that use the content definition
     */
    unarchivedContents: number;
};

/**
 * This type represent the model for content definitions stats
 */
export type ContentDefinitionStats = {
    /**
     * The count of content definitions in the space
     */
    definitionsCount: number;
    /**
     * A list of the most used definition in the space
     */
    topContentDefinitions: TopContentDefinition[];
};

/**
 * This type represent the model for the space stats
 */
export type SpaceStats = ContentStats & ContentDefinitionStats & ContentRepositoryStats & MediaGalleryStats;

/**
 * Space locale structure
 */
export type SpaceLocale = {
    /**
     * Default space locale
     */
    defaultLocale: string;
    /**
     * List of supported locales (default locale is included)
     */
    locales: string[];

    /**
     * Fallback locale (defaults to 'en')
     */
    fallbackLocale: string;

    /**
     * List of locales that are enabled for publishing
     */
    publishingLocales?: string[];
}

/**
 * Return type of `getSpaceLocale`
 */
export type GetSpaceLocaleResponse = SpaceLocale;

/**
 * Request type when adding a new locale to space
 */
export type AddSpaceLocaleRequest = {
    /**
     * Locale to add
     */
    locale: string;
}
/**
 * Return type of `addSpaceLocale`
 */
export type AddSpaceLocaleResponse = SpaceLocale;
/**
 * Request type when removing a locale
 */
export type RemoveSpaceLocaleRequest = {
    /**
     * Locale to remove
     */
    locale: string;
}

/**
 * Return type of `removeSpaceLocale`
 */
export type RemoveSpaceLocaleResponse = SpaceLocale;
/**
 * Request type to update a locale to the space's default
 */
export type UpdateSpaceDefaultLocaleRequest = {
    /**
     * Locale to update to space's default
     */
    locale: string;
}
/**
 * Return type of `updateSpaceDefaultLocale`
 */
export type UpdateSpaceDefaultLocaleResponse = SpaceLocale;

/**
 * Request type to update space's fallback locale
 */
 export type UpdateSpaceFallbackLocaleRequest = {
    /**
     * Locale to update to space's fallback locale
     */
    locale: string;
}
/**
 * Return type of `updateSpacefallbackLocale`
 */
export type UpdateSpaceFallbackLocaleResponse = SpaceLocale;

/**
 * Request type to update space's publishing locales
 */
export type UpdateSpacePublishingLocalesRequest = {
    /**
     * Locales to enable for publishing (must be a subset of space's supported locales)
     */
    publishingLocales: string[];
}
/**
 * Return type of `updateSpacePublishingLocales`
 */
export type UpdateSpacePublishingLocalesResponse = SpaceLocale;