@sudoplatform/sudo-secure-communications 0.0.1 → 5.0.1

package/types/private/domain/entities/channels/channelsService.d.ts

@@ -0,0 +1,157 @@
+import { ChannelEntity, ChannelJoinRuleEntity, ChannelSortOrderEntity, PublicChannelJoinRuleEntity, PublicChannelSearchResultEntity } from './channelEntity';
+import { Input } from '../../../../public/secureCommsClient';
+import { PowerLevelsEntity } from '../common/powerLevelsEntity';
+/**
+ * Input for `ChannelService.create` method.
+ *
+ * @interface CreateChannelInput
+ * @property {string} selfHandleId Identifier associated with the handle of the creator of the channel.
+ * @property {string} name Optional display name for the channel.
+ * @property {string} description Optional description of the channel.
+ * @property {ChannelJoinRuleEntity} joinRule The rule for joining and whether the channel is searchable.
+ * @property {string[]} tags Tags associated with the channel to facilitate searching.
+ * @property {string[]} invitedHandleIds The identifiers of the handles to invite immediately when the channel is created.
+ * @property {PowerLevelsEntity} powerLevels The minimum levels required to perform each action and the default level of handles in the channel.
+ * @property {string} avatarUrl Optional avatar image URL.
+ */
+export interface CreateChannelInput {
+    selfHandleId: string;
+    name?: string;
+    description?: string;
+    joinRule: ChannelJoinRuleEntity;
+    tags: string[];
+    invitedHandleIds: string[];
+    powerLevels?: PowerLevelsEntity;
+    avatarUrl?: string;
+}
+/**
+ * Input for `ChannelService.update` method.
+ *
+ * @interface UpdateChannelInput
+ * @property {string} selfHandleId Identifier associated with the handle of the creator of the channel.
+ * @property {string} channelId Identifier of the channel to update.
+ * @property {Input<string | undefined>} name The display name for the channel. Undefined means do not change.
+ * @property {Input<string | undefined>} description The description of the channel. Undefined means do not change.
+ * @property {Input<string[]>} tags Tags associated with the channel to facilitate searching. Undefined means do not change.
+ * @property {Input<ChannelJoinRuleEntity>} joinRule The rule for joining and whether the channel is searchable. Undefined
+ *  means do not change.
+ * @property {Input<string | undefined>} avatarUrl The avatar URL of the channel. Undefined means do not change.
+ */
+export interface UpdateChannelInput {
+    selfHandleId: string;
+    channelId: string;
+    name?: Input<string | undefined>;
+    description?: Input<string | undefined>;
+    tags?: Input<string[]>;
+    joinRule?: Input<ChannelJoinRuleEntity>;
+    avatarUrl?: Input<string | undefined>;
+}
+/**
+ * Input for `ChannelService.delete` method.
+ *
+ * @interface DeleteChannelInput
+ * @property {string} selfHandleId Identifier associated with the handle of the creator of the channel.
+ * @property {string} channelId Identifier associated with the channel to delete.
+ */
+export interface DeleteChannelInput {
+    selfHandleId: string;
+    channelId: string;
+}
+/**
+ * Output for `ChannelsService.list` method.
+ *
+ * @interface ListChannelsOutput
+ * @property {ChannelEntity[]} channels The list of channels retrieved in this query.
+ * @property {string[]} unprocessedIds The list of identifiers that were not retrieved but should be retried.
+ */
+export interface ListChannelsOutput {
+    channels: ChannelEntity[];
+    unprocessedIds: string[];
+}
+/**
+ * Input for `ChannelsService.search` method.
+ *
+ * @interface SearchPublicChannelsInput
+ * @property {string} selfHandleId Identifier associated with the handle of the creator of the channel.
+ * @property {ChannelSortOrderEntity} order Specifies the ordering that should be applied to the
+ *  channels returned by the search.
+ * @property {string} searchTerm The search string to search metadata such as name, topic, alias etc.
+ * @property {PublicChannelJoinRuleEntity} joinRule The rule for joining the public channel.
+ * @property {boolean} isJoined Flag to only return joined channels when true or not yet joined
+ *  channels when false. If undefined, the flag is not applied to the search.
+ * @property {string[]} tags Tags associated with the public channel to facilitate searching. Undefined means do not change.
+ * @property {number} limit Number of records to return.
+ * @property {string} nextToken A token generated by a previous call to `ChannelsService.search`.
+ *  This allows for pagination.
+ */
+export interface SearchPublicChannelsInput {
+    selfHandleId: string;
+    order: ChannelSortOrderEntity;
+    searchTerm?: string;
+    joinRule?: PublicChannelJoinRuleEntity;
+    isJoined?: boolean;
+    tags?: string[];
+    limit?: number;
+    nextToken?: string;
+}
+/**
+ * Output for `ChannelsService.search` method.
+ *
+ * @interface SearchPublicChannelsOutput
+ * @property {PublicChannelSearchResultEntity[]} channels The list of channel result items retrieved in this search.
+ * @property {string} nextToken A token generated by a previous call. This allows for pagination.
+ */
+export interface SearchPublicChannelsOutput {
+    channels: PublicChannelSearchResultEntity[];
+    nextToken?: string;
+}
+/**
+ * Core entity representation of a channel service used in business logic. Used to perform CRUD operations for channels.
+ *
+ * @interface ChannelsService
+ */
+export interface ChannelsService {
+    /**
+     * Create a channel.
+     *
+     * @param {CreateChannelInput} input Parameters used to create a channel.
+     * @returns {ChannelEntity} The channel that was created.
+     */
+    create(input: CreateChannelInput): Promise<ChannelEntity>;
+    /**
+     * Retrieve a channel.
+     *
+     * @param {string} channelId The identifier used to retrieve the desired channel.
+     * @returns {ChannelEntity | undefined} The retrieved channel, or undefined if not found.
+     */
+    get(channelId: string): Promise<ChannelEntity | undefined>;
+    /**
+     * Update a channel.
+     *
+     * @param {UpdateChannelInput} input Parameters used to update a channel.
+     * @returns {ChannelEntity} The channel that was updated.
+     */
+    update(input: UpdateChannelInput): Promise<ChannelEntity>;
+    /**
+     * Delete a channel.
+     *
+     * @param {string} input Parameters used to delete a channel.
+     */
+    delete(input: DeleteChannelInput): Promise<void>;
+    /**
+     * Retrieve a list of channels.
+     *
+     * @param {string[]} ids A list of identifers used to retrieve the desired channels.
+     * @returns {ListChannelsOutput} A list of channels matching the search criteria and
+     *  any unprocessed channel identifiers.
+     */
+    list(ids: string[]): Promise<ListChannelsOutput>;
+    /**
+     * Search for public channels based on search criteria.
+     *
+     * @param {SearchPublicChannelsInput} input Parameters used to search for a public channel.
+     * @returns {SearchPublicChannelsOutput} A list of public channels matching the search criteria.
+     *  Can be empty if no channels found
+     */
+    search(input: SearchPublicChannelsInput): Promise<SearchPublicChannelsOutput>;
+}

