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

Add support for session removal and getting sku #138

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ Methods are provided within `client.vouchers.*` namespace.
- [Disable Voucher](#disable-voucher)
- [Import Vouchers](#import-vouchers)
- [Examine Vouchers Qualification](#examine-vouchers-qualification)
- [Release Validation Session](#release-validation-session)

#### [Create Voucher]
```javascript
Expand Down Expand Up @@ -200,6 +201,10 @@ client.vouchers.qualifications.examine(bodyParams, queryParams)
// Example
client.vouchers.qualifications.examine({}, {audienceRulesOnly: true, limit: 10})
```
#### [Release Validation Session]
```javascript
client.vouchers.sessions.release(code, sessionKey)
```
---

### Campaigns API
Expand Down Expand Up @@ -917,6 +922,9 @@ consistent structure, described in details in our [API reference](https://docs.v
Bug reports and pull requests are welcome through [GitHub Issues](https://github.com/voucherifyio/voucherify-nodejs-sdk/issues).

## Changelog
- **2021-07-20** - `5.3.0`
- Add support for getting SKU by id/source_id.
- Add support for releasing voucher validation session.
- **2020-09-17** - `5.2.0`
- Add support Get Member Activities in Loyality API
- enhancement: throw error objects instead of object literals (@AbdelrahmanHafez)
Expand Down Expand Up @@ -1092,6 +1100,7 @@ Bug reports and pull requests are welcome through [GitHub Issues](https://github
[Import Vouchers]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#import-vouchers-1
[Examine Vouchers Qualification]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#push-qualification-request
[Add Gift Voucher Balance]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#add-gift-voucher-balance
[Release Validation Session]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#release-validation-session

[Create Campaign]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#create-campaign
[Update Campaign]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#update-campaign
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "voucherify",
"version": "5.2.0",
"version": "5.3.0",
"homepage": "http://www.voucherify.io",
"description": "Official Voucherify SDK for Node.js",
"author": "Voucherify",
Expand Down
13 changes: 13 additions & 0 deletions src/Skus.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
'use strict'

const { encode } = require('./helpers')

module.exports = class Skus {
constructor (client) {
this.client = client
}

get (skuId, callback) {
return this.client.get(`/skus/${encode(skuId)}`, null, callback)
}
}
6 changes: 6 additions & 0 deletions src/Vouchers.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ module.exports = class Vouchers {
return this.client.post('/vouchers/qualification', params, callback, { qs })
}
}

this.sessions = {
release: (code, sessionKey, callback) => {
return this.client.delete(`/vouchers/${encode(code)}/sessions/${encode(sessionKey)}`, callback)
}
}
}

create (voucher, callback) {
Expand Down
5 changes: 4 additions & 1 deletion src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ const Rewards = require('./Rewards')
const Loyalties = require('./Loyalties')
const ValidationRules = require('./ValidationRules')
const Segments = require('./Segments')
const Skus = require('./Skus')
const { assertOption } = require('./helpers')

module.exports = function (options) {
Expand All @@ -44,6 +45,7 @@ module.exports = function (options) {
const loyalties = new Loyalties(client)
const segments = new Segments(client)
const validationRules = new ValidationRules(client)
const skus = new Skus(client)

return {
vouchers,
Expand All @@ -60,6 +62,7 @@ module.exports = function (options) {
loyalties,
segments,
validationRules,
events
events,
skus
}
}
27 changes: 27 additions & 0 deletions test/skus-api.spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/* eslint-env mocha */
/* eslint-disable no-unused-expressions */

var nock = require('nock')
var VoucherifyClient = require('./client-loader')
var fixtures = require('./fixtures')
var reqWithoutBody = fixtures.reqWithoutBody
nock.disableNetConnect()

describe('Skus API', function () {
var client = new VoucherifyClient({
applicationId: 'node-sdk-test-id',
clientSecretKey: 'node-sdk-test-secret'
})

it('should get sku', function (done) {
var server = nock('https://api.voucherify.io', reqWithoutBody)
.get('/v1/skus/sku_test-id')
.reply(200, {})

client.skus.get('sku_test-id')
.then(function () {
server.done()
done()
})
})
})
15 changes: 15 additions & 0 deletions test/vouchers-api.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -268,4 +268,19 @@ describe('Vouchers API', function () {
})
})
})

describe('sessions', function () {

it('should release voucher session', function (done) {
var server = nock('https://api.voucherify.io', reqWithoutBody)
.delete('/v1/vouchers/test-code/sessions/test-session')
.reply(200, {})

client.vouchers.sessions.release("test-code", "test-session")
.then(function () {
server.done()
done()
})
})
})
})