Module sakari

ballerinax/sakari Ballerina library

1.5.2

Overview

The Sakari connector(https://sakari.io/) OpenAPI Specification.

Sakari provides an advanced platform to drive large scale customized SMS communication. To find out more about our product offering, please visit https://sakari.io.

This module supports Sakari REST API v1.0.1.

Key Features

Programmatic access to create and manage resources via REST API
Manage user accounts and profiles
Secure authentication with API key or OAuth support

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Create Sakari developer account
Obtain tokens - Login into https://hub.sakari.io and obtain tokens following this guide

Quickstart

To use the Sakari connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/sakari module into the Ballerina project.


import ballerinax/sakari;

Step 2: Create a new connector instance

You can now make the connection configuration using the obtained credentials.


sakari:ClientConfig configuration = {
    auth: {
        clientId: <>,
        clientSecret: <>,
        tokenUrl: "https://api.sakari.io/oauth2/token"   
    }
};

sakari:Client sakariClient = check new Client(configuration);

Step 3: Invoke the operation

Now you can use the operations available within the connector. Following code demonstrates how to fetch all Sakari contacts.


public function main() returns error? {
    string accountId = <ACCOUNT_ID>;
    sakari:ContactsResponse contactsResponse = check sakariClient->fetchAllContacts(accountId);
}

Use bal run command to compile and run the Ballerina program.

Clients

sakari: Client

Isolated

This is a generated connector from Sakari OpenAPI Specification. Sakari provides an advanced platform to drive large scale customized SMS communication To find out more about our product offering, please visit https://sakari.io.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Please create a Sakari account and obtain tokens following this guide

init (ConnectionConfig config, string serviceUrl)

config ConnectionConfig - The configurations to be used when initializing the connector

serviceUrl string "https://api.sakari.io/v1" - URL of the target service

authToken

Isolated FunctionRemote Function

function authToken(TokenRequest payload) returns TokenResponse|error

Get token for accessing APIs

Parameters

payload TokenRequest - Request payload for obtaining token

Return Type

TokenResponse|error - successful operation

fetchAllContacts

Isolated FunctionRemote Function

function fetchAllContacts(string accountId, int? offset, int? 'limit, string? firstName, string? lastName, string? mobile, string? email, string? tags) returns ContactsResponse|error

Fetch contacts

Parameters

accountId string - Account to apply operations to

offset int? (default ()) - Results to skip when paginating through a result set

'limit int? (default ()) - Maximum number of results to return

firstName string? (default ()) - Filter by first name or part of

lastName string? (default ()) - Filter by last name or part of

mobile string? (default ()) - Filter by mobile or part of

email string? (default ()) - Filter by email or part of

tags string? (default ()) - Filter by tag(s)

Return Type

ContactsResponse|error - successful operation

createContact

Isolated FunctionRemote Function

function createContact(string accountId, ContactRequest payload, string? mergeStrategy) returns InlineResponse201|error

Create contact

Parameters

accountId string - Account to apply operations to

payload ContactRequest - Create contact request payload

mergeStrategy string? (default ()) - Determines how existing contacts with matching mobile numbers are treated

Return Type

InlineResponse201|error - successful operation

fetchContact

Isolated FunctionRemote Function

function fetchContact(string accountId, string contactId) returns ContactResponse|error

Fetch contact by ID

Parameters

accountId string - Account to apply operations to

contactId string - ID of contact to return

Return Type

ContactResponse|error - successful operation

contactsUpdate

Isolated FunctionRemote Function

function contactsUpdate(string accountId, string contactId) returns ContactResponse|error

Updates a contact

Parameters

accountId string - Account to apply operations to

contactId string - ID of contact

Return Type

ContactResponse|error - successful operation

removeContact

Isolated FunctionRemote Function

function removeContact(string accountId, string contactId) returns InlineResponse200|error

Deletes a contact

Parameters

accountId string - Account to apply operations to

contactId string - Contact id to delete

Return Type

InlineResponse200|error - successful operation

fetchAllMessages

Isolated FunctionRemote Function

function fetchAllMessages(string accountId, int? offset, int? 'limit, string? contactId, string? conversationId) returns MessagesResponse|error

Fetch messages

Parameters

accountId string - Account to apply operations to

offset int? (default ()) - Results to skip when paginating through a result set

'limit int? (default ()) - Maximum number of results to return

contactId string? (default ()) - ID of contact

conversationId string? (default ()) - ID of conversation

Return Type

MessagesResponse|error - successful operation

sendMessage

Isolated FunctionRemote Function

function sendMessage(string accountId, SendMessagesRequest payload) returns SendMessagesResponse|error

Send Messages

Parameters

accountId string - Account to apply operations to

payload SendMessagesRequest - Send message request payload

Return Type

SendMessagesResponse|error - successful operation

fetchMessages

Isolated FunctionRemote Function

function fetchMessages(string accountId, string messageId) returns MessageResponse|error

Fetch message by id

Parameters

accountId string - Account to apply operations to

messageId string - ID of message to return

Return Type

MessageResponse|error - successful operation

fetchAllTemplates

Isolated FunctionRemote Function

function fetchAllTemplates(string accountId, int? offset, int? 'limit, string? name) returns TemplatesResponse|error

Fetch templates

Parameters

accountId string - Account to apply operations to

offset int? (default ()) - Results to skip when paginating through a result set

'limit int? (default ()) - Maximum number of results to return

name string? (default ()) - Filter by name or part of

Return Type

TemplatesResponse|error - successful operation

createTemplate

Isolated FunctionRemote Function

function createTemplate(string accountId, TemplateRequest payload) returns TemplatesResponse|error

Create template

Parameters

accountId string - Account to apply operations to

payload TemplateRequest - Create template request payload.

Return Type

TemplatesResponse|error - successful operation

fetchTemplate

Isolated FunctionRemote Function

function fetchTemplate(string accountId, string templateId) returns TemplateResponse|error

Fetch template by ID

Parameters

accountId string - Account to apply operations to

templateId string - ID of template to return

Return Type

TemplateResponse|error - successful operation

updateTemplate

Isolated FunctionRemote Function

function updateTemplate(string accountId, string templateId) returns TemplateResponse|error

Updates a template

Parameters

accountId string - Account to apply operations to

templateId string - ID of template

Return Type

TemplateResponse|error - successful operation

removeTemplate

Isolated FunctionRemote Function

function removeTemplate(string accountId, string templateId) returns InlineResponse200|error

Deletes a template

Parameters

accountId string - Account to apply operations to

templateId string - Template id to delete

Return Type

InlineResponse200|error - successful operation

fetchAllCampaigns

Isolated FunctionRemote Function

function fetchAllCampaigns(string accountId, int? offset, int? 'limit, string? name) returns CampaignsResponse|error

Fetch campaigns

Parameters

accountId string - Account to apply operations to

offset int? (default ()) - Results to skip when paginating through a result set

'limit int? (default ()) - Maximum number of results to return

name string? (default ()) - Filter by name or part of

Return Type

CampaignsResponse|error - successful operation

createCampaigns

Isolated FunctionRemote Function

function createCampaigns(string accountId, CampaignRequest payload) returns CampaignResponse|error

Create campaign

Parameters

accountId string - Account to apply operations to

payload CampaignRequest - Create campaign request payload

Return Type

CampaignResponse|error - successful operation

fetchCampaign

Isolated FunctionRemote Function

function fetchCampaign(string accountId, string campaignId) returns CampaignResponse|error

Fetch campaign by ID

Parameters

accountId string - Account to apply operations to

campaignId string - ID of campaign to return

Return Type

CampaignResponse|error - successful operation

updateCampaign

Isolated FunctionRemote Function

function updateCampaign(string accountId, string campaignId) returns CampaignResponse|error

Updates a campaign

Parameters

accountId string - Account to apply operations to

campaignId string - ID of campaign

Return Type

CampaignResponse|error - successful operation

removeCampaign

Isolated FunctionRemote Function

function removeCampaign(string accountId, string campaignId) returns InlineResponse200|error

Deletes a campaign

Parameters

accountId string - Account to apply operations to

campaignId string - Campaign id to delete

Return Type

InlineResponse200|error - successful operation

fetchAllConversations

Isolated FunctionRemote Function

function fetchAllConversations(string accountId, int? offset, int? 'limit) returns ConversationsResponse|error

Fetch conversations

Parameters

accountId string - Account to apply operations to

offset int? (default ()) - Results to skip when paginating through a result set

'limit int? (default ()) - Maximum number of results to return

Return Type

ConversationsResponse|error - successful operation

fetchConversation

Isolated FunctionRemote Function

function fetchConversation(string accountId, string conversationId) returns ConversationResponse|error

Fetch conversation by ID

Parameters

accountId string - Account to apply operations to

conversationId string - ID of template to return

Return Type

ConversationResponse|error - successful operation

closeConversation

Isolated FunctionRemote Function

function closeConversation(string accountId, string conversationId) returns ConversationResponse|error

Closes a conversation

Parameters

accountId string - Account to apply operations to

conversationId string - ID of conversation

Return Type

ConversationResponse|error - successful operation

shareFile

Isolated FunctionRemote Function

function shareFile(byte[] payload) returns ShareFileResponse|error

Share file - use to host a file and generate a short link to be used directly in a message or as a link to media for a MMS

Parameters

payload byte[] - Binary form of the file

Return Type

ShareFileResponse|error - successful operation

fetchAllWebhooks

Isolated FunctionRemote Function

function fetchAllWebhooks(string accountId) returns WebhooksResponse|error

Fetch active webhooks

Parameters

accountId string - Account to apply operations to

Return Type

WebhooksResponse|error - successful operation

subscribeWebhooks

Isolated FunctionRemote Function

function subscribeWebhooks(string accountId, AccountidWebhooksBody payload) returns WebhookResponse|error

Subscribe to message events

Parameters

accountId string - Account to apply operations to

payload AccountidWebhooksBody - Message event subscribe request payload

Return Type

WebhookResponse|error - successful operation

unsubscribeWebhooks

Isolated FunctionRemote Function

function unsubscribeWebhooks(string accountId, string url) returns Response|error

Unsubscribe to message events

Parameters

accountId string - Account to apply operations to

url string - Account to apply operations to

Return Type

Response|error - successful operation

Records

sakari: AccountEvent

Fields

'type? EventType - Type of the event

accountId? AccountId - Id of the account to apply operations to

sakari: AccountEventPayload

Fields

balance? decimal -

sakari: AccountidWebhooksBody

Fields

url? string -

eventTypes? string[] -

Fields

name? string -

comparator? string -

value? string -

sakari: Campaign

Fields

id? string -

sakari: CampaignRequest

Fields

trigger? CampaignrequestTrigger -

filters? CampaignrequestFilters -

template? string -

sakari: CampaignrequestFilters

Fields

contacts? string[] -

tags? string[] -

attributes? string[] -

sakari: CampaignrequestTrigger

Fields

code? string - Campaign type specifies how it sources contacts and what event triggers its execution Sort order
- M - Manual
- S - Scheduled
- FU - File Upload

sakari: CampaignResponse

Fields

success? boolean -

data? Campaign -

sakari: CampaignsResponse

Fields

Fields Included from *PaginatedResponse

success boolean
pagination PaginatedresponsePagination
error PaginatedresponseError
anydata...

data? Campaign[] -

sakari: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields

keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests

chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

proxy? ProxyConfig - Proxy server related options

sakari: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

auth OAuth2ClientCredentialsGrantConfig - Configurations related to client authentication

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol

http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol

timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache? CacheConfig - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker

retryConfig? RetryConfig - Configurations associated with retrying

responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

sakari: Contact

Fields

Fields Included from *ContactRequest

tags Tag[]
attributes record { anydata... }
id string
email string
firstName string
lastName string
mobile ContactidentifiersMobile
anydata...

valid? boolean - Validity

'error? Error - Represent API error

created? Updated - Represent resource update details

updated? Updated - Represent resource update details

sakari: ContactIdentifiers

Contact information

Fields

id? string - Contact information Id

email? string - Email address

firstName? string - First name

lastName? string - Last name

mobile? ContactidentifiersMobile - Mobile number

sakari: ContactidentifiersMobile

Mobile number

Fields

country? string - Country code

number? string - Mobile number

sakari: ContactRequest

Fields

Fields Included from *ContactIdentifiers

id string
email string
firstName string
lastName string
mobile ContactidentifiersMobile
anydata...

tags? Tag[] -

attributes? record {} -

sakari: ContactResponse

Contact response

Fields

success? boolean - Whether the request is success or not

data? Contact -

sakari: ContactsResponse

Fields

Fields Included from *PaginatedResponse

success boolean
pagination PaginatedresponsePagination
error PaginatedresponseError
anydata...

data? Contact[] -

sakari: ContactUploadResponse

Contact upload response

Fields

success? boolean - Whether the request is success

data? ContactuploadresponseData -

sakari: ContactuploadresponseData

Fields

contacts? Contact[] - Uploaded contacts

errors? Contact[] - Contacts that failed validation

submitted? int -

inserted? int -

updated? int -

success? int -

sakari: Conversation

Fields

id? string -

contact? ContactIdentifiers - Contact information

closed? boolean -

lastMessage? Message -

phoneNumber? PhoneNumber - Phone number resource

unread? string[] -

created? Updated - Represent resource update details

updated? Updated - Represent resource update details

sakari: ConversationResponse

Fields

success? boolean -

data? Conversation -

sakari: ConversationsResponse

Fields

Fields Included from *PaginatedResponse

success boolean
pagination PaginatedresponsePagination
error PaginatedresponseError
anydata...

data? Conversation[] -

sakari: Error

Represent API error

Fields

code? string - Error code

description? string - Error message

sakari: ErrorResponse

Represent response error

Fields

success? boolean - Whether the request is success

'error? ErrorresponseError - Represent error

sakari: ErrorresponseError

Represent error

Fields

code? string - Error code

message? string - Error message

sakari: Event

Fields

eventId? string -

'type? EventType - Type of the event

accountId? AccountId - Id of the account to apply operations to

data? AccountEventPayload|MessageEventPayload -

sakari: InlineResponse200

Fields

success? boolean -

sakari: Message

Fields

id? string -

contact? ContactIdentifiers - Contact information

conversation? MessageConversation -

message? string -

template? string -

outgoing? boolean -

phoneNumber? string -

price? decimal -

segments? decimal -

read? boolean -

status? string -

media? MessageMedia[] - List of media objects attached to message

'error? Error - Represent API error

created? Updated - Represent resource update details

updated? Updated - Represent resource update details

sakari: MessageConversation

Fields

id? string -

sakari: MessageEventPayload

Fields

contact? ContactIdentifiers - Contact information

message? string -

status? string -

'error? string -

sakari: MessageMedia

Fields

url? string -

'type? string -

filename? string -

sakari: MessageResponse

Fields

success? boolean -

data? Message -

sakari: MessagesResponse

Fields

Fields Included from *PaginatedResponse

success boolean
pagination PaginatedresponsePagination
error PaginatedresponseError
anydata...

data? Message[] -

sakari: OAuth2ClientCredentialsGrantConfig

Closed record

OAuth2 Client Credentials Grant Configs

Fields

Fields Included from *OAuth2ClientCredentialsGrantConfig

tokenUrl string
clientId string
clientSecret string
scopes string|string[]
defaultTokenExpTime decimal
clockSkew decimal
optionalParams map<string>
credentialBearer CredentialBearer
clientConfig ClientConfiguration

tokenUrl string(default "https://api.sakari.io/oauth2/token") - Token URL

sakari: PaginatedResponse

Pagination response

Fields

success? boolean - Success

pagination? PaginatedresponsePagination -

'error? PaginatedresponseError - Represent an API pagination error

sakari: PaginatedresponseError

Represent an API pagination error

Fields

code? string - Error code

message? string - Error message

sakari: PaginatedresponsePagination

Fields

totalCount? int - Total record count

'limit? int - Per page count

offset? int - Page offset

sakari: PhoneNumber

Phone number resource

Fields

country? string - Country code

number? string - Phone number

active? boolean - Whether phone number is active

sakari: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields

host string(default "") - Host name of the proxy server

port int(default 0) - Proxy server port

userName string(default "") - Proxy server username

password string(default "") - Proxy server password

sakari: SendMessagesRequest

Fields

conversations? string[] - List of conversation ids to send messages to

contacts? ContactRequest[] -

filters? SendmessagesrequestFilters -

template? string -

'type? string -

media? SendmessagesrequestMedia[] - List of media objects to attach to message

conversationStrategy? string -

sakari: SendmessagesrequestFilters

Fields

tags? string[] -

attributes? record {}[] -

sakari: SendmessagesrequestMedia

Fields

url? string -

sakari: SendMessagesResponse

Fields

data? SendmessagesresponseData -

sakari: SendmessagesresponseData

Fields

messages? Message[] -

jobId? string -

queued? int -

estimatedPrice? decimal -

sakari: ShareFileResponse

Fields

success? boolean -

data? SharefileresponseData -

sakari: SharefileresponseData

Fields

link? string -

expires? string -

sakari: Tag

Filter by tag(s)

Fields

tag? string - Tag type

visible? boolean - Whether visible

sakari: Template

Fields

Fields Included from *TemplateRequest

name string
type string
template string
anydata...

id? string -

sakari: TemplateRequest

Fields

name? string -

'type? string -

template? string -

sakari: TemplateResponse

Fields

success? boolean -

data? Template -

sakari: TemplatesResponse

Fields

Fields Included from *PaginatedResponse

success boolean
pagination PaginatedresponsePagination
error PaginatedresponseError
anydata...

data? Template[] -

sakari: TokenRequest

Get token for accessing the API

Fields

grant_type? string - Grant type

client_id? string - Client Id

client_secret? string - Client secret

sakari: TokenResponse

Fields

access_token? string - Access token

token_type? string - Token type

sakari: ToolsSharefileBody

Fields

media? string -

sakari: Updated

Represent resource update details

Fields

at? string - Updated date time

'by? UpdatedBy - Updated by

sakari: UpdatedBy

Updated by

Fields

id? string - Id of the update author

firstName? string - First name of the update author

lastName? string - Last name of the update author

sakari: Webhook

Fields

url? string -

eventTypes? string[] -

sakari: WebhookResponse

Fields

success? boolean -

data? Webhook -

sakari: WebhooksResponse

Fields

Fields Included from *PaginatedResponse

success boolean
pagination PaginatedresponsePagination
error PaginatedresponseError
anydata...

data? Webhook[] -

Union types

sakari: InlineResponse201

ContactsResponse|ContactUploadResponse

InlineResponse201

String types

sakari: AccountId

string

AccountId

Id of the account to apply operations to

sakari: EventType

string

EventType

Type of the event

Import

import ballerinax/sakari;

Other versions

1.5.2

1.5.1 1.5.0 1.4.0 1.2.0

Metadata

Released date: 3 days ago

Version: 1.5.2

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.8.0

GraalVM compatible: Yes

Pull count

Total: 25

Current verison: 0

Weekly downloads

Source repository

Keywords

Type/Connector

Vendor/Sakari

Area/Communication

Communication/Call & SMS

Cost/Paid

Contributors

Dependencies

ballerina/url/2.4.0 ballerina/http/2.10.24

Cookie policy

Delete policy

clients

records

unionTypes

stringTypes

ballerinax/sakari Ballerina library

Overview

Key Features

Prerequisites

Quickstart

Step 1: Import connector

Step 2: Create a new connector instance

Step 3: Invoke the operation

Clients

sakari: Client

Constructor

authToken

Parameters

Return Type

fetchAllContacts

Parameters

Return Type

createContact

Parameters

Return Type

fetchContact

Parameters

Return Type

contactsUpdate

Parameters

Return Type

removeContact

Parameters

Return Type

fetchAllMessages

Parameters

Return Type

sendMessage

Parameters

Return Type

fetchMessages

Parameters

Return Type

fetchAllTemplates

Parameters

Return Type

createTemplate

Parameters

Return Type

fetchTemplate

Parameters

Return Type

updateTemplate

Parameters

Return Type

removeTemplate

Parameters

Return Type

fetchAllCampaigns

Parameters

Return Type

createCampaigns

Parameters

Return Type

fetchCampaign

Parameters

Return Type

updateCampaign

Parameters

Return Type

removeCampaign

Parameters

Return Type

fetchAllConversations

Parameters

Return Type

fetchConversation

Parameters

Return Type

closeConversation

Parameters