Skip to content
This repository was archived by the owner on May 13, 2020. It is now read-only.

trs/shift-code-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Shift Code API

Borderlands SHiFT code redemption library

Install

npm install shift-code-api

Usage

import {login, redeem, account, logout} from 'shift-code-api';

(async () => {
  const session = await login('email', 'password');

  const user = await account(session);
  console.log('Redeeming code for %s', user.email);

  const results = redeem(session, 'XXXXX-XXXXX-XXXXX-XXXXX-XXXXX');
  for await (const result of results) {
    console.log(result);
  }

  await logout(session);
})();

API

login(email: string, password: string) => Promise<Session>

Create a login session to use for additional methods.

logout(session: Session) => Promise<void>

Logout and invalidate the session.

redeem(session, code) => AsyncGenerator<RedemptionResult>

Redeem a SHiFT code on the account associated to the session.

A code can be associated to multiple platforms, so one or many RedemptionResults will be yielded.

account(session) => Promise<Account>

Get account details, such as email and ID.

CLI

A simple CLI to redeem a given code.

npx shift-code-api [email] [password] [code]

About

🎮 Borderlands SHiFT code redemption API

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •