Class Response

Hierarchy

Path
- Response
  - Team

Index

Constructors

constructor

new Response(config: knex.Config, secret: string): Response

Inherited from Core.constructor
- Defined in query/core.ts:8
Parameters
- config: knex.Config
- secret: string
Returns Response

Properties

config

config: knex.Config

Methods

api

api(table: string): knex.QueryBuilder<any>

Inherited from Core.api
- Defined in query/core.ts:46
description

Método central que inicia query

Parameters
- table: string
  
  Nome da tabela
Returns knex.QueryBuilder<any>

createNewApiDoc

createNewApiDoc(userId: number, apiForm: Api): Promise<void>

Inherited from Api.createNewApiDoc
- Defined in query/api.ts:12
description

Create a new API Documentation

Parameters
- userId: number
  
  User ID
- apiForm: Api
  
  Form for new API
Returns Promise<void>

createNewPath

createNewPath(userId: number, tagId: number, form: any): Promise<Path>

Inherited from Path.createNewPath
- Defined in query/path.ts:13
description

Create a New Path

Parameters
- userId: number
  
  User ID
- tagId: number
  
  Tag ID
- form: any
  
  Form contain fields: methodType, pathName, descriptionVerb, path, parameter, headersValue, bodyValue and data
Returns Promise<Path>

createNewResponse

createNewResponse(userId: number, pathId: number, form: any): Promise<Response>

- Defined in query/response.ts:12
description

Create a new Response

Parameters
- userId: number
  
  User ID
- pathId: number
  
  Path ID
- form: any
  
  Form contains: typeCode, responseModel
Returns Promise<Response>

createNewTag

createNewTag(userId: number, apiId: number, form: any): Promise<Tag>

Inherited from Tag.createNewTag
- Defined in query/tag.ts:11
description

Create a new Tag

Parameters
- userId: number
  
  User ID
- apiId: number
  
  Api ID
- form: any
  
  Form with "nameTag" and "descriptionTag"
Returns Promise<Tag>

deleteApiById

deleteApiById(userId: number, id: number): Promise<void>

Inherited from Api.deleteApiById
- Defined in query/api.ts:108
description

Delete one API

Parameters
- userId: number
  
  User ID
- id: number
  
  Api ID
Returns Promise<void>

deletePathById

deletePathById(userId: number, pathId: number): Promise<void>

Inherited from Path.deletePathById
- Defined in query/path.ts:98
description

Delete a path

Parameters
- userId: number
  
  User ID
- pathId: number
  
  Path ID
Returns Promise<void>

deleteResponseById

deleteResponseById(userId: number, responseId: number): Promise<void>

- Defined in query/response.ts:102
description

Delete one Response

Parameters
- userId: number
  
  User ID
- responseId: number
  
  Response ID
Returns Promise<void>

deleteTagByIdAndUserId

deleteTagByIdAndUserId(userId: number, tagId: number): Promise<void>

Inherited from Tag.deleteTagByIdAndUserId
- Defined in query/tag.ts:63
description

Remove a tag by ID and User ID

Parameters
- userId: number
  
  User ID
- tagId: number
  
  Tag ID
Returns Promise<void>

generateToken

generateToken(params: string | object, validade: string): Promise<string>

Inherited from Core.generateToken
- Defined in query/core.ts:35
description

Gera um novo token com validade determinada pelo parametro validade

Parameters
- params: string | object
- validade: string
  
  Validade do token, ex: 7d
Returns Promise<string>

getAllApiByUser

getAllApiByUser(userId: number): Promise<Api[]>

Inherited from Api.getAllApiByUser
- Defined in query/api.ts:57
description

Get All Api docs by User

Parameters
- userId: number
  
  User ID
Returns Promise<Api[]>

getAllApiByUserAndVisibility

getAllApiByUserAndVisibility(userId: number, isPublic: boolean): Promise<Api[]>

Inherited from Api.getAllApiByUserAndVisibility
- Defined in query/api.ts:74
description

Get All Api docs by user and visibility, is public or not

Parameters
- userId: number
  
  User ID
- isPublic: boolean
  
  State of visibility: true | false
Returns Promise<Api[]>

getAllPathByIdAndUserId

getAllPathByIdAndUserId(userId: number, tagId: number): Promise<Path[]>

Inherited from Path.getAllPathByIdAndUserId
- Defined in query/path.ts:54
description

