/*
 * Copyright 2020 NEM
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { Address } from '../../model/account/Address';
import { MetadataType } from '../../model/metadata/MetadataType';
import { MosaicId } from '../../model/mosaic/MosaicId';
import { NamespaceId } from '../../model/namespace/NamespaceId';
import { SearchCriteria } from './SearchCriteria';

/**
 * Defines the params used to search metadata. With this criteria, you can sort and filter
 * metadata queries using rest.
 */
export interface MetadataSearchCriteria extends SearchCriteria {
    /**
     * The source address. (optional)
     */
    sourceAddress?: Address;

    /**
     * The target address. (optional)
     */
    targetAddress?: Address;

    /**
     * The scoped metadata key. (optional)
     */
    scopedMetadataKey?: string;

    /**
     * The target Mosaic or NamespaceId. (optional)
     */
    targetId?: MosaicId | NamespaceId;

    /**
     * The metadata type. (optional)
     */
    metadataType?: MetadataType;
}