1.1.4 • Published 7 years ago

cosium-js-sdk v1.1.4

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

cosium-js-sdk

Build Status Coverage Status Issue Count NPM version Downloads

Cosium Javascript SDK

Install

$ npm install cosium-js-sdk

Available methods

  • Getting available timeslots
import * as sdk from 'cosium-js-sdk'

sdk.configure({url: "https://www.example.com", credentials: {username: "username", password: "password"}})
const cosium = sdk.create()

const params = {
  siteCode: "c1",
  startDate: "2017-09-23T12:00:00.000Z",
  endDate: "2017-09-23T13:00:00.000Z"
}

cosium.getAvailableTimeslots(params).then((response) => {
	console.log(response)
})

Response body example:

{
  "errorCode": null,
  "errorMessage": null,
  "availableTimeSlots": [
    {"date": "2017-09-23T12:00:00.000+0000", "qualifications": ["CONTACT_LENS", "OPTIC", "HEARING_AID"]},
    {"date": "2017-09-23T12:30:00.000+0000", "qualifications": ["CONTACT_LENS", "OPTIC", "HEARING_AID"]}
  ]
}

request parameter for calling the function:

NamedescriptionRequired
siteCoderequested center codetrue
startDatestart datetrue
endDateend datetrue

N.B: The difference between startDate and endDate should be at maximum 20 days

  • Create an appointment
import * as sdk from 'cosium-js-sdk'

sdk.configure({url: "https://www.example.com", credentials: {username: "username", password: "password"}})
const cosium = sdk.create()

const params = {
  "siteCode": "c1",
  "description": "my description",
  "object": "appointement subject",
  "qualification": "HEARING_AID",
  "category": "consultation1",
  "date": "2017-08-24T15:30:25+02:00",
  "customer":
  {
    "firstname": "Jean",
    "lastname": "Dupont",
    "email": "jean.dupont@gmail.com"
  }
}

cosium.createAppointment(params).then((response) => {
	console.log(response)
})

Response body example:

{"errorCode": null, "bookingId": "1935472128"}

request parameter for calling the function:

NamedescriptionRequired
siteCoderequested center codetrue
datedate of appointmenttrue
objectobject of the appointmenttrue
categorycode of appointment categorytrue
descriptiondescription of the appointmentfalse
timeslotDurationInMinutesduration in minutes of the slotfalse
customercustomer informationstrue
customer.firstnamefirstname of customertrue
customer.lastnamelastname of customertrue
customer.emailemail of customerfalse
qualificationdesired qualification of the sellerfalse
  • Delete an appointment
import * as sdk from 'cosium-js-sdk'

sdk.configure({url: "https://www.example.com", credentials: {username: "username", password: "password"}})
const cosium = sdk.create()

const params = {
 	"siteCode": "c1",
  "bookingId": "20"
}

cosium.cancelAppointment(params).then((response) => {
	console.log(response)
})

Response body example:

{"errorCode": null}

request parameter for calling the function:

NamedescriptionRequired
siteCoderequested center codetrue
bookingIdunique identifier of the reservation to be deletedtrue

Tests

// Run tests
npm test

License

MIT © Dimitri DO BAIRRO

1.1.4

7 years ago

1.1.3

7 years ago

1.1.2

7 years ago

1.1.1

7 years ago

1.1.0

7 years ago

1.0.4

7 years ago

1.0.3

7 years ago

1.0.2

7 years ago

1.0.1

7 years ago

0.1.0

7 years ago