# README
The official Go library for ClickSend v3 API
This is the official ClickSend SDK. Documentation can be found here.
Requirements
- Sign Up for a free ClickSend account.
- Copy your API key from the API Credentials area.
Installation
Put the package under your project folder and add the following in import:
import "./clicksend"
Documentation
Documentation for our SDK and REST API can be found here.
Documentation For Authorization
BasicAuth
- Type: HTTP basic authentication
Example
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
# Functions
CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
# Structs
Complete account details needed for the user.
No description provided by the author
Verifies an account by token that should have been sent to the user's phone.
Base model for all address-related objects.
No description provided by the author
No description provided by the author
APIClient manages communication with the ClickSend v3 API API v3.1 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
Email attachment.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
No description provided by the author
Contains all details for the main contact.
Your contact list.
Contact list import model.
Credit card model.
All dates before specified timestam.
Issues with message delivery.
No description provided by the author
Model for a Delivery Receipt.
Send Email.
No description provided by the author
Campaign Model for Email.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
From Email object.
No description provided by the author
No description provided by the author
Recipient of an email, either To, Cc, or Bcc.
Email-to-SMS Allowed Address.
Model for Email Templates.
No description provided by the author
Model for Email Templates.
No description provided by the author
No description provided by the author
No description provided by the author
Base model for Fax Messages.
Array of FaxMessage items.
No description provided by the author
No description provided by the author
Contains all details for the main contact.
From Email object.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GenericSwaggerError Provides access to the body, error and model on returned errors.
Model for Inbound FAX Rules.
Model for Inbound SMS Rules.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Campaign Model for MMS.
No description provided by the author
Single MMS message model.
Array of MmsMessage items.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PostLetter model.
No description provided by the author
PostPostcard model.
No description provided by the author
PostRecipient model.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ResellerAccount model.
No description provided by the author
ResellerAccountTransferCredit model.
No description provided by the author
Campaign Model for SMS.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SmsMessage model.
Array of SmsMessage items.
No description provided by the author
No description provided by the author
SmsTemplate model.
No description provided by the author
String to be stripped.
Accounts that are maintained under a main account.
No description provided by the author
No description provided by the author
Your file to be uploaded.
Your url.
No description provided by the author
No description provided by the author
VoiceMessage fields: source, to, list_id, body, lang, voice, schedule, custom_string, country.
Array of VoiceMessage items.
No description provided by the author
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author