@seven.io/loopback
v1.0.0
Published
LoopBack connector for seven
Downloads
62
Readme
loopback-connector-seven
The official seven connector for LoopBack. Prior to using you will need to create an API key.
This connector supports the following endpoints of the seven REST API:
Installation
In your LoopBack project:
NPM
$ npm i @seven.io/loopback
Yarn
$ yarn add @seven.io/loopback
Setup
Create a data source
import {inject, lifeCycleObserver, LifeCycleObserver} from '@loopback/core'
import {juggler} from '@loopback/repository'
import {SevenConnector} from '@seven.io/loopback'
const config = {
apiKey: process.env.SEVEN_API_KEY,
connector: SevenConnector,
name: 'seven',
}
@lifeCycleObserver('datasource')
export class SevenDataSource extends juggler.DataSource implements LifeCycleObserver {
static dataSourceName = 'seven'
static readonly defaultConfig = config
constructor(
@inject('datasources.config.seven', {optional: true})
dsConfig: object = config,
) {
super('seven', dsConfig)
}
}
Create a model
import {Model, model, property} from '@loopback/repository';
@model()
export class SevenMessage extends Model {
@property({
generated: false,
id: true,
required: true,
type: 'string',
})
operation: 'voice' | 'sms';
@property({
required: true,
type: 'string',
})
to: string;
@property({
required: false,
type: 'string',
})
from: string;
@property({
required: true,
type: 'string',
})
text: string;
constructor(data?: Partial<SevenMessage>) {
super(data);
}
}
export interface SevenRelations {
// describe navigational properties here
}
export type SevenWithRelations = SevenMessage & SevenRelations;
Create a service
import {injectable, BindingScope, Provider, inject} from '@loopback/core'
import {GenericService, getService} from '@loopback/service-proxy'
import {SevenDataSource} from '../datasources'
import {SevenMessage} from '../models'
export interface Seven extends GenericService {
send(data: SevenMessage): Promise<unknown>;
}
@injectable({scope: BindingScope.TRANSIENT})
export class SevenProvider implements Provider<Seven> {
constructor(
@inject('datasources.seven')
protected dataSource: SevenDataSource = new SevenDataSource(),
) {
}
value(): Promise<Seven> {
return getService(this.dataSource)
}
}
Usage
Send SMS
import {inject} from '@loopback/core'
import {post} from '@loopback/rest'
import {SevenMessage} from '../models'
import {Seven} from '../services'
export class SmsController {
@post('/send-sms')
async sms(
@inject('services.Seven') sevenProvider: Seven,
): Promise<void> {
const msg = new SevenMessage({
from: 'optional sender ID',
operation: 'sms',
text: 'This is a test SMS from LoopBack via seven',
to: 'phone number(s) for calling separated by comma',
})
try {
const json = await sevenProvider.send(msg)
console.log('json', json)
} catch (e) {
console.error('e', e)
throw e
}
}
}
Make a text-to-speech call
import {inject} from '@loopback/core'
import {post} from '@loopback/rest'
import {SevenMessage} from '../models'
import {Seven} from '../services'
export class TextToSpeechController {
@post('/send-voice')
async voice(
@inject('services.Seven') sevenProvider: Seven,
): Promise<void> {
const msg = new SevenMessage({
from: 'optional caller ID',
operation: 'voice',
text: 'This is a test call from LoopBack via seven',
to: 'the number for calling',
})
try {
const json = await sevenProvider.send(msg)
console.log('json', json)
} catch (e) {
console.error('e', e)
throw e
}
}
}
Options
Send SMS
{
from: 'OPTIONAL_SENDER_ID',
operation: 'sms',
text: 'TEXT_MESSAGE',
to: 'TARGET_PHONE_NUMBER(S)'
}
Make a text-to-speech call
{
from: 'OPTIONAL_CALLER_ID',
operation: 'call',
text: 'TEXT_OR_XML',
to: 'TARGET_PHONE_NUMBER'
}
Support
Need help? Feel free to contact us.