Module: Sendly

Defined in:
lib/sendly.rb,
lib/sendly/media.rb,
lib/sendly/types.rb,
lib/sendly/client.rb,
lib/sendly/errors.rb,
lib/sendly/verify.rb,
lib/sendly/version.rb,
lib/sendly/messages.rb,
lib/sendly/webhooks.rb,
lib/sendly/enterprise.rb,
lib/sendly/rules_resource.rb,
lib/sendly/drafts_resource.rb,
lib/sendly/labels_resource.rb,
lib/sendly/account_resource.rb,
lib/sendly/contacts_resource.rb,
lib/sendly/webhooks_resource.rb,
lib/sendly/campaigns_resource.rb,
lib/sendly/templates_resource.rb,
lib/sendly/conversations_resource.rb

Overview

Sendly Ruby SDK

Official Ruby client for the Sendly SMS API.

Examples:

Basic usage

client = Sendly::Client.new("sk_live_v1_xxx")
message = client.messages.send(to: "+15551234567", text: "Hello!")

Defined Under Namespace

Modules: Webhooks Classes: APIError, Account, AccountResource, ApiKey, AuthenticationError, Campaign, CampaignPreview, CampaignsResource, CheckVerificationResponse, Client, Contact, ContactList, ContactListsResource, ContactsResource, Conversation, ConversationContext, ConversationList, ConversationWithMessages, ConversationsResource, CreditTransaction, Credits, Draft, DraftList, DraftsResource, EnterpriseAnalyticsSubResource, EnterpriseBillingSubResource, EnterpriseCreditsSubResource, EnterpriseResource, EnterpriseSettingsSubResource, EnterpriseWebhooksSubResource, EnterpriseWorkspacesSubResource, Error, ErrorFactory, GeneratedTemplate, InsufficientCreditsError, Label, LabelsResource, Media, MediaFile, Message, MessageList, Messages, NetworkError, NotFoundError, RateLimitError, Rule, RulesResource, SendVerificationResponse, ServerError, SessionsResource, Template, TemplatesResource, TimeoutError, ValidateSessionResponse, ValidationError, Verification, VerifyResource, VerifySession, Webhook, WebhookCreatedResponse, WebhookDelivery, WebhookEvent, WebhookMessageData, WebhookSecretRotation, WebhookSignatureError, WebhookTestResult, WebhookVerificationData, WebhooksResource

Constant Summary collapse

VERSION = 
"3.29.0"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_key ⇒ String?

Returns Default API key.

Returns:

  • (String, nil) —

    Default API key



36
37
38
 
# File 'lib/sendly.rb', line 36

def api_key
  @api_key
end

.base_url ⇒ String

Returns Default base URL.

Returns:

  • (String) —

    Default base URL



39
40
41
 
# File 'lib/sendly.rb', line 39

def base_url
  @base_url
end

Class Method Details

.client ⇒ Sendly::Client

Create a client with the default API key

Returns:



57
58
59
 
# File 'lib/sendly.rb', line 57

def client
  @client ||= Client.new(api_key: api_key)
end

.configure {|self| ... } ⇒ void

This method returns an undefined value.

Configure the SDK with default options

Examples:

Sendly.configure do |config|
  config.api_key = "sk_live_v1_xxx"
end

Yields:

  • (self) —

    Yields self for configuration



50
51
52
 
# File 'lib/sendly.rb', line 50

def configure
  yield self
end

.send_message(to:, text:) ⇒ Sendly::Message

Send a message using the default client

Parameters:

  • to (String) —

    Recipient phone number

  • text (String) —

    Message content

Returns:



66
67
68
 
# File 'lib/sendly.rb', line 66

def send_message(to:, text:)
  client.messages.send(to: to, text: text)
end