Skip to content

Instantly share code, notes, and snippets.

@bbernstein
Last active March 9, 2021 22:50
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
Star You must be signed in to star a gist
Save bbernstein/e48cc757a1e870bbe7be864aef163a6b to your computer and use it in GitHub Desktop.
bw-api
swagger: '2.0'
info:
description: This is the external API available for partners to work with BodesWell platforms.
version: 1.0.0
title: BodesWell API
termsOfService: https://www.bodeswell.io/terms-conditions
contact:
email: support@bodeswell.io
host: app.bodewell.io
basePath: /api/ext
tags:
- name: auth
description: Authenticating users
- name: timeline
description: Timeline data
- name: timelineDetail
description: Timeline detail data for a timeframe
- name: cards
description: Life events info
- name: users
description: User data
- name: incomeSources
description: Income sources
paths:
/timeline:
get:
tags:
- timeline
summary: Return summary cashflow
operationId: cashFlow
consumes:
- application/json
produces:
- application/json
responses:
200:
description: Monthly cashflow for user
schema:
type: array
items:
$ref: '#/definitions/CashFlowMonth'
security:
- api_key: []
/timeline/{period}/{date}:
get:
tags:
- timelineDetail
summary: Return list of life events
operationId: timelineDetail
consumes:
- application/json
produces:
- application/json
responses:
200:
description: All active life events on the timeline
schema:
type: array
items:
$ref: '#/definitions/TimelineDetail'
security:
- api_key: []
/cards:
get:
tags:
- cards
summary: Return list of life events
operationId: cards
consumes:
- application/json
produces:
- application/json
responses:
200:
description: All active life events on the timeline
schema:
type: array
items:
$ref: '#/definitions/Card'
security:
- api_key: []
/users:
get:
tags:
- users
summary: Return list of life events
operationId: users
consumes:
- application/json
produces:
- application/json
responses:
200:
description: All active life events on the timeline
schema:
type: array
items:
$ref: '#/definitions/User'
security:
- api_key: []
/incomeSources:
get:
tags:
- incomeSources
summary: Return list of income sources for the user
operationId: incomeSources
consumes:
- application/json
produces:
- application/json
responses:
200:
description: All active income sources
schema:
type: array
items:
$ref: '#/definitions/IncomeSource'
security:
- api_key: []
definitions:
TimelineDetail:
type: object
properties:
date:
type: string
format: date
period:
type: string
incomes:
type: object
properties:
amount:
type: number
format: float
bases:
type: array
items:
$ref: '#/definitions/TimelineIncomeBase'
adjustments:
type: array
items:
$ref: '#/definitions/TimelineDetailAdjustment'
expenses:
type: object
properties:
amount:
type: number
format: float
bases:
type: array
items:
$ref: '#/definitions/TimelineExpenseBase'
adjustments:
type: array
items:
$ref: '#/definitions/TimelineDetailAdjustment'
assets:
type: object
properties:
amount:
type: number
format: float
bases:
type: array
items:
$ref: '#/definitions/TimelineAssetBase'
adjustments:
type: array
items:
$ref: '#/definitions/TimelineDetailAdjustment'
debts:
type: object
properties:
amount:
type: number
format: float
bases:
type: array
items:
$ref: '#/definitions/TimelineDebtBase'
adjustments:
type: array
items:
$ref: '#/definitions/TimelineDetailAdjustment'
TimelineIncomeBase:
type: object
properties:
id:
type: integer
name:
type: string
amount:
type: number
format: float
detail:
type: string
TimelineExpenseBase:
type: object
properties:
id:
type: integer
name:
type: string
amount:
type: number
format: float
TimelineAssetBase:
type: object
properties:
id:
type: integer
name:
type: string
detail:
type: string
amount:
type: number
format: float
amountLow:
type: number
format: float
amountHigh:
type: number
format: float
liquid:
type: boolean
TimelineDebtBase:
type: object
properties:
id:
type: integer
name:
type: string
detail:
type: string
amount:
type: number
format: float
amountLow:
type: number
format: float
amountHigh:
type: number
format: float
liquid:
type: boolean
TimelineDetailAdjustment:
properties:
id:
type: integer
date:
type: string
format: date
name:
type: string
detail:
type: string
amount:
type: number
format: float
IncomeSource:
properties:
id:
type: integer
payer:
type: string
name:
type: string
dailyIncome:
type: number
format: float
annualizedIncome:
type: number
format: float
startCardId:
type: integer
endCardId:
type: integer
created:
type: string
format: date-time
updated:
type: string
format: date-time
CashFlowMonth:
type: object
properties:
startDate:
type: string
format: date
income:
type: number
format: float
expense:
type: number
format: float
investment:
type: number
format: float
debt:
type: number
format: float
freeCash:
type: number
format: float
danger:
type: integer
Card:
type: object
properties:
id:
type: integer
description:
type: string
nickname:
type: string
startDate:
type: string
format: date
endDate:
type: string
format: date
attributes:
type: object
incomeSourceId:
type: integer
accountId:
type: integer
created:
type: string
format: date-time
updated:
type: string
format: date-time
User:
type: object
properties:
id:
type: integer
firstName:
type: string
lastName:
type: string
active:
type: boolean
temporary:
type: boolean
snapshotId:
type: string
lastDataUpdate:
type: string
format: date-time
lastLogin:
type: string
format: date-time
created:
type: string
format: date-time
updated:
type: string
format: date-time
securityDefinitions:
bodeswell_auth:
type: oauth2
authorizationUrl: http://app.bodeswell.io/oauth/dialog
flow: implicit
scopes:
write:pets: modify pets in your account
read:pets: read your pets
api_key:
type: apiKey
name: api_key
in: header
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment