talkyzap-wapp-api 1.0.0

package/dist/profile/functions/editBusinessProfile.d.ts

@@ -0,0 +1,177 @@
+/*!
+ * Copyright 2021 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.
+ */
+import { BusinessProfileModel } from '../../whatsapp';
+/**
+ * Update your business profile
+ *
+ * @example
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({description: 'New description for profile'});
+ * ```
+ *
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({categories: {
+    id: "133436743388217",
+    localized_display_name: "Artes e entretenimento",
+    not_a_biz: false,
+  }});
+ * ```
+ *
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({adress: 'Street 01, New York'});
+ * ```
+ *
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({adress: 'Street 01, New York'});
+ * ```
+ *
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({email: 'test@test.com.br'});
+ * ```
+ *
+ * Change website of profile (max 2 sites)
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({website: [
+  "https://www.wppconnect.io",
+  "https://www.teste2.com.br",
+]});
+ * ```
+ *
+ * Change businessHours for Specific Hours
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({ businessHours: {
+ * {
+      tue: {
+        mode: "specific_hours",
+        hours: [
+          [
+            540,
+            1080,
+          ],
+        ],
+      },
+      wed: {
+        mode: "specific_hours",
+        hours: [
+          [
+            540,
+            1080,
+          ],
+        ],
+      },
+      thu: {
+        mode: "specific_hours",
+        hours: [
+          [
+            540,
+            1080,
+          ],
+        ],
+      },
+      fri: {
+        mode: "specific_hours",
+        hours: [
+          [
+            540,
+            1080,
+          ],
+        ],
+      },
+      sat: {
+        mode: "specific_hours",
+        hours: [
+          [
+            540,
+            1080,
+          ],
+        ],
+      },
+      sun: {
+        mode: "specific_hours",
+        hours: [
+          [
+            540,
+            1080,
+          ],
+        ],
+      },
+    }
+  },
+  timezone: "America/Sao_Paulo"
+  });
+ *
+ * Change businessHours for Always Opened
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({ businessHours: {
+    {
+      mon: {
+        mode: "open_24h",
+      },
+      tue: {
+        mode: "open_24h",
+      },
+      wed: {
+        mode: "open_24h",
+      },
+      thu: {
+        mode: "open_24h",
+      },
+      fri: {
+        mode: "open_24h",
+      },
+      sat: {
+        mode: "open_24h",
+      },
+      sun: {
+        mode: "open_24h",
+      },
+    }
+    timezone: "America/Sao_Paulo"
+  });
+ *
+ * Change businessHours for Appointment Only
+ * ```javascript
+ * await WPP.profile.editBusinessProfile({ businessHours: { {
+    mon: {
+      mode: "appointment_only",
+    },
+    tue: {
+      mode: "appointment_only",
+    },
+    wed: {
+      mode: "appointment_only",
+    },
+    thu: {
+      mode: "appointment_only",
+    },
+    fri: {
+      mode: "appointment_only",
+    },
+    sat: {
+      mode: "appointment_only",
+    },
+    sun: {
+      mode: "appointment_only",
+    },
+  }
+    timezone: "America/Sao_Paulo"
+  });
+ *
+ *
+ * ```
+ * @category Profile
+ */
+export declare function editBusinessProfile(params: BusinessProfileModel): Promise<any>;

package/dist/profile/functions/getMyProfileName.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Copyright 2021 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.
+ */
+/**
+ * Get your current profile name
+ *
+ * @example
+ * ```javascript
+ * const myProfileName = WPP.profile.getMyProfileName();
+ * ```
+ *
+ * @category Profile
+ */
+export declare function getMyProfileName(): string;

package/dist/profile/functions/getMyStatus.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Copyright 2021 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.
+ */
+/**
+ * Get your current text status
+ *
+ * @example
+ * ```javascript
+ * await WPP.profile.getMyStatus();
+ * ```
+ *
+ * @category Profile
+ */
+export declare function getMyStatus(): Promise<string | undefined>;

package/dist/profile/functions/index.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * Copyright 2021 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 { editBusinessProfile } from './editBusinessProfile';
+export { getMyProfileName } from './getMyProfileName';
+export { getMyStatus } from './getMyStatus';
+export { isBusiness } from './isBusiness';
+export { removeMyProfilePicture } from './removeMyProfilePicture';
+export { setMyProfileName } from './setMyProfileName';
+export { setMyProfilePicture } from './setMyProfilePicture';
+export { setMyStatus } from './setMyStatus';

package/dist/profile/functions/isBusiness.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * Copyright 2021 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.
+ */
+/**
+ * Return the current logged user is Bussiness or not
+ *
+ * @example
+ * ```javascript
+ * WPP.profile.isBusiness();
+ * ```
+ * @category Profile
+ */
+export declare function isBusiness(): boolean | undefined;

package/dist/profile/functions/removeMyProfilePicture.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * 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.
+ */
+/**
+ * Remove your profile picture
+ *
+ * @example
+ * ```javascript
+ * await WPP.profile.removeMyProfilePicture();
+ * ```
+ *
+ * @category Profile
+ */
+export declare function removeMyProfilePicture(): Promise<boolean>;

