mns-node-sdk/dist/lib/types.d.ts

unofficial sdk for Aliyun mns

export declare type CreateQueueRequest = {
    QueueName: string;
    Attributes?: {
        DelaySeconds?: number;
        MaximumMessageSize?: number;
        MessageRetentionPeriod?: number;
        VisibilityTimeout?: number;
        PollingWaitSeconds?: number;
        LoggingEnabled?: boolean;
    };
};
export declare type DeleteQueueRequest = {
    QueueName: string;
};
export declare type ListQueueRequest = {
    Start?: string;
    Limit?: number;
    Prefix?: string;
};
export declare type GetQueueAttributesRequest = DeleteQueueRequest;
export declare type SetQueueAttributesRequest = CreateQueueRequest;
export declare type SendMessageRequest = {
    QueueName: string;
    Payloads: {
        MessageBody: string;
        DelaySeconds?: number;
        Priority?: number;
    };
};
export declare type BatchSendMessageRequest = {
    QueueName: string;
    Entries: {
        MessageBody: string;
        DelaySeconds?: number;
        Priority?: number;
    }[];
};
export declare type ReceiveMessageRequest = {
    QueueName: string;
    WaitSeconds?: number;
};
/**
 * NumOfMessages means the max number of receiving messages, not exactly the number of receiving messages.
 */
export declare type BatchReceiveMessageRequest = {
    QueueName: string;
    NumOfMessages: number;
    WaitSeconds?: number;
};
export declare type PeekMessageRequest = {
    QueueName: string;
};
/**
 * NumOfMessages means the max number of peeking messages, not exactly the number of peeking messages.
 */
export declare type BatchPeekMessageRequest = {
    QueueName: string;
    NumOfMessages: number;
};
export declare type DeleteMessageRequest = {
    QueueName: string;
    ReceiptHandle: string;
};
export declare type BatchDeleteMessageRequest = {
    QueueName: string;
    ReceiptHandles: string[];
};
export declare type ChangeMessageVisibilityRequest = {
    QueueName: string;
    ReceiptHandle: string;
    VisibilityTimeout: number;
};
export declare type CreateTopicRequest = {
    TopicName: string;
    Attributes?: {
        MaximumMessageSize?: number;
        LoggingEnabled?: boolean;
    };
};
export declare type DeleteTopicRequest = {
    TopicName: string;
};
export declare type ListTopicRequest = ListQueueRequest;
export declare type GetTopicAttributesRequest = DeleteTopicRequest;
export declare type SetTopicAttributesRequest = CreateTopicRequest;
export declare type SubscribeRequest = {
    TopicName: string;
    SubscriptionName: string;
    Attributes: {
        Endpoint: string;
        FilterTag?: string;
        NotifyStrategy?: 'BACKOFF_RETRY' | 'EXPONENTIAL_DECAY_RETRY';
        NotifyContentFormat?: 'XML' | 'JSON' | 'SIMPLIFIED';
    };
};
export declare type UnsubscribeRequest = {
    TopicName: string;
    SubscriptionName: string;
};
export declare type ListSubscriptionByTopicRequest = {
    TopicName: string;
    Start?: string;
    Limit?: number;
    Prefix?: string;
};
export declare type GetSubscriptionAttributesRequest = UnsubscribeRequest;
export declare type SetSubscriptionAttributesRequest = {
    TopicName: string;
    SubscriptionName: string;
    Attributes?: {
        NotifyStrategy?: 'BACKOFF_RETRY' | 'EXPONENTIAL_DECAY_RETRY';
    };
};
export declare type PublishMessageRequest = {
    TopicName: string;
    Payloads: {
        MessageBody: string;
        MessageTag?: string;
        MessageAttributes?: {
            DirectMail?: {
                AccountName: string;
                Subject: string;
                AddressType: 0 | 1;
                IsHtml: 0 | 1;
                ReplyToAddress: 0 | 1;
            };
            DirectSMS?: {
                FreeSignName: string;
                TemplateCode: string;
                Type: 'singleContent' | 'multiContent';
                Receiver: string;
                SmsParams: string;
            };
        };
    };
};
export declare type CreateQueueResponse = {
    Location: string;
};
export declare type ListQueueResponse = {
    Queue: {
        QueueName: string;
        CreateTime: string;
        LastModifyTime: string;
        DelaySeconds: string;
        MaximumMessageSize: string;
        MessageRetentionPeriod: string;
        PollingWaitSeconds: string;
        ActiveMessages: string;
        InactiveMessages: string;
        DelayMessages: string;
        LoggingEnabled: string;
        VisibilityTimeout: string;
        QueueURL: string;
    }[];
    NextMarker?: string;
};
export declare type GetQueueAttributesResponse = {
    QueueName: string;
    CreateTime: string;
    LastModifyTime: string;
    DelaySeconds: string;
    MaximumMessageSize: string;
    MessageRetentionPeriod: string;
    PollingWaitSeconds: string;
    ActiveMessages: string;
    InactiveMessages: string;
    DelayMessages: string;
    LoggingEnabled: string;
    VisibilityTimeout: string;
};
export declare type SendMessageResponse = {
    MessageId: string;
    MessageBodyMD5: string;
    ReceiptHandle?: string;
};
export declare type ReceiveMessageResponse = {
    MessageId: string;
    MessageBodyMD5: string;
    MessageBody: string;
    EnqueueTime: string;
    FirstDequeueTime: string;
    DequeueCount: string;
    Priority: string;
    ReceiptHandle: string;
    NextVisibleTime: string;
};
export declare type PeekMessageResponse = {
    MessageId: string;
    MessageBodyMD5: string;
    MessageBody: string;
    EnqueueTime: string;
    FirstDequeueTime: string;
    DequeueCount: string;
    Priority: string;
};
export declare type DeleteMessageResponse = {
    ErrorCode: string;
    ErrorMessage: string;
    ReceiptHandle: string;
};
export declare type ChangeMessageVisibilityResponse = {
    ReceiptHandle: string;
    NextVisibleTime: string;
};
export declare type CreateTopicResponse = {
    Location: string;
};
export declare type ListTopicResponse = {
    Topic: {
        TopicName: string;
        MessageCount: string;
        MaximumMessageSize: string;
        MessageRetentionPeriod: string;
        CreateTime: string;
        LastModifyTime: string;
        LoggingEnabled: string;
        TopicURL: string;
    }[];
    NextMarker?: string;
};
export declare type GetTopicAttributesResponse = {
    TopicName: string;
    MessageCount: string;
    MaximumMessageSize: string;
    MessageRetentionPeriod: string;
    CreateTime: string;
    LastModifyTime: string;
    LoggingEnabled: string;
};
export declare type SubscribeResponse = {
    Location: string;
};
export declare type ListSubscriptionResponse = {
    Subscription: GetSubscriptionAttributesResponse[];
    NextMarker?: string;
};
export declare type GetSubscriptionAttributesResponse = {
    SubscriptionName: string;
    Subscriber: string;
    TopicName: string;
    TopicOwner: string;
    CreateTime: string;
    LastModifyTime: string;
    Endpoint: string;
    NotifyStrategy: string;
    NotifyContentFormat: string;
    SubscriptionURL: string;
};
export declare type PublishMessageResponse = {
    MessageId: string;
    MessageBodyMD5: string;
};