import { AuthorResponse } from './Author'; /** * This type represent the publishing channel unique id */ export type PublishingChannelId = number; /** * This type represent the data needed to make a create publishing channel API request */ export type CreatePublishingChannelRequest = { /** * The publishing channel name */ name: string; /** * The publishing channel unique mnemonic id */ mnemonicId: string; /** * The publishing channel color */ color?: string; }; /** * This type represent the model of a publishing channel */ export type PublishingChannelResponse = { /** * The unique publishing channel id */ id: PublishingChannelId; /** * The publishing channel name */ name: string; /** * The publishing channel mnemonic id */ mnemonicId: string; /** * The publishing channel color */ color: string; /** * The publishing channel creation date */ createdDate: Date; /** * The publishing channel updated date */ lastModifiedDate: Date; /** * The publishing channel creator */ author: AuthorResponse; /** * The publishing channel latest contributor */ latestContributor: AuthorResponse; /** * Specifies whether the publishing channel is archived or not */ archived: boolean; /** * The archiving date of the publishing channel */ archivedDate: Date | null; }; /** * This type represent the data needed to make a get publishing channel API request */ export type GetPublishingChannelRequest = { /** * The publishing channel unique id */ id: PublishingChannelId; }; /** * This type represent the data needed to make an update publishing channel API request */ export type UpdatePublishingChannelRequest = { /** * The publishing channel unique id */ id: PublishingChannelId; /** * The publishing channel name */ name: string; /** * The publishing channel mnemonic id */ mnemonicId: string; /** * The publishing channel color */ color: string; }; /** * This type represent the response of a create publishing channel API request */ export type CreatePublishingChannelResponse = PublishingChannelResponse; /** * This type represent the response of a get publishing channel API request */ export type GetPublishingChannelResponse = PublishingChannelResponse; /** * This type represent the response of an update publishing channel API request */ export type UpdatePublishingChannelResponse = PublishingChannelResponse; /** * Request for list in PublishingChannelFacade */ export type ListPublishingChannelRequest = { /** * object whose property will be used to filter the list */ filters: { /** * Name of the publishing channel */ name?: string; /** * Determines if a list of archived publishing channel should be returned */ archived?: boolean; }; }; /** * This type represent the response of a list publishing channel API request */ export type ListPublishingChannelsResponse = PublishingChannelResponse[]; /** * Request for toggleArchived method on PublishingChannelFacade */ export type ToggleArchivedPublishingChannelRequest = { /** * The unique publishing channel id */ id: PublishingChannelId; /** * Determines if archive or unarchive need to be performed */ archived: boolean; }; /** * Response for toggleArchived method on PublishingChannelFacade */ export type ToggleArchivedPublishingChannelResponse = PublishingChannelResponse;