package/types/private/domain/entities/common/memberEntity.d.ts

@@ -0,0 +1,61 @@
+import { ChannelRoleEntity } from '../channels/channelEntity';
+import { GroupRoleEntity } from '../groups/groupEntity';
+import { HandleEntity } from '../handle/handleEntity';
+/**
+ * Core entity representation of a member business rule.
+ *
+ * @interface MemberEntity
+ * @property {HandleEntity} handle Handle associated with the member.
+ * @property {MembershipStateEntity} membership The membership state for this handle. See {@link MembershipStateEntity}.
+ */
+export interface MemberEntity {
+    handle: HandleEntity;
+    membership: MembershipStateEntity;
+}
+/**
+ * The state of a member.
+ *
+ * @enum
+ */
+export declare enum MembershipStateEntity {
+    INVITED = "INVITED",
+    REQUESTED = "REQUESTED",
+    JOINED = "JOINED",
+    LEFT = "LEFT",
+    BANNED = "BANNED"
+}
+/**
+ * Core entity representation of a channe lmember business rule.
+ *
+ * @interface ChannelMemberEntity
+ * @property {HandleEntity} handle See {@link MemberEntity}.
+ * @property {GroupMembershipState} membership See {@link MemberEntity}.
+ * @property {ChannelRoleEntity} role The role this channel member is assigned. See {@link ChannelRoleEntity}.
+ */
+export interface ChannelMemberEntity extends MemberEntity {
+    role: ChannelRoleEntity;
+}
+/**
+ * Core entity representation of a group member business rule.
+ *
+ * @interface GroupMemberEntity
+ * @property {HandleEntity} handle See {@link MemberEntity}.
+ * @property {GroupMembershipState} membership See {@link MemberEntity}.
+ * @property {GroupRoleEntity} role The role this group member is assigned. See {@link GroupRoleEntity}.
+ */
+export interface GroupMemberEntity extends MemberEntity {
+    role: GroupRoleEntity;
+}
+/**
+ * Core entity representation of a room member business rule.
+ *
+ * @interface RoomMemberEntity
+ * @property {HandleEntity} handle Handle associated with the member.
+ * @property {MembershipStateEntity} membership The membership state for this handle. See {@link MembershipStateEntity}.
+ * @property {number} powerLevel The power level this member is assigned.
+ */
+export interface RoomMemberEntity {
+    handle: HandleEntity;
+    membership: MembershipStateEntity;
+    powerLevel: number;
+}

