/api/user/connect/delete-person (DELETE)
await global.api.user.connect.DeletePerson.delete(req) Located in Stripe Connect module API
Returns boolean
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 querystring personid | |
invalid-personid | missing querystring personid |
invalid-account | ineligible accessing account |
invalid-person | ineligible querystring person is representative |
NodeJS source (edit on github)
If you see a problem with the source submit a pull request on Github.
const connect = require('../../../../../index.js')
const stripeCache = require('../../../../stripe-cache.js')
module.exports = {
delete: async (req) => {
if (!req.query || !req.query.personid) {
throw new Error('invalid-personid')
}
const person = await global.api.user.connect.Person.get(req)
if (!person) {
throw new Error('invalid-personid')
}
if (person.relationship.representative) {
throw new Error('invalid-person')
}
await stripeCache.execute('accounts', 'deletePerson', person.account, req.query.personid, req.stripeKey)
await stripeCache.delete(req.query.personid)
try {
await connect.Storage.delete(`${req.appid}/map/personid/stripeid/${req.query.personid}`)
} catch (error) {
}
try {
await connect.StorageList.remove(`${req.appid}/stripeAccount/persons/${person.account}`, req.query.personid)
} catch (error) {
}
try {
await connect.StorageList.remove(`${req.appid}/persons`, req.query.personid)
} catch (error) {
}
return true
}
}
Test source (edit on github)
Tests perform real HTTP requests against a running Dashboard server.
/* eslint-env mocha */
const assert = require('assert')
const TestHelper = require('../../../../../test-helper.js')
const TestStripeAccounts = require('../../../../../test-stripe-accounts.js')
describe('/api/user/connect/delete-person', () => {
describe('exceptions', () => {
describe('invalid-personid', () => {
it('missing querystring personid', async () => {
const user = await TestHelper.createUser()
const req = TestHelper.createRequest('/api/user/connect/delete-person')
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.delete()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-personid')
})
it('invalid querystring personid', async () => {
const user = await TestHelper.createUser()
const req = TestHelper.createRequest('/api/user/connect/delete-person?personid=invalid')
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.delete()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-personid')
})
})
describe('invalid-account', () => {
it('ineligible accessing account', async () => {
const user = await TestStripeAccounts.createCompanyWithDirectors('DE', 1)
const user2 = await TestHelper.createUser()
const req = TestHelper.createRequest(`/api/user/connect/delete-person?personid=${user.director.id}`)
req.account = user2.account
req.session = user2.session
let errorMessage
try {
await req.delete()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-account')
})
})
describe('invalid-person', () => {
it('ineligible querystring person is representative', async () => {
const user = await TestStripeAccounts.createCompanyWithRepresentative('DE')
const req = TestHelper.createRequest(`/api/user/connect/delete-person?personid=${user.representative.id}`)
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.delete()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-person')
})
})
})
describe('returns', () => {
it('boolean', async () => {
const user = await TestStripeAccounts.createCompanyWithDirectors('DE', 1)
const req = TestHelper.createRequest(`/api/user/connect/delete-person?personid=${user.director.id}`)
req.account = user.account
req.session = user.session
req.filename = __filename
req.saveResponse = true
const deleted = await req.delete()
assert.strictEqual(deleted, true)
})
})
})