Skip to content

README.md

Latest commit

 

History

History
321 lines (228 loc) · 7.04 KB

README.md

File metadata and controls

321 lines (228 loc) · 7.04 KB

Ayyıldız Mobile Node.js SDK

npm version License: MIT TypeScript CI codecov Node.js

Unofficial Node.js SDK for Ayyıldız Mobile SMS API.

Installation

Using pnpm (recommended)

pnpm add @muhammedaksam/ayyildiz-node

Using npm

npm install @muhammedaksam/ayyildiz-node

Using yarn

yarn add @muhammedaksam/ayyildiz-node

Quick Start

import { AyyildizClient } from '@muhammedaksam/ayyildiz-node';

const client = new AyyildizClient({
  username: 'your-username',
  password: 'your-password',
  companyCode: 'your-company-code',
  defaultOriginator: 'SENDER' // optional
});

// Send SMS
const response = await client.sms().send({
  to: '+905551234567',
  message: 'Hello from Ayyıldız Mobile!'
});

console.log(response.success);

Configuration

Constructor Options

// Option 1: Using config object
const client = new AyyildizClient({
  username: 'your-username',
  password: 'your-password',
  companyCode: 'your-company-code',
  defaultOriginator: 'SENDER' // optional
});

// Option 2: Using parameters
const client = new AyyildizClient(
  'your-username',
  'your-password',
  'your-company-code',
  'SENDER' // optional
);

API Reference

SMS Operations

Send SMS

// Send single SMS
await client.sms().send('+905551234567', 'Your message');

// Send SMS with custom originator
await client.sms().send('+905551234567', 'Your message', 'CUSTOM');

// Send SMS to multiple recipients
await client.sms().send(['+905551234567', '+905557654321'], 'Your message');

// Send different messages to different recipients
await client.sms().send({
  '+905551234567': 'Message for first recipient',
  '+905557654321': 'Message for second recipient'
});

Send SMS via HTTP GET

// Send SMS using HTTP GET method
await client.sms().sendViaHttp('+905551234567', 'Your message', 'SENDER');

Schedule SMS

// Schedule SMS for later delivery
await client
  .sms()
  .schedule('311220241430') // ddmmyyyyhhmm format
  .send('+905551234567', 'Scheduled message');

Set SMS Type

import { SmsType } from '@muhammedaksam/ayyildiz-node';

// Set SMS type before sending
await client
  .sms()
  .setType(SmsType.LONG) // 918 character SMS
  .send('+905551234567', 'Long message');

// Available SMS types:
// SmsType.STANDARD = 160 character SMS
// SmsType.LONG = 918 character SMS
// SmsType.TURKISH_SHORT = 70 character Turkish SMS
// SmsType.TURKISH_LONG = 402 character Turkish SMS
// SmsType.TURKISH_STANDARD = 155/894 character Turkish SMS (default)
// SmsType.INTERNATIONAL = 402 character International SMS

Account Operations

Get Credit Balance

const balance = await client.account().getCredit();
console.log(balance.data);

Report Operations

Get SMS Reports

// Get reports by date range
const reports = await client.reports().getByDateRange('20240101', '20240131');

// Get detailed report by message GUID
const detailedReport = await client.reports().getDetailedReport('message-guid');

// Get report by message ID
const report = await client.reports().getByMessageId('message-id');

// Get report in XML format
const xmlReport = await client.reports().getXmlReport('message-id');

Sender Operations

Get Available Originators

const originators = await client.senders().getOriginators();
console.log(originators.data);

Error Handling

try {
  const response = await client.sms().send('+905551234567', 'Hello!');

  if (response.success) {
    console.log('SMS sent successfully');
  } else {
    console.error('SMS failed:', response.error);
  }
} catch (error) {
  console.error('Request failed:', error);
}

Debug Mode

const client = new AyyildizClient(config);

// Send SMS
await client.sms().send({
  to: '+905551234567',
  message: 'Hello!'
});

// Get debug information
console.log(client.debug());

Turkish Character Support

The SDK automatically handles Turkish characters in SMS messages. You can send messages with Turkish characters like ğ, ü, ş, ı, ö, ç without any special configuration.

Development

Prerequisites

  • Node.js (latest LTS version recommended)
  • pnpm (latest version recommended as package manager)

Setup

# Install pnpm if not already installed
npm install -g pnpm

# Install dependencies (uses pnpm-lock.yaml)
pnpm install

# Build the project
pnpm run build

# Run tests
pnpm test

# Lint code
pnpm run lint

# Format code
pnpm run format

Package Manager Benefits

This project uses pnpm as the preferred package manager for several advantages:

  • Faster installations: pnpm reuses packages from a global store
  • Disk space efficiency: No duplicate packages across projects
  • Stricter dependency resolution: Better compatibility and security
  • Monorepo support: Excellent for complex project structures
  • Lockfile optimization: More reliable dependency resolution

pnpm Commands

# Install dependencies
pnpm install

# Add a dependency
pnpm add package-name

# Add a dev dependency
pnpm add -D package-name

# Remove a dependency
pnpm remove package-name

# Update dependencies
pnpm update

# Check outdated packages
pnpm outdated

Building

pnpm run build

This will compile TypeScript to JavaScript in the dist directory.

Package Manager

This project uses pnpm as the preferred package manager. While you can use npm or yarn, pnpm is recommended for:

  • Faster installation
  • Better disk space efficiency
  • Stricter dependency resolution
  • Better monorepo support

TypeScript Support

This SDK is written in TypeScript and provides full type definitions. No additional @types packages are needed.

API Documentation

For detailed API documentation, please visit Ayyıldız Mobile API Documentation.

Support

For support and questions:

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests for new functionality
  5. Ensure all tests pass
  6. Submit a pull request

Changelog

See CHANGELOG.md for details about changes in each version.