Class Sympla

Hierarchy

Sympla

Index

Constructors

constructor

Properties

token
url

Methods

Constructors

constructor

new Sympla(token: string): Sympla

- Defined in sympla.ts:11
url

https://ajuda.sympla.com.br/hc/pt-br/articles/360020278592-A-Sympla-possui-uma-API-p%C3%BAblica-

Parameters
- token: string
  
  Chave de acesso do Sympla. Deve ser obtido através do meny "Minha Conta" e navegar até a aba Integrações
Returns Sympla

Properties

Private token

token: string

Private url

url: string = "https://api.sympla.com.br"

Methods

listarEventos

listarEventos(queryListarEventos?: QueryListarEventos): Promise<ResponseListarEventos>

- Defined in sympla.ts:29
description

Retorna os eventos criados pelo organizador.

url

https://developers.sympla.com.br/api-doc/index.html#operation/getAllEvent

Parameters
- Optional queryListarEventos: QueryListarEventos
  
  Query com os filtros para obter a lista de eventos
Returns Promise<ResponseListarEventos>

listarEventosID

listarEventosID(event_id: number, queryListarEventosID?: QueryListarEventosID): Promise<ResponseListarEventosID>

- Defined in sympla.ts:50
description

Retorna o evento correspondente ao identificador informado

url

https://developers.sympla.com.br/api-doc/index.html#operation/getEventId

Parameters
- event_id: number
  
  Identificador único do evento
- Optional queryListarEventosID: QueryListarEventosID
  
  Query com os filtros para obter a lista de eventos por identificador
Returns Promise<ResponseListarEventosID>

listarParticipantesEvento

listarParticipantesEvento(event_id: number, queryListarParticipantesEvento?: QueryListarParticipantesEvento): Promise<ResponseListarParticipantesEvento>

- Defined in sympla.ts:135
description

Retorna os participantes de um determinado evento.

Parameters
- event_id: number
  
  Identificador único do evento
- Optional queryListarParticipantesEvento: QueryListarParticipantesEvento
Returns Promise<ResponseListarParticipantesEvento>

listarParticipantesIngresso

listarParticipantesIngresso(event_id: number, participant_id: number, queryListarParticipantesEvento?: QueryListarParticipantesIngresso): Promise<ResponseListarParticipantesIngresso>

- Defined in sympla.ts:156
description

Retorna o participante correspondente ao ingresso informado

Parameters
- event_id: number
  
  Identificador único do evento
- participant_id: number
  
  Identificador único do ingresso
- Optional queryListarParticipantesEvento: QueryListarParticipantesIngresso
Returns Promise<ResponseListarParticipantesIngresso>

listarParticipantesPedido

listarParticipantesPedido(event_id: number, order_id: string, queryListarParticipantesPedido?: QueryListarParticipantesPedido): Promise<ResponseListarParticipantesPedido>

- Defined in sympla.ts:115
description

Retorna o(s) participante(s) contido(s) em um determinado pedido.

Parameters
- event_id: number
  
  Identificador único do evento
- order_id: string
  
  Identificador único do pedido
- Optional queryListarParticipantesPedido: QueryListarParticipantesPedido
Returns Promise<ResponseListarParticipantesPedido>

listarPedidosEvento

listarPedidosEvento(event_id: number, queryListarPedidosEvento?: QueryListarPedidosEvento): Promise<ResponseListarPedidosEvento>

- Defined in sympla.ts:72
description

Retorna os pedidos de um determinado evento

url

https://developers.sympla.com.br/api-doc/index.html#operation/getListOrders

Parameters
- event_id: number
  
  Identificador único do evento
- Optional queryListarPedidosEvento: QueryListarPedidosEvento
  
  Query com os filtros para obter a lista de pedidos do evento
Returns Promise<ResponseListarPedidosEvento>

listarPedidosIdentificador

listarPedidosIdentificador(event_id: number, order_id: string, queryListarPedidosId?: QueryListarPedidosID): Promise<ResponseListarPedidosIdentificador>

- Defined in sympla.ts:94
description

Retorna o pedido correspondente ao identificador informado.

Parameters
- event_id: number
  
  Identificador único do evento
- order_id: string
  
  Identificador único do pedido
- Optional queryListarPedidosId: QueryListarPedidosID
Returns Promise<ResponseListarPedidosIdentificador>

Generated using TypeDoc