@wireapp/api-client

Wire API Client to send and receive data.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@wireapp/api-client
20.6.8a day ago5 years agoMinified + gzip package size for @wireapp/api-client in KB

Readme

Wire
This repository is part of the source code of Wire. You can find more information at wire.com or by contacting opensource@wire.com.
You can find the published source code at github.com/wireapp.
For licensing information, see the attached LICENSE file and the list of third-party licenses at wire.com/legal/licenses/.

API Client

Wire for Web's API client.

Getting Started

yarn
yarn start

Installation

yarn add @wireapp/api-client

Usage

Wire Backend

import {APIClient} from '@wireapp/api-client';
import {LoginData} from '@wireapp/api-client/src/auth/';
import {ClientType} from '@wireapp/api-client/src/client';

const credentials: LoginData = {
  clientType: ClientType.TEMPORARY,
  email: 'user@wire.com',
  password: 'top-secret',
};

const apiClient = new APIClient();

apiClient.login(credentials);

Custom Backend

import {APIClient} from '@wireapp/api-client';
import {Config} from '@wireapp/api-client/src/Config';
import {LoginData} from '@wireapp/api-client/src/auth/';
import {ClientType} from '@wireapp/api-client/src/client';

const credentials: LoginData = {
  clientType: ClientType.TEMPORARY,
  email: 'user@wire.com',
  password: 'top-secret',
};

const apiConfig: Config = {
  urls: {
    name: 'My custom backend',
    rest: 'https://backend-rest.domain.com',
    ws: 'wss://backend-websocket.domain.com',
  },
};

const apiClient = new APIClient(apiConfig);

apiClient.login(credentials);

Examples

Browser

Node.js

Execution

Bash
#!/bin/bash

EMAIL="name@email.com"
PASSWORD="password"

node index.js --e="$EMAIL" --p="$PASSWORD"

Node
npm run dist
node index.js --e="name@email.com" --p="password"