package/types/private/domain/entities/common/ownerEntity.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Core entity representation of a owner business rule. Depicts the identifier and issuer of an owner of a resource.
+ *
+ * @interface OwnerEntity
+ * @property {string} id Unique identifier of the owner.
+ * @property {string} issuer Issuer of the owner.
+ */
+export interface OwnerEntity {
+    id: string;
+    issuer: string;
+}

package/types/private/domain/entities/common/powerLevelsEntity.d.ts

@@ -0,0 +1,22 @@
+/**
+ * The elements of required power levels to perform each action and
+ *  default level of handles in a {@link GroupEntity}.
+ *
+ * @interface PowerLevelsEntity
+ * @property {number} usersDefault The default level of handles in the group.
+ * @property {number} eventsDefault The default required level to send message events.
+ * @property {number} invite The level required to invite a handle.
+ * @property {number} kick The level required to kick a handle.
+ * @property {number} ban The level required to ban a handle.
+ * @property {number} redact The level required to redact an event sent by another handle.
+ * @property {Record<string, number>} events The levels required to send specific event types.
+ */
+export interface PowerLevelsEntity {
+    usersDefault?: number;
+    eventsDefault?: number;
+    invite?: number;
+    kick?: number;
+    ban?: number;
+    redact?: number;
+    events?: Record<string, number>;
+}

package/types/private/domain/entities/directChats/directChatEntity.d.ts

@@ -0,0 +1,39 @@
+import { ChatId } from '../../../../public';
+import { HandleEntity } from '../handle/handleEntity';
+/**
+ * Core entity representation of a direct chat business rule.
+ *
+ * @interface DirectChatEntity
+ * @property {ChatId} chatId The identifier of the direct chat.
+ * @property {HandleEntity} otherHandle The handle that is participating in the direct chat.
+ */
+export interface DirectChatEntity {
+    chatId: ChatId;
+    otherHandle: HandleEntity;
+}
+/**
+ * The role of a member within a direct chat, ranked in descending order.
+ *
+ * @property PARTICIPANT: The handle has basic power of making changes to the direct chat.
+ * @property NOBODY: The handle has no power to make any changes to the direct chat.
+ *
+ * @enum
+ */
+export declare enum DirectChatRoleEntity {
+    PARTICIPANT = "PARTICIPANT",
+    NOBODY = "NOBODY"
+}
+/**
+ * Permissions of certain direct chat functions and capabilities. Each capability requires a minimum
+ * {@link DirectChatRoleEntity} for handles to be able to execute.
+ */
+export declare class DirectChatPermissionsEntity {
+    deleteOthersMessages: DirectChatRoleEntity;
+    /**
+     * Constructs a new instance of direct chat permissions with role-based access control.
+     *
+     * @property {DirectChatRoleEntity} deleteOthersMessages What role can delete anyone's messages.
+     */
+    constructor(deleteOthersMessages: DirectChatRoleEntity);
+    static default: DirectChatPermissionsEntity;
+}

package/types/private/domain/entities/directChats/directChatInvitationEntity.d.ts

@@ -0,0 +1,13 @@
+import { ChatId } from '../../../../public';
+import { HandleEntity } from '../handle/handleEntity';
+/**
+ * Core entity representation of a direct chat invitation business rule.
+ *
+ * @interface DirectChatInvitationEntity
+ * @property {ChatId} chatId The identifier of the direct chat.
+ * @property {HandleEntity} inviterHandle The handle that is participating in the direct chat.
+ */
+export interface DirectChatInvitationEntity {
+    chatId: ChatId;
+    inviterHandle: HandleEntity;
+}

package/types/private/domain/entities/directChats/directChatsService.d.ts

