Ruby wrapper for the Seeuletter.com API. See the full Seeuletter.com API Documentation. For best results, be sure that you're using the latest version of the Seeuletter API and the latest version of the ruby wrapper. This gem gives you an ActiveRecord-style syntax to use the Seeuletter.com API.
Supports Ruby 2.0.0 and greater.
Here's a general overview of the Seeuletter services available, click through to read more.
Please read through the official API Documentation to get a complete sense of what to expect from each endpoint.
First, you will need to first create an account at Seeuletter.com and obtain your Test and Live API Keys.
Once you have created an account, you can access your API Keys from the API Keys Panel.
Add this line to your application's Gemfile:
gem 'seeuletter'
And then execute:
$ bundle
Or manually install it yourself:
$ gem install seeuletter
The library uses an ActiveRecord-style interface.
For optional parameters and other details, refer to the docs here.
# To initialize a Seeuletter object
seeuletter = Seeuletter::Client.new(api_key: "your-api-key")# To initialize a Seeuletter object configured with non default host api
seeuletter = Seeuletter::Client.new(api_key: "your-api-key", host: "127.0.0.1")# send the letter
require 'seeuletter'
# initialize Seeuletter object
seeuletter = Seeuletter::Client.new(api_key: '<PUT_YOU_API_KEY_HERE>')
puts seeuletter.letters.create(
description: "Test letter from the Ruby Wrapper",
to: {
name: 'Erlich',
address_line1: '30 rue de rivoli',
address_line2: '',
address_city: 'Paris',
address_country: 'France',
address_postalcode: '75004'
},
source_file: '<html>Hello {{name}}</html>',
source_file_type: 'html',
postage_type: 'prioritaire',
variables: { name: 'Erlich'},
color: 'color'
)# send the letter
require 'seeuletter'
# initialize Seeuletter object
seeuletter = Seeuletter::Client.new(api_key: '<PUT_YOU_API_KEY_HERE>')
puts seeuletter.letters.createElectronic(
description: "Test electronic letter from the Ruby Wrapper",
to: {
email: '[email protected]',
first_name: 'Erlich',
last_name: 'Dumas',
status: 'individual'
},
source_file: '<html>Hello {{name}}</html>',
source_file_type: 'html',
postage_type: 'lre',
variables: {
name: 'Erlich'
}
)require 'seeuletter'
seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
puts seeuletter.letters.list()require 'seeuletter'
seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
puts seeuletter.letters.find('LETTER_ID')require 'seeuletter'
seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
puts seeuletter.letter_price.get(color: 'bw', postage_type: 'prioritaire', postage_speed: 'D1', page_count: 1)require 'seeuletter'
# initialize Seeuletter object
seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
puts seeuletter.accounts.create(
email: "[email protected]",
name: "Erlich Bachman",
phone: "+33104050607",
company_name: "MSB Partner from Ruby Wrapper",
address_line1: '30 rue de rivoli',
address_line2: '',
address_city: 'Paris',
address_country: 'France',
address_postalcode: '75004'
)require 'seeuletter'
# initialize Seeuletter object
seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
seeuletter.accounts.updateEmail('ACCOUNT_COMPANY_ID', "[email protected]")require 'seeuletter'
seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
puts seeuletter.invoices.list()require 'seeuletter'
seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
puts seeuletter.invoices.find('INVOICE_ID')When using postal codes with zero-prefixes, always quote them. For example when specifying 02125, pass it as a string "02125", instead of an integer.
The Ruby interpreter assumes it's not of base-10 and tries to convert it to base-10 number. So that might result in an entirely different postal code than intended.
You can access response headers via a hidden headers method on the response hash.
addresses = seeuletter.addresses.list
addresses._response.headers[:content_type]
# => "application/json"We've provided various examples for you to try out here.
There are simple scripts to demonstrate how to create all letters with the Seeuletter API Ruby wrapper.
=======================
Copyright © 2024 Seeuletter.com
Released under the MIT License, which can be found in the repository in LICENSE.txt.