smooch

package module

Go to main page

Versions in this module

v0

v0.5.0

Jan 6, 2020

v0.4.2

Dec 17, 2019

v0.4.1

Dec 17, 2019

Changes in this version

+ type SmoochClient struct

+ AppID string

+ Auth string

+ HttpClient *http.Client

+ KeyID string

+ Logger Logger

+ Mtx sync.Mutex

+ Mux *http.ServeMux

+ RedisStorage *storage.RedisStorage

+ Region string

+ Secret string

+ WebhookEventHandlers []WebhookEventHandler

+ func (sc *SmoochClient) AddWebhookEventHandler(handler WebhookEventHandler)

+ func (sc *SmoochClient) DeleteAttachment(attachment *Attachment) (*ResponseData, error)

+ func (sc *SmoochClient) GetAppUser(userID string) (*AppUser, *ResponseData, error)

+ func (sc *SmoochClient) Handler() http.Handler

+ func (sc *SmoochClient) IsJWTExpired() (bool, error)

+ func (sc *SmoochClient) LinkAppUserToChannel(userID, channelType, confirmationType, phoneNumber string) (*AppUser, *ResponseData, error)

+ func (sc *SmoochClient) PreCreateAppUser(userID, surname, givenName string) (*AppUser, *ResponseData, error)

+ func (sc *SmoochClient) RenewToken() (string, error)

+ func (sc *SmoochClient) Send(userID string, message *Message) (*ResponsePayload, *ResponseData, error)

+ func (sc *SmoochClient) SendHSM(userID string, hsmMessage *HsmMessage) (*ResponsePayload, *ResponseData, error)

+ func (sc *SmoochClient) UploadAttachment(r io.Reader, upload AttachmentUpload) (*Attachment, *ResponseData, error)

+ func (sc *SmoochClient) UploadFileAttachment(filepath string, upload AttachmentUpload) (*Attachment, *ResponseData, error)

v0.4.0

Dec 17, 2019

Changes in this version

+ const AuthBasic

+ const AuthJWT

+ const ConfirmationTypeImmediate

+ const ConfirmationTypePrompt

+ const ConfirmationTypeUserActivity

+ const MessageTypeHSM

+ var ErrChannelTypeEmpty = errors.New("channel type is empty")

+ var ErrConfirmationTypeEmpty = errors.New("confirmation type is empty")

+ var ErrGivenNameEmpty = errors.New("givenName is empty")

+ var ErrPhonenumberEmpty = errors.New("phonenumber is empty")

+ var ErrSurnameEmpty = errors.New("surname is empty")

+ var ErrWrongAuth = errors.New("error wrong authentication")

type AppUser

+ HasPaymentInfo bool

type Client

+ LinkAppUserToChannel func(channelType, confirmationType, phoneNumber string) (*AppUser, error)

+ PreCreateAppUser func(userID, surname, givenName string) (*AppUser, error)

+ SendHSM func(userID string, hsmMessage *HsmMessage) (*ResponsePayload, error)

+ type HsmLanguage struct

+ Code string

+ Policy string

+ type HsmLocalizableParams struct

+ Default interface{}

+ type HsmMessage struct

+ Message HsmMessageBody

+ MessageSchema string

+ Received time.Time

+ Role Role

+ func (hm *HsmMessage) MarshalJSON() ([]byte, error)

+ func (hm *HsmMessage) UnmarshalJSON(data []byte) error

+ type HsmMessageBody struct

+ Hsm HsmPayload

+ Type MessageType

+ type HsmPayload struct

+ ElementName string

+ Language HsmLanguage

+ LocalizableParams []HsmLocalizableParams

+ Namespace string

+ type LinkAppConfirmationData struct

+ Type string

+ type LinkAppUserToChannelPayload struct

+ Confirmation LinkAppConfirmationData

+ PhoneNumber string

+ Type string

+ type LinkAppUserToChannelResponse struct

+ AppUser *AppUser

type Options

+ Auth string

+ type PreCreateAppUserPayload struct

+ GivenName string

+ Surname string

+ UserID string

+ type PreCreateAppUserResponse struct

+ AppUser *AppUser

+ type ResponseData struct

+ Flag string

+ HTTPCode int

v0.3.1

Nov 30, 2019

v0.3.0

Nov 29, 2019

v0.2.0

Nov 14, 2019

Changes in this version

+ const JWTExpiration

+ const SourceTypeWhatsApp

+ const TriggerMessageDeliveryChannel

+ const TriggerMessageDeliveryFailure

+ const TriggerMessageDeliveryUser

+ var ErrDecodeToken = errors.New("error decode token")

+ var ErrKeyIDEmpty = errors.New("key id is empty")

+ var ErrRedisNil = errors.New("redis pool is nil")

+ var ErrSecretEmpty = errors.New("secret is empty")

type AppUser

+ Clients []*AppUserClient

+ Email string

+ GivenName string

+ PendingClients []*AppUserClient

+ Properties map[string]interface{}

+ SignedUpAt time.Time

+ Surname string

+ type AppUserClient struct

+ Active bool

+ AppVersion string

+ AvatarURL string

+ Blocked bool

+ DeviceID string

+ DisplayName string

+ ID string

+ Info map[string]interface{}

+ IntegrationId string

+ LastSeen time.Time

+ LinkedAt time.Time

+ Platform string

+ Primary bool

+ Raw map[string]interface{}

+ type Attachment struct

+ MediaType string

+ MediaURL string