package/dist/profile/functions/setMyProfileName.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Copyright 2021 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.
+ */
+/**
+ * Update your current profile name
+ *
+ * @example
+ * ```javascript
+ * await WPP.profile.setMyProfileName('My new name');
+ * ```
+ *
+ * @category Profile
+ */
+export declare function setMyProfileName(name: string): Promise<boolean>;

package/dist/profile/functions/setMyProfilePicture.d.ts

@@ -0,0 +1,32 @@
+/*!
+ * Copyright 2021 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.
+ */
+/**
+ * Update your profile picture
+ *
+ * @example
+ * ```javascript
+ * await WPP.profile.setMyProfilePicture('data:image/jpeg;base64,.....');
+ * ```
+ *
+ * @category Profile
+ */
+export declare function setMyProfilePicture(content: string): Promise<{
+    eurl: string;
+    status: number;
+    tag: string;
+    token: string;
+    _duplicate: boolean;
+}>;

package/dist/profile/functions/setMyStatus.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Copyright 2021 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.
+ */
+/**
+ * Update your current text status
+ *
+ * @example
+ * ```javascript
+ * await WPP.profile.setMyStatus('Example text');
+ * ```
+ *
+ * @category Profile
+ */
+export declare function setMyStatus(statusText: string): Promise<boolean>;

package/dist/profile/index.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright 2021 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 * from './functions';

package/dist/status/defaultSendStatusOptions.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * Copyright 2021 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.
+ */
+import { SendStatusOptions } from './functions/sendRawStatus';
+import { TextStatusOptions } from './functions/sendTextStatus';
+export type AllStatusOptions = SendStatusOptions & TextStatusOptions;
+export declare const defaultSendStatusOptions: AllStatusOptions;

package/dist/status/events/eventTypes.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * Copyright 2021 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 StatusEventTypes {
+    'status.sync': undefined;
+}

package/dist/status/events/index.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright 2021 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.
+ */
+import './registerSyncedEvent';

package/dist/status/events/registerSyncedEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright 2021 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 {};

package/dist/status/functions/get.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * Copyright 2021 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.
+ */
+import { StatusV3Model, Wid } from '../../whatsapp';
+export declare function get(chatId: string | Wid): StatusV3Model | undefined;

package/dist/status/functions/getMyStatus.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * Copyright 2021 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.
+ */
+import { StatusV3Model } from '../../whatsapp';
+export declare function getMyStatus(): Promise<StatusV3Model>;

package/dist/status/functions/index.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * Copyright 2021 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 { get } from './get';
+export { getMyStatus } from './getMyStatus';
+export { ImageStatusOptions, sendImageStatus } from './sendImageStatus';
+export { sendRawStatus, SendStatusOptions } from './sendRawStatus';
+export { sendReadStatus } from './sendReadStatus';
+export { sendTextStatus, TextStatusOptions } from './sendTextStatus';
+export { sendVideoStatus, VideoStatusOptions } from './sendVideoStatus';
+export { updateParticipants } from './updateParticipants';

package/dist/status/functions/postSendStatus.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * Copyright 2021 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.
+ */
+import { SendMessageReturn } from '../../chat';
+export declare function postSendStatus(result: SendMessageReturn): void;

package/dist/status/functions/sendImageStatus.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Copyright 2021 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.
+ */
+import { SendStatusOptions } from './sendRawStatus';
+export type ImageStatusOptions = SendStatusOptions;
+/**
+ * Send a image message to status stories
+ *
+ * @example
+ * ```javascript
+ * WPP.status.sendImageStatus('data:image/jpeg;base64,<a long base64 file...>');
+ * ```
+ */
+export declare function sendImageStatus(content: any, options?: ImageStatusOptions): Promise<any>;

package/dist/status/functions/sendRawStatus.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * Copyright 2021 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.
+ */
+import * as Chat from '../../chat';
+import { MsgKey } from '../../whatsapp';
+export interface SendStatusOptions {
+    waitForAck?: boolean;
+    messageId?: string | MsgKey;
+}
+export declare function sendRawStatus(message: Chat.RawMessage, options?: SendStatusOptions): Promise<Chat.SendMessageReturn>;

package/dist/status/functions/sendReadStatus.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * Copyright 2022 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.
+ */
+import { Wid } from '../../whatsapp';
+/**
+ * Mark status as read/seen
+ *
+ * @example
+ * ```javascript
+ * WPP.status.sendReadStatus('[phone_number]@c.us', 'false_status@broadcast_3A169E0FD4BC6E92212F_5521526232927@c.us');
+ * ```
+ */
+export declare function sendReadStatus(chatId: string | Wid, statusId: string): Promise<any>;

package/dist/status/functions/sendTextStatus.d.ts

@@ -0,0 +1,31 @@
+/*!
+ * Copyright 2021 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.
+ */
+import { TextFontStyle } from '../../enums';
+import { SendStatusOptions } from './sendRawStatus';
+export interface TextStatusOptions extends SendStatusOptions {
+    font?: TextFontStyle;
+    backgroundColor?: string | number;
+    textColor?: string | number;
+}
+/**
+ * Send a text message to status stories
+ *
+ * @example
+ * ```javascript
+ * WPP.status.sendTextStatus(`Bootstrap primary color: #0275d8`, { backgroundColor: '#0275d8', font: 2});
+ * ```
+ */
+export declare function sendTextStatus(content: any, options?: TextStatusOptions): Promise<any>;