Ballerina library

sakari

Module sakari

OverviewPrerequisitesQuickstart

API

Client

Definitions

AccountEvent
AccountEventPayload
AccountidWebhooksBody
AttributeFilter
Campaign
CampaignRequest
CampaignrequestFilters
CampaignrequestTrigger
CampaignResponse
CampaignsResponse
ClientHttp1Settings
ConnectionConfig
Contact
ContactIdentifiers
ContactidentifiersMobile
ContactRequest
ContactResponse
ContactsResponse
ContactUploadResponse
ContactuploadresponseData
Conversation
ConversationResponse
ConversationsResponse
Error
ErrorResponse
ErrorresponseError
Event
InlineResponse200
Message
MessageConversation
MessageEventPayload
MessageMedia
MessageResponse
MessagesResponse
OAuth2ClientCredentialsGrantConfig
PaginatedResponse
PaginatedresponseError
PaginatedresponsePagination
PhoneNumber
ProxyConfig
SendMessagesRequest
SendmessagesrequestFilters
SendmessagesrequestMedia
SendMessagesResponse
SendmessagesresponseData
ShareFileResponse
SharefileresponseData
Tag
Template
TemplateRequest
TemplateResponse
TemplatesResponse
TokenRequest
TokenResponse
ToolsSharefileBody
Updated
UpdatedBy
Webhook
WebhookResponse
WebhooksResponse

InlineResponse201

AccountId
EventType

ballerinax/sakari Ballerina library

1.5.1

Overview

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.

This module supports Sakari REST API v1.0.1.

Prerequisites

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

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.

Copy
import ballerinax/sakari;

Step 2: Create a new connector instance

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

Copy
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

  1. Now you can use the operations available within the connector. Following code demonstrates how to fetch all Sakari contacts.
Copy
public function main() returns error? {
    string accountId = <ACCOUNT_ID>;
    sakari:ContactsResponse contactsResponse = check sakariClient->fetchAllContacts(accountId);
}
  1. 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
Return Type

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

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
  • mergeStrategy string? (default ()) - Determines how existing contacts with matching mobile numbers are treated
Return Type

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

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

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

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

sendMessage

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

Send Messages

Parameters
  • accountId string - Account to apply operations to
Return Type

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

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

createTemplate

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

Create template

Parameters
  • accountId string - Account to apply operations to
Return Type

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

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

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

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

createCampaigns

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

Create campaign

Parameters
  • accountId string - Account to apply operations to
Return Type

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

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

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

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

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

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

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

fetchAllWebhooks

Isolated FunctionRemote Function
function fetchAllWebhooks(string accountId) returns WebhooksResponse|error

Fetch active webhooks

Parameters
  • accountId string - Account to apply operations to
Return Type

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
Return Type

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

Records

sakari: AccountEvent

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

sakari: AccountEventPayload

Fields

sakari: AccountidWebhooksBody

Fields

sakari: AttributeFilter

Fields

sakari: Campaign

Fields

sakari: CampaignRequest

Fields

sakari: CampaignrequestFilters

Fields

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

sakari: CampaignsResponse

Fields

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

sakari: ConnectionConfig

Closed record

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

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • 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
  • 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
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

sakari: Contact

Fields
  • '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
  • firstName string? - First name

sakari: ContactidentifiersMobile

Mobile number

Fields
  • country string? - Country code
  • number string? - Mobile number

sakari: ContactRequest

Fields
  • attributes record {}? -

sakari: ContactResponse

Contact response

Fields
  • success boolean? - Whether the request is success or not

sakari: ContactsResponse

Fields

sakari: ContactUploadResponse

Contact upload response

Fields
  • success boolean? - Whether the request is success

sakari: ContactuploadresponseData

Fields
  • contacts Contact[]? - Uploaded contacts
  • errors Contact[]? - Contacts that failed validation
  • submitted int? -
  • inserted int? -
  • updated int? -
  • success int? -

sakari: Conversation

Fields
  • created Updated? - Represent resource update details
  • updated Updated? - Represent resource update details

sakari: ConversationResponse

Fields

sakari: ConversationsResponse

Fields

sakari: Error

Represent API error

Fields
  • description string? - Error message

sakari: ErrorResponse

Represent response error

Fields
  • success boolean? - Whether the request is success

sakari: ErrorresponseError

Represent error

Fields
  • message string? - Error message

sakari: Event

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

sakari: InlineResponse200

Fields

sakari: Message

Fields
  • 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

sakari: MessageEventPayload

Fields

sakari: MessageMedia

Fields

sakari: MessageResponse

Fields

sakari: MessagesResponse

Fields

sakari: OAuth2ClientCredentialsGrantConfig

Closed record

OAuth2 Client Credentials Grant Configs

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

sakari: PaginatedResponse

Pagination response

Fields

sakari: PaginatedresponseError

Represent an API pagination error

Fields
  • 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
  • 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
  • conversationStrategy string? -

sakari: SendmessagesrequestFilters

Fields
  • attributes record {}[]? -

sakari: SendmessagesrequestMedia

Fields

sakari: SendMessagesResponse

Fields

sakari: SendmessagesresponseData

Fields

sakari: ShareFileResponse

Fields

sakari: SharefileresponseData

Fields

sakari: Tag

Filter by tag(s)

Fields

sakari: Template

Fields

sakari: TemplateRequest

Fields

sakari: TemplateResponse

Fields

sakari: TemplatesResponse

Fields

sakari: TokenRequest

Get token for accessing the API

Fields
  • grant_type string? - Grant type
  • client_secret string? - Client secret

sakari: TokenResponse

Fields
  • access_token string? - Access token
  • token_type string? - Token type

sakari: ToolsSharefileBody

Fields

sakari: Updated

Represent resource update details

Fields
  • at string? - Updated date time

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

sakari: WebhookResponse

Fields

sakari: WebhooksResponse

Fields

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;Copy

Metadata

Released date: over 1 year ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 1

Current verison: 1

Weekly downloads

Source repository

Keywords

Communication/Call & SMS

Cost/Paid

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.0
See more...

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC