@wppconnect/wa-js/dist/newsletter/functions/create.d.ts

WPPConnect/WA-JS is an open-source project with the aim of exporting functions from WhatsApp Web

/*!
 * Copyright 2023 WPPConnect Team
 *
 * 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.
 */
export interface ResultCreateNewsletter {
    idJid: string;
    inviteCode: string;
    inviteLink: string;
    name: string;
    state: string;
    subscribersCount: number;
    description: string | null;
    timestamp: number;
}
/**
 * Create a newsletter
 *
 * @example
 * ```javascript
 * // To edit name
 * WPP.newsletter.create('Name for your newsletter', {
 * description: 'Description for that',
 * picture: '<base64_string',
 * });
 * ```
 * @category Newsletter
 */
export declare function create(name: string, opts: {
    description?: string;
    picture?: string;
}): Promise<ResultCreateNewsletter>;