+ type AttachmentUpload struct

+ Access string

+ AppUserID string

+ For string

+ MIMEType string

+ UserID string

+ func NewAttachmentUpload(mime string) AttachmentUpload

+ type BytesFileReader struct

+ Filename string

+ func NewBytesFileReader(filename string, b []byte) *BytesFileReader

type Client

+ GetAppUser func(userID string) (*AppUser, error)

+ IsJWTExpired func() (bool, error)

+ RenewToken func() (string, error)

+ UploadAttachment func(r io.Reader, upload AttachmentUpload) (*Attachment, error)

+ UploadFileAttachment func(filepath string, upload AttachmentUpload) (*Attachment, error)

+ type Error struct

+ Code string

+ Message string

+ UnderlyingError map[string]interface{}

+ type GetAppUserResponse struct

+ AppUser *AppUser

type Message

+ MediaURL string

type Options

+ RedisPool *redis.Pool

type Payload

+ Destination *SourceDestination

+ Error *Error

+ IsFinalEvent bool

+ Message *TruncatedMessage

+ type SourceDestination struct

+ Id string

+ IntegrationId string

+ OriginalMessageId string

+ Type string

+ type TruncatedMessage struct

+ ID string

v0.1.0

Apr 24, 2019

Changes in this version

+ const ActionTypeBuy

+ const ActionTypeLink

+ const ActionTypeLocationRequest

+ const ActionTypePostback

+ const ActionTypeReply

+ const ActionTypeShare

+ const ActionTypeWebview

+ const ImageRatioHorizontal

+ const ImageRatioSquare

+ const MessageTypeCarousel

+ const MessageTypeFile

+ const MessageTypeImage

+ const MessageTypeList

+ const MessageTypeLocation

+ const MessageTypeText

+ const RegionEU

+ const RegionUS

+ const RoleAppMaker

+ const RoleAppUser

+ const SizeCompact

+ const SizeLarge

+ const SourceTypeAndroid

+ const SourceTypeApi

+ const SourceTypeIOS

+ const SourceTypeLine

+ const SourceTypeMessenger

+ const SourceTypeTelegram

+ const SourceTypeTwilio

+ const SourceTypeViber

+ const SourceTypeWeChat

+ const SourceTypeWeb

+ const TriggerMessageAppMaker

+ const TriggerMessageAppUser

+ var ErrMessageNil = errors.New("message is nil")

+ var ErrMessageRoleEmpty = errors.New("message.Role is empty")

+ var ErrMessageTypeEmpty = errors.New("message.Type is empty")

+ var ErrUserIDEmpty = errors.New("user id is empty")

+ var ErrVerifySecretEmpty = errors.New("verify secret is empty")

+ func GenerateJWT(scope string, keyID string, secret string) (string, error)

+ func New(o Options) (*smoochClient, error)

+ type Action struct

+ Amount int

+ Currency string

+ Default bool

+ ID string

+ Metadata map[string]interface{}

+ Payload string

+ State string

+ Text string

+ Type ActionType

+ URI string

+ type ActionType string

+ type AppUser struct

+ ConversationStarted bool

+ ID string

+ UserID string

+ type Application struct

+ ID string

+ type Client interface

+ AddWebhookEventHandler func(handler WebhookEventHandler)

+ Handler func() http.Handler

+ Send func(userID string, message *Message) (*ResponsePayload, error)

+ VerifyRequest func(r *http.Request) bool

+ type Conversation struct

+ ID string

+ UnreadCount int

+ type DisplaySettings struct

+ ImageAspectRatio ImageRatio

+ type ErrorDetails struct

+ Code string

+ Description string

+ type ErrorPayload struct

+ Details ErrorDetails

+ type ImageRatio string

+ type Item struct

+ Actions []*Action

+ Description string

+ ID string

+ MediaType string

+ MediaURL string

+ Size Size

+ Title string

+ type Logger interface

+ Debugw func(msg string, keysAndValues ...interface{})

+ Errorw func(msg string, keysAndValues ...interface{})

+ Infow func(msg string, keysAndValues ...interface{})

+ type Menu struct

+ Items []*MenuItem

+ type MenuItem struct

+ ID string

+ Text string

+ Type string

+ URI string

+ type MenuPayload struct

+ Menu Menu

+ type Message struct

+ Actions []*Action

+ AuthorID string

+ DisplaySettings *DisplaySettings

+ ID string

+ Items []*Item

+ MediaUrl string

+ Metadata map[string]interface{}

+ Name string

+ Received time.Time

+ Role Role

+ Source *Source

+ Text string

+ Type MessageType

+ func (m *Message) MarshalJSON() ([]byte, error)

+ func (m *Message) UnmarshalJSON(data []byte) error

+ type MessageType string

+ type Options struct

+ AppID string

+ HttpClient *http.Client

+ KeyID string

+ Logger Logger

+ Mux *http.ServeMux

+ Region string

+ Secret string

+ VerifySecret string

+ WebhookURL string

+ type Payload struct

+ App Application

+ AppUser AppUser

+ Conversation Conversation

+ Messages []*Message

+ Trigger string

+ Version string

+ type ResponsePayload struct

+ Conversation *Conversation

+ ExtraMessages []*Message

+ Message *Message

+ type Role string

+ type Size string

+ type SmoochError struct

+ func (e *SmoochError) Code() int

+ func (e *SmoochError) Error() string

+ type Source struct

+ Type string

+ type WebhookEventHandler func(payload *Payload)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL