Nest Changelog
0.0.0
no date
1.0.0
9/9/2021
44 added endpoints Collapse added endpoints
Added endpoints
PUT /users/{userId}/preferences
Save / updates the user’s preferences for this user
Response Body
{ data: record, }
POST /auth
Sign in with email address and password
Request Body
{ email?: string, password?: string, }
Response Body
{ }
PATCH /users/{userId}
Edit this user
Request Body
{ dateBirth: string, email: string, firstName: string, gender: { text?: string, value?: string, }, height: { units?: string, value?: number, }, lastName: string, nickname: string, weight: { units?: string, value?: number, }, }
Response Body
{ }
POST /users/{userId}/family
Request Body
{ dateBirth?: string, email?: string, firstName?: string, gender: { text?: string, value?: string, }, height: { units?: string, value?: number, }, lastName?: string, nickname: string, weight: { units?: string, value?: number, }, }
POST /plans
Create Plan
Request Body
{ amazon: { sku?: string, }, image: { url?: string, }, name?: string, shopify: { productId?: string, shopId?: string, }, sku: string, sortOrder: number, stripe: { planId?: string, productId?: string, }, termFrequency?: number, trialDays: number, }
Response Body
{ }
PATCH /plans/{id}
Update Plan
Request Body
{ amazon: { sku?: string, }, image: { url?: string, }, name: string, price: { currency?: string, units?: number, }, shopify: { productId?: string, shopId?: string, }, sku: string, sortOrder: number, stripe: { planId?: string, productId?: string, }, termFrequency: number, trialDays: number, }
Response Body
{ }
PATCH /plans/{id}/features
Updates the Plan’s features by plan id
Request Body
unknown
Response Body
{ }
POST /instructors
Create a new instructor
Request Body
{ bio: string, flags: List<string>, image: { data?: string, filename?: string, }, name?: string, user: { id?: number, }, }
Response Body
{ }
PATCH /instructors/{id}
Update an existing instructor
Request Body
{ bio: string, flags: List<string>, image: { data?: string, filename?: string, }, name: string, user: { id?: number, }, }
Response Body
{ }
POST /features
Create a new feature
Request Body
{ code: string, defaultValue: record, description: string, inputType: string, name: string, sortOrder: number, usedBy: List<string>, validation: { isNullable: bool, maxChoices: number, maxLength: number, maxValue: number, minChoices: number, minLength: number, minValue: number, options: List<string>, precision: number, regexPattern: string, }, }
Response Body
{ }
PUT /features/{id}
Update an existing feature
Request Body
{ code: string, defaultValue: record, description: string, inputType: string, name: string, sortOrder: number, usedBy: List<string>, validation: { isNullable: bool, maxChoices: number, maxLength: number, maxValue: number, minChoices: number, minLength: number, minValue: number, options: List<string>, precision: number, regexPattern: string, }, }
Response Body
{ }
DELETE /playlists/{playlistId}/tracks/{songId}
Delete song from an existing playlist
Response Body
{ }
POST /firmware
Create Firmware Update
Request Body
{ appVersions?: { android?: { maxVersion?: string, minVersion?: string, }, ios?: { maxVersion?: string, minVersion?: string, }, screen?: { maxVersion?: string, minVersion?: string, }, }, dateReleased?: number, dateRequired?: number, name?: string, releaseNotes?: string, status?: string, supportedModels?: List<string>, type?: string, updateFile?: { data?: string, filename?: string, }, version?: string, }
Response Body
{ }
PUT /firmware/{id}
Update Firmware Update
Request Body
{ appVersions?: { android?: { maxVersion?: string, minVersion?: string, }, ios?: { maxVersion?: string, minVersion?: string, }, screen?: { maxVersion?: string, minVersion?: string, }, }, dateReleased?: number, dateRequired?: number, name?: string, releaseNotes?: string, status?: string, supportedModels?: List<string>, type?: string, updateFile?: { data?: string, filename?: string, }, version?: string, }
Response Body
{ }