@jifeline/customer-tickets v0.3.0

Customer Tickets library

The Customer Tickets library is an implementation of the tickets domain within the Jifeline Customer API. With this library, after setting the config in the @jifeline/core auth module, relevant topics regarding tickets can be performed.

Usage of the library

Import the customerTickets library to make use of the different features.

import { auth } from '@jifeline/core';
import { customerTickets } from '@jifeline/customer-tickets';

// Configure the core lib and authenticate by login in with connector / pin or username & password.
auth.configure(config);
auth.loginPin().subscribe();
auth.loginUsername().subscribe();

// After authentication - use the customer tickets library. Eg;
customerTickets
  .offerTicket
  .createTicket()
  .subscribe();

Features

The Customer Tickets library provides the following features:

• offer ticket
• ticket metadata
• ticket state
• ticket connection state
• historical tickets
• prepared tickets
• notes

Offer ticket

The offer ticket feature gives access to all functionality required to offer a ticket to the service provider from a customer perspective.

The following functions are supported:

• get ticket offer
• create ticket
• is ticket offer complete
• throw ticket offer not complete

Ticket metadata

The ticket metadata feature creates the ticket metadata that's required for offering a ticket.

The following functions are supported:

• get ticket metadata

Ticket state

The ticket state feature gives access to all ticket state updates. These updates are acquired from a websocket implementation and are pushed from the server to the client.

The following functions are supported:

• get state
• get vehicle
• get ticket schedule
• get cancelled reason
• get connection uuid
• get chat session state
• is script composition running

Ticket connection state

The ticket connection state feature gives access to all ticket connection state updates. These updates are acquired from a websocket implementation and are pushed from the server to the client.

The following functions are supported:

• get ticket connection state

Historical tickets

The historical tickets feature has access to the tickets performed on a vehicle, based on the VIN of a vehicle.

The following functions are supported:

• get historical tickets

Prepared ticket

The prepared tickets feature has access to prepared tickets for a vehicle, based on the VIN of a vehicle.

The following functions are supported:

• get prepared ticket
• get all prepared tickets for a customer
• has prepared tickets

Ticket notes

The ticket notes feature has access to the notes on a ticket.

The following functions are supported:

• get notes
• get all notes
• download attachment
• filter notes by category