/api/user/connect/payouts-count (GET)
Account information like email addresses is generated with faker-js it is not real user information.
await global.api.user.connect.PayoutsCount.get(req)Exceptions
These exceptions are thrown (NodeJS) or returned as JSON (HTTP) if you provide incorrect data or do not meet the requirements:
Exception | Circumstances |
---|---|
invalid-account | ineligible accessing account |
invalid-payoutid | missing querystring payoutid |
invalid querystring payoutid |
NodeJS source (view on github)
const connect = require('../../../../../index.js')
module.exports = {
get: async (req) => {
if (!req.query || !req.query.accountid) {
throw new Error('invalid-accountid')
}
const account = await global.api.user.Account.get(req)
if (!account) {
throw new Error('invalid-account')
}
const where = {
accountid: req.query.accountid
}
if (req.query.all) {
return connect.Storage.Payout.count({
where,
attributes: ['payoutid'],
order: [
['createdAt', 'DESC']
]
})
} else {
const offset = req.query.offset ? parseInt(req.query.offset, 10) : 0
const limit = req.query.limit ? parseInt(req.query.limit, 10) : global.pageSize
return connect.Storage.Payout.count({
where,
attributes: ['payoutid'],
offset,
limit,
order: [
['createdAt', 'DESC']
]
})
}
}
}
Test source (view on github)
/* eslint-env mocha */
const assert = require('assert')
const TestHelper = require('../../../../../test-helper.js')
const TestStripeAccounts = require('../../../../../test-stripe-accounts.js')
describe('/api/user/connect/payouts-count', function () {
before(TestHelper.disableMetrics)
after(TestHelper.enableMetrics)
describe('exceptions', () => {
describe('invalid-payoutid', () => {
it('missing querystring payoutid', async () => {
const user = await TestHelper.createUser()
const req = TestHelper.createRequest('/api/user/connect/payouts-count')
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.get()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-accountid')
})
it('invalid querystring payoutid', async () => {
const user = await TestHelper.createUser()
const req = TestHelper.createRequest('/api/user/connect/payouts-count?accountid=invalid')
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.get()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-accountid')
})
})
describe('invalid-account', () => {
it('ineligible accessing account', async () => {
const user = await TestHelper.createUser()
const user2 = await TestHelper.createUser()
const req = TestHelper.createRequest(`/api/user/connect/payouts-count?accountid=${user.account.accountid}`)
req.account = user2.account
req.session = user2.session
let errorMessage
try {
await req.get()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-account')
})
})
})
describe('returns', function () {
it('integer', async () => {
const user = await TestStripeAccounts.createSubmittedIndividual('NZ')
for (let i = 0, len = global.pageSize + 1; i < len; i++) {
await TestHelper.createPayout(user)
}
const req = TestHelper.createRequest(`/api/user/connect/payouts-count?accountid=${user.account.accountid}`)
req.account = user.account
req.session = user.session
req.filename = __filename
req.saveResponse = true
const result = await req.get()
assert.strictEqual(result, global.pageSize + 1)
})
})
})