@@ -0,0 +1,59 @@
+import { DirectChatEntity } from './directChatEntity';
+import { DirectChatInvitationEntity } from './directChatInvitationEntity';
+/**
+ * Core entity representation of a direct chats service used in business logic. Used to perform CRUD operations for direct chats.
+ *
+ * @interface DirectChatsService
+ */
+export interface DirectChatsService {
+    /**
+     * Create a direct chat.
+     *
+     * @param {string} handleIdToChatTo The identifier of the handle to start chatting to.
+     * @returns {string} The identifier of the chat that was created.
+     */
+    create(handleIdToChatTo: string): Promise<string>;
+    /**
+     * Accept an invitation to join a direct chat.
+     *
+     * @param {string} chatId The identifier of the chat to join.
+     */
+    acceptInvitation(chatId: string): Promise<void>;
+    /**
+     * Decline an invitation to join a direct chat.
+     *
+     * @param {string} chatId The identifier of the chat to decline.
+     */
+    declineInvitation(chatId: string): Promise<void>;
+    /**
+     * Retrieve a list of all direct chat invitations.
+     *
+     * @returns {DirectChatInvitationEntity[]} A list of direct chat invitations.
+     */
+    listInvitations(): Promise<DirectChatInvitationEntity[]>;
+    /**
+     * Retrieve a list of all joined direct chats.
+     *
+     * @returns {DirectChatEntity[]} A list of joined direct chats.
+     */
+    listJoined(): Promise<DirectChatEntity[]>;
+    /**
+     * Blocks a handle.
+     *
+     * @param {string} handleId The identifer of the handle to block.
+     */
+    blockHandle(handleId: string): Promise<void>;
+    /**
+     * Unblocks a handle.
+     *
+     * @param {string} handleId The identifer of the handle to unblock.
+     */
+    unblockHandle(handleId: string): Promise<void>;
+    /**
+     * Retrieves a list of all known blocked handles.
+     *
+     * @returns {string[]} A list of the handle identifiers of the handles
+     *  that are blocked
+     */
+    listBlockedHandles(): Promise<string[]>;
+}

package/types/private/domain/entities/groups/groupEntity.d.ts

@@ -0,0 +1,64 @@
+import { GroupId } from '../../../../public';
+/**
+ * Core entity representation of a group business rule.
+ *
+ * @interface GroupEntity
+ * @property {GroupId} groupId Unique identifier of the group.
+ * @property {string} name Optional display name for the group.
+ * @property {string} description Optional explanation about what the group is about.
+ * @property {string} avatarUrl Optional url for associated avatar image.
+ * @property {GroupPermissionsEntity} permissions Optional permissions describing what roles can perform
+ *  certain actions within the group.
+ * @property {number} memberCount The number of joined members of the group.
+ */
+export interface GroupEntity {
+    groupId: GroupId;
+    name?: string;
+    description?: string;
+    avatarUrl?: string;
+    permissions?: GroupPermissionsEntity;
+    memberCount: number;
+}
+/**
+ * The role of a member within a group, ranked in descending order.
+ * Higher ranked roles are granted permissions of lower ranked roles.
+ *
+ * @property ADMIN: The handle has power to make any changes to the group.
+ * @property PARTICIPANT: The handle has basic power of making changes to the group.
+ * @property NOBODY: The handle has no power to make any changes to the group.
+ *
+ * @enum
+ */
+export declare enum GroupRoleEntity {
+    ADMIN = "ADMIN",
+    PARTICIPANT = "PARTICIPANT",
+    NOBODY = "NOBODY"
+}
+/**
+ * Permissions of certain group functions and capabilities. Each capability requires a minimum
+ * {@link GroupRoleEntity} for handles to be able to execute.
+ */
+export declare class GroupPermissionsEntity {
+    sendMessages: GroupRoleEntity;
+    inviteHandles: GroupRoleEntity;
+    kickHandles: GroupRoleEntity;
+    banHandles: GroupRoleEntity;
+    changeGroupName: GroupRoleEntity;
+    changeGroupDescription: GroupRoleEntity;
+    changeGroupAvatar: GroupRoleEntity;
+    deleteOthersMessages: GroupRoleEntity;
+    /**
+     * Constructs a new instance of group permissions with role-based access control.
+     *
+     * @property {GroupRoleEntity} sendMessages What role can send messages in the chat.
+     * @property {GroupRoleEntity} inviteHandles What role can invite other handles.
+     * @property {GroupRoleEntity} kickHandles What role can kick other handles.
+     * @property {GroupRoleEntity} banHandles What role can ban other handles.
+     * @property {GroupRoleEntity} changeGroupName What role can change the group's name.
+     * @property {GroupRoleEntity} changeGroupDescription What role can change the group's description.
+     * @property {GroupRoleEntity} changeGroupAvatar What role can change the group's avatar.
+     * @property {GroupRoleEntity} deleteOthersMessages What role can delete anyone's messages.
+     */
+    constructor(sendMessages: GroupRoleEntity, inviteHandles: GroupRoleEntity, kickHandles: GroupRoleEntity, banHandles: GroupRoleEntity, changeGroupName: GroupRoleEntity, changeGroupDescription: GroupRoleEntity, changeGroupAvatar: GroupRoleEntity, deleteOthersMessages: GroupRoleEntity);
+    static default: GroupPermissionsEntity;
+}

