Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] update links to the repo, api and web-sites #46

Merged
merged 1 commit into from
Nov 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
![npm](https://img.shields.io/npm/v/android-sms-gateway?style=for-the-badge)
![License](https://img.shields.io/badge/license-Apache--2.0-blue?style=for-the-badge)
![Downloads](https://img.shields.io/npm/dw/android-sms-gateway?style=for-the-badge)
![GitHub issues](https://img.shields.io/github/issues/capcom6/android-sms-gateway-ts?style=for-the-badge)
![GitHub stars](https://img.shields.io/github/stars/capcom6/android-sms-gateway-ts?style=for-the-badge)
<!-- ![Build Status](https://img.shields.io/travis/com/capcom6/android-sms-gateway-ts/master) -->
<!-- ![Coverage](https://img.shields.io/codecov/c/github/capcom6/android-sms-gateway-ts) -->
<!-- ![Dependencies](https://img.shields.io/david/capcom6/android-sms-gateway-ts) -->
![GitHub issues](https://img.shields.io/github/issues/android-sms-gateway/client-ts?style=for-the-badge)
![GitHub stars](https://img.shields.io/github/stars/android-sms-gateway/client-ts?style=for-the-badge)
<!-- ![Build Status](https://img.shields.io/travis/com/android-sms-gateway/client-ts/master) -->
<!-- ![Coverage](https://img.shields.io/codecov/c/github/android-sms-gateway/client-ts) -->
<!-- ![Dependencies](https://img.shields.io/david/android-sms-gateway/client-ts) -->
<!-- ![TypeScript Version](https://img.shields.io/npm/types/android-sms-gateway) -->

# SMS Gateway for Android™ JS/TS API Client

This is a JavaScript/TypeScript client library for interfacing with the [SMS Gateway for Android API](https://sms.capcom.me).
This is a JavaScript/TypeScript client library for interfacing with the [SMS Gateway for Android](https://sms-gate.app).

## Features

Expand Down Expand Up @@ -98,12 +98,12 @@ apiClient.getState(messageId)

## API Reference

For more information on the API endpoints and data structures, please consult the [SMS Gateway for Android API documentation](https://sms.capcom.me/integration/api/).
For more information on the API endpoints and data structures, please consult the [SMS Gateway for Android API documentation](https://docs.sms-gate.app/integration/api/).

# Contributing

Contributions are welcome! Please submit a pull request or create an issue for anything you'd like to add or change.

# License

This library is open-sourced software licensed under the [Apache-2.0 license](LICENSE).
This library is open-sourced software licensed under the [Apache-2.0 license](LICENSE).
Binary file modified bun.lockb
Binary file not shown.
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"name": "android-sms-gateway",
"license": "Apache-2.0",
"description": "A JS/TS client library for sending and managing SMS messages via the Android SMS Gateway API",
"description": "A JS/TS client library for sending and managing SMS messages via the SMS Gateway for Android™",
"repository": {
"type": "git",
"url": "git+https://github.com/capcom6/android-sms-gateway-ts.git"
"url": "git+https://github.com/android-sms-gateway/client-ts.git"
},
"homepage": "https://github.com/capcom6/android-sms-gateway-ts",
"homepage": "https://sms-gate.app",
"keywords": [
"bun",
"sms",
Expand All @@ -22,9 +22,9 @@
"url": "https://github.com/capcom6"
},
"bugs": {
"url": "https://github.com/capcom6/android-sms-gateway-ts/issues"
"url": "https://github.com/android-sms-gateway/client-ts/issues"
},
"version": "1.0.0",
"version": "2.0.0",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"files": [
Expand Down
10 changes: 5 additions & 5 deletions src/client.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ describe('Client', () => {
message,
{
"Content-Type": "application/json",
"User-Agent": "android-sms-gateway/1.0 (client; js)",
"User-Agent": "android-sms-gateway/2.0 (client; js)",
Authorization: expect.any(String),
},
);
Expand All @@ -69,7 +69,7 @@ describe('Client', () => {
expect(mockHttpClient.get).toHaveBeenCalledWith(
`${BASE_URL}/message/${messageId}`,
{
"User-Agent": "android-sms-gateway/1.0 (client; js)",
"User-Agent": "android-sms-gateway/2.0 (client; js)",
Authorization: expect.any(String),
},
);
Expand All @@ -89,7 +89,7 @@ describe('Client', () => {
expect(mockHttpClient.get).toHaveBeenCalledWith(
`${BASE_URL}/webhooks`,
{
"User-Agent": "android-sms-gateway/1.0 (client; js)",
"User-Agent": "android-sms-gateway/2.0 (client; js)",
Authorization: expect.any(String),
},
);
Expand All @@ -116,7 +116,7 @@ describe('Client', () => {
req,
{
"Content-Type": "application/json",
"User-Agent": "android-sms-gateway/1.0 (client; js)",
"User-Agent": "android-sms-gateway/2.0 (client; js)",
Authorization: expect.any(String),
},
);
Expand All @@ -131,7 +131,7 @@ describe('Client', () => {
expect(mockHttpClient.delete).toHaveBeenCalledWith(
`${BASE_URL}/webhooks/test`,
{
"User-Agent": "android-sms-gateway/1.0 (client; js)",
"User-Agent": "android-sms-gateway/2.0 (client; js)",
Authorization: expect.any(String),
},
);
Expand Down
4 changes: 2 additions & 2 deletions src/client.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Message, MessageState, RegisterWebHookRequest, WebHook } from "./domain";
import { HttpClient } from "./http";

export const BASE_URL = "https://sms.capcom.me/api/3rdparty/v1";
export const BASE_URL = "https://api.sms-gate.app/3rdparty/v1";

export class Client {
private baseUrl: string;
Expand All @@ -12,7 +12,7 @@ export class Client {
this.baseUrl = baseUrl;
this.httpClient = httpClient;
this.defaultHeaders = {
"User-Agent": "android-sms-gateway/1.0 (client; js)",
"User-Agent": "android-sms-gateway/2.0 (client; js)",
"Authorization": `Basic ${btoa(`${login}:${password}`)}`,
}
}
Expand Down