Get all paths by ID and User ID

Parameters
- userId: number
  
  User ID
- tagId: number
  
  Tag ID
Returns Promise<Path[]>

getAllResponsesByPathAndUserId

getAllResponsesByPathAndUserId(userId: number, pathId: number): Promise<Response[]>

- Defined in query/response.ts:47
description

Get all responses by Path ID and User ID

Parameters
- userId: number
  
  User ID
- pathId: number
  
  Path ID
Returns Promise<Response[]>

getAllTagById

getAllTagById(userId: number, apiId: number): Promise<Tag[]>

Inherited from Tag.getAllTagById
- Defined in query/tag.ts:49
description

Find all Tags by User ID and Api ID

Parameters
- userId: number
  
  User ID
- apiId: number
  
  Api ID
Returns Promise<Tag[]>

getApiAndTags

getApiAndTags(userId: number, apiId: number): Promise<Api>

Inherited from Api.getApiAndTags
- Defined in query/api.ts:121
description

Get a Api and all Tags related

Parameters
- userId: number
  
  User ID
- apiId: number
  
  API ID
Returns Promise<Api>

getOneApi

getOneApi(userId: number, id: number): Promise<Api>

Inherited from Api.getOneApi
- Defined in query/api.ts:91
description

Get one API doc

Parameters
- userId: number
  
  User ID
- id: number
  
  API ID
Returns Promise<Api>

getPathAndResponses

getPathAndResponses(knexInstance: knex<knex>, tagId: string): Promise<Path[]>

Inherited from Api.getPathAndResponses
- Defined in query/api.ts:145
description

Get a Path and all Responses related

Parameters
- knexInstance: knex<knex>
  
  Instance Knex
- tagId: string
  
  Tag ID
Returns Promise<Path[]>

knex

knex(): knex<knex>

Inherited from Core.knex
- Defined in query/core.ts:26
Returns knex<knex>

migrate

migrate(): Promise<void>

Inherited from Core.migrate
- Defined in query/core.ts:18
Returns Promise<void>

registerNewUser

registerNewUser(name: string, email: string, password: string): Promise<User>

Inherited from User.registerNewUser
- Defined in query/user.ts:12
description

Register a new user

Parameters
- name: string
  
  User Name
- email: string
  
  User Email
- password: string
  
  User Password
Returns Promise<User>

updateApiById

updateApiById(userId: number, id: number, newApi: Api): Promise<void>

Inherited from Api.updateApiById
- Defined in query/api.ts:35
description

Updates an existing api

Parameters
- userId: number
  
  User ID
- id: number
  
  Api ID
- newApi: Api
  
  Api update form
Returns Promise<void>

updatePath

updatePath(userId: number, pathId: number, form: any): Promise<void>

Inherited from Path.updatePath
- Defined in query/path.ts:73
description

Update a Path

Parameters
- userId: number
  
  User ID
- pathId: number
  
  Path ID
- form: any
  
  Form contains: methodType, pathName, descriptionVerb, path, parameter, headersValue, bodyValue and data
Returns Promise<void>

updateResponse

updateResponse(userId: number, responseId: number, form: any): Promise<void>

- Defined in query/response.ts:73
description

Update Response

Parameters
- userId: number
  
  User ID
- responseId: number
  
  Resposne ID
- form: any
  
  Form contains: typeCode and responseModel
Returns Promise<void>

updateTagById

updateTagById(userId: number, tagId: number, form: any): Promise<void>

Inherited from Tag.updateTagById
- Defined in query/tag.ts:32
description

Update a tag

Parameters
- userId: number
  
  User ID
- tagId: number
  
  Tag ID
- form: any
  
  Form with "nameTag" and "descriptionTag"
Returns Promise<void>

userAuth

userAuth(email: string, password: string): Promise<User>

Inherited from Auth.userAuth
- Defined in query/auth.ts:12
description

Logs in user and returns user object with jwt token

Parameters
- email: string
  
  User email
- password: string
  
  Password email
Returns Promise<User>

userRegister

userRegister(nome: string, email: string, password: string): Promise<User>

Inherited from Auth.userRegister
- Defined in query/auth.ts:41
description

Checks user availability and initializes user registration

Parameters
- nome: string
  
  User Name
- email: string
  
  User Email
- password: string
  
  User Password
Returns Promise<User>

Generated using TypeDoc