package/types/private/domain/entities/handle/handleEntity.d.ts

@@ -0,0 +1,26 @@
+import { HandleId } from '../../../../public';
+import { OwnerEntity } from '../common/ownerEntity';
+/**
+ * Core entity representation of public handle information business rule.
+ *
+ * @interface HandleEntity
+ * @property {HandleId} handleId Unique identifier associated with the handle.
+ * @property {string} name The name of the handle that will be publicly visible to other users.
+ */
+export interface HandleEntity {
+    handleId: HandleId;
+    name: string;
+}
+/**
+ * Core entity representation of a handle business rule owned by this client.
+ *
+ * @interface OwnedHandleEntity
+ * @property {HandleId} handleId See {@link HandleEntity.handleId}.
+ * @property {string} name See {@link HandleEntity.name}.
+ * @property {string} owner Identifier of the user that owns the handle.
+ * @property {Owner[]} owners List of identifiers of the user/sudo associated with this handle.
+ */
+export interface OwnedHandleEntity extends HandleEntity {
+    owner: string;
+    owners: OwnerEntity[];
+}

package/types/private/domain/entities/handle/handleService.d.ts

@@ -0,0 +1,70 @@
+import { HandleEntity, OwnedHandleEntity } from './handleEntity';
+/**
+ * Input for `HandleService.update` method.
+ *
+ * @interface UpdateHandleInput
+ * @property {string} handleId Identifier of the handle to update.
+ * @property {string} name The new name of the handle.
+ */
+export interface UpdateHandleInput {
+    handleId: string;
+    name: string;
+}
+/**
+ * Input for `HandlesService.list` method.
+ *
+ * @interface ListHandlesInput
+ * @property {number} limit Number of records to return.
+ * @property {string} nextToken A token generated by a previous call to `HandlesService.list`.
+ *  This allows for pagination.
+ */
+export interface ListHandlesInput {
+    limit?: number;
+    nextToken?: string;
+}
+/**
+ * Output for `HandlesService.list` method.
+ *
+ * @interface ListHandlesOutput
+ * @property {OwnedHandleEntity[]} handles The list of handles retrieved in this query.
+ * @property {string} nextToken A token generated by a previous call. This allows for pagination.
+ */
+export interface ListHandlesOutput {
+    handles: OwnedHandleEntity[];
+    nextToken?: string;
+}
+/**
+ * Core entity representation of a handle service used in business logic. Used to perform CRUD operations for handles.
+ *
+ * @interface HandleService
+ */
+export interface HandleService {
+    /**
+     * Retrieve a handle by its name.
+     *
+     * @param {string} name The name of the handle to retrieve.
+     * @returns {HandleEntity | undefined} The retrieved public handle information, or undefined if not found.
+     */
+    get(name: string): Promise<HandleEntity | undefined>;
+    /**
+     * Update a handle with new metadata.
+     *
+     * @param {UpdateHandleInput} input Parameters used to update a handle.
+     * @returns {OwnedHandleEntity} The handle that was updated.
+     */
+    update(input: UpdateHandleInput): Promise<OwnedHandleEntity>;
+    /**
+     * Delete a handle.
+     *
+     * @param {string} id Identifier associated with the handle to delete.
+     * @returns {OwnedHandleEntity} The handle that was deleted.
+     */
+    delete(id: string): Promise<OwnedHandleEntity>;
+    /**
+     * Retrieve a list of handles.
+     *
+     * @param {ListHandlesInput} input Parameters used to list handles.
+     * @returns {ListHandlesOutput} A list of all handles matching the search criteria. Can be empty if no handles found.
+     */
+    list(input: ListHandlesInput): Promise<ListHandlesOutput>;
+}

