Categorygithub.com/aldinokemal/sdk-go-whatsapp-web-multidevice
repositorypackage
0.0.0-20240907012813-c0e390372773
Repository: https://github.com/aldinokemal/sdk-go-whatsapp-web-multidevice.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# README

Go API client for sdk_go_whatsapp_web_multidevice

This API is used for sending whatsapp via API

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 4.2.0
  • Package version: 1.0.0
  • Generator version: 7.9.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sdk_go_whatsapp_web_multidevice "github.com/aldinokemal/sdk-go-whatsapp-web-multidevice"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sdk_go_whatsapp_web_multidevice.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sdk_go_whatsapp_web_multidevice.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sdk_go_whatsapp_web_multidevice.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sdk_go_whatsapp_web_multidevice.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sdk_go_whatsapp_web_multidevice.ContextOperationServerIndices and sdk_go_whatsapp_web_multidevice.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sdk_go_whatsapp_web_multidevice.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sdk_go_whatsapp_web_multidevice.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost:3000

ClassMethodHTTP requestDescription
AppAPIAppDevicesGet /app/devicesGet list connected devices
AppAPIAppLoginGet /app/loginLogin to whatsapp server
AppAPIAppLoginWithCodeGet /app/login-with-codeLogin with pairing code
AppAPIAppLogoutGet /app/logoutRemove database and logout
AppAPIAppReconnectGet /app/reconnectReconnecting to whatsapp server
GroupAPIAddParticipantToGroupPost /group/participantsAdding more participants to group
GroupAPICreateGroupPost /groupCreate group and add participant
GroupAPIDemoteParticipantToMemberPost /group/participants/demoteDemote participants to member
GroupAPIJoinGroupWithLinkPost /group/join-with-linkJoin group with link
GroupAPILeaveGroupPost /group/leaveLeave group
GroupAPIPromoteParticipantToAdminPost /group/participants/promotePromote participants to admin
GroupAPIRemoveParticipantFromGroupPost /group/participants/removeRemove participants from group
MessageAPIDeleteMessagePost /message/{message_id}/deleteDelete Message
MessageAPIReactMessagePost /message/{message_id}/reactionSend reaction to message
MessageAPIRevokeMessagePost /message/{message_id}/revokeRevoke Message
MessageAPIUpdateMessagePost /message/{message_id}/updateEdit message by message ID before 15 minutes
SendAPISendAudioPost /send/audioSend Audio
SendAPISendContactPost /send/contactSend Contact
SendAPISendFilePost /send/fileSend File
SendAPISendImagePost /send/imageSend Image
SendAPISendLinkPost /send/linkSend Link
SendAPISendLocationPost /send/locationSend Location
SendAPISendMessagePost /send/messageSend Message
SendAPISendPollPost /send/pollSend Poll / Vote
SendAPISendVideoPost /send/videoSend Video
UserAPIUserAvatarGet /user/avatarUser Avatar
UserAPIUserInfoGet /user/infoUser Info
UserAPIUserMyGroupsGet /user/my/groupsUser My List Groups
UserAPIUserMyPrivacyGet /user/my/privacyUser My Privacy Setting

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author