package/types/private/domain/entities/media/fileEncryptionInfoEntity.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Core entity representation of the information used to encrypt a file.
+ *
+ * @interface FileEncryptionInfoEntity
+ * @property {any} key A web key object containing the key used to encrypt.
+ * @property {string} iv The 128-bit unique initialization vector used by AES-CTR, encoded as unpadded base64.
+ * @property {string} v The optional version of the encrypted payload protocol.
+ * @property {HashAlgorithm} hashes A map from an algorithm name to a hash of the ciphertext, encoded as unpadded base64.
+ *  Clients should support the SHA-256 hash, which uses the key sha256.
+ */
+export interface FileEncryptionInfoEntity {
+    key: any;
+    iv: string;
+    v?: string;
+    hashes?: {
+        sha256?: string;
+    };
+}

package/types/private/domain/entities/media/mediaCredentialEntity.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Core entity representation of a credential for granting client S3 bucket access.
+ *
+ * @interface CredentialEntity
+ * @property {string} accessKeyId The identifier of the access key used as part of S3 client initialization.
+ * @property {string} secretAccessKey The secret access key used as part of S3 client initialization.
+ * @property {string} sessionToken The session token used as part of S3 client initialization.
+ */
+interface CredentialEntity {
+    accessKeyId: string;
+    secretAccessKey: string;
+    sessionToken: string;
+}
+/**
+ * Core entity representation of a media credential for granting client S3 bucket access.
+ *
+ * @interface MediaCredentialEntity
+ * @property {string} accessKeyId See {@link CredentialEntity.accessKeyId}.
+ * @property {string} secretAccessKey See {@link CredentialEntity.secretAccessKey}.
+ * @property {string} sessionToken See {@link CredentialEntity.sessionToken}.
+ * @property {string} bucket The name of the S3 bucket where the media resides.
+ * @property {string} region The region in which the bucket resides.
+ * @property {string} keyPrefix Optional object key prefix representing the type of media.
+ * @property {boolean} forWrite Whether this credential allows writing to the bucket.
+ */
+export interface MediaCredentialEntity extends CredentialEntity {
+    bucket: string;
+    region: string;
+    keyPrefix?: string;
+    forWrite: boolean;
+}
+/**
+ * Core entity representation of a media credential for room scoped S3 bucket access.
+ *
+ * @interface RoomMediaCredentialEntity
+ * @property {string} accessKeyId See {@link CredentialEntity.accessKeyId}.
+ * @property {string} secretAccessKey See {@link CredentialEntity.secretAccessKey}.
+ * @property {string} sessionToken See {@link CredentialEntity.sessionToken}.
+ * @property {string} keyPrefix The key prefix of the S3 object.
+ * @property {number} expiry Time in milliseconds since epoch that the credential will expire.
+ */
+export interface RoomMediaCredentialEntity extends CredentialEntity {
+    keyPrefix: string;
+    expiry: number;
+}
+/**
+ * An enumeration representing the type of public media.
+ *
+ * @enum
+ */
+export declare enum PublicMediaType {
+    AVATARS = "avatars/",
+    MEDIA = "media/"
+}
+export {};

package/types/private/domain/entities/media/mediaCredentialService.d.ts

@@ -0,0 +1,29 @@
+import { RoomMediaCredentialEntity } from './mediaCredentialEntity';
+/**
+ * Input for `MediaCredentialService.get` method.
+ *
+ * @interface GetMediaCredentialInput
+ * @property {string} handleId The identifier of the handle to get the token for.
+ * @property {boolean} forWrite Flag determining whether to write to the S3 bucket.
+ * @property {string} roomId The identifier of the room to get the token for.
+ */
+export interface GetMediaCredentialInput {
+    handleId: string;
+    forWrite: boolean;
+    roomId: string;
+}
+/**
+ * Core entity representation of a media credential service used in business logic to
+ * retrieve media credentials for a handle and room.
+ *
+ * @interface MediaCredentialService
+ */
+export interface MediaCredentialService {
+    /**
+     * Retrieve the AWS S3 media credential for a handle and room.
+     *
+     * @param {GetMediaCredentialInput} input Parameters used to retrieve a media credential.
+     * @returns {RoomMediaCredentialEntity} The media credential for the handle.
+     */
+    get(input: GetMediaCredentialInput): Promise<RoomMediaCredentialEntity>;
+}