{"id":18743282,"url":"https://github.com/rimiti/keldoc-js-sdk","last_synced_at":"2025-09-03T13:39:34.422Z","repository":{"id":57288987,"uuid":"106412510","full_name":"rimiti/keldoc-js-sdk","owner":"rimiti","description":"🕷Keldoc Javascript SDK.","archived":false,"fork":false,"pushed_at":"2019-03-07T12:22:50.000Z","size":605,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-09T21:41:07.702Z","etag":null,"topics":["api","healthcare","js","keldoc","node","react-native","sdk"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rimiti.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-10T12:12:39.000Z","updated_at":"2025-03-10T13:34:32.000Z","dependencies_parsed_at":"2022-09-20T05:44:07.718Z","dependency_job_id":null,"html_url":"https://github.com/rimiti/keldoc-js-sdk","commit_stats":null,"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rimiti%2Fkeldoc-js-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rimiti%2Fkeldoc-js-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rimiti%2Fkeldoc-js-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rimiti%2Fkeldoc-js-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rimiti","download_url":"https://codeload.github.com/rimiti/keldoc-js-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248635960,"owners_count":21137342,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","healthcare","js","keldoc","node","react-native","sdk"],"created_at":"2024-11-07T16:10:53.263Z","updated_at":"2025-04-12T21:32:15.665Z","avatar_url":"https://github.com/rimiti.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# keldoc-js-sdk\n\n[![Dependencies][prod-dependencies-badge]][prod-dependencies]\n[![Coverage][coverage-badge]][coverage]\n[![Build Status][travis-badge]][travis-ci]\n[![MIT License][license-badge]][LICENSE]\n[![PRs Welcome][prs-badge]][prs]\n\n\n## Description\n\nThis module provides an Keldoc API implementation.\n\n## Install\n```\n$ npm install @rimiti/keldoc-js-sdk --save\n```\n\n## Features\n\n- Agendas\n- Appointments\n- Availabilities\n- Available slots\n- Config\n- ConfigWebhooks\n- Motives\n- Patients\n- Specialities\n\n## Documentation\n\n* [agenda.get()](#getAgendas)\n* [appointments.create()](#createAppointment)\n* [appointments.update()](#updateAppointment)\n* [appointments.remove()](#removeAppointment)\n* [availabilities.get()](#getAvailabilities)\n* [availableSlots.get()](#getAvailableSlots)\n* [config.get()](#getConfig)\n* [motives.get()](#getMotives)\n* [patients.create()](#createPatient)\n* [patients.update()](#updatePatient)\n* [specialties.get()](#getSpecialties)\n* [configWebhooks.create()](#createConfigWebhooks)\n* [configWebhooks.update()](#updateConfigWebhooks)\n* [configWebhooks.remove()](#removeConfigWebhooks)\n\n## Examples\n\nCreate your keldoc sdk by requiring it, making it's initial configuration and instantiating it.\n\n**From import**\n```javascript\nimport * as sdk from '@rimiti/keldoc-js-sdk'\n\nsdk.configure({\n  credentials: {\n    clientAccessKeyId: 'CLIENT_ACCESS_KEY_ID',\n    secretAccessKeyId: 'SECRET_ACCESS_KEY_ID',\n  },\n  host: 'http://www.example.com'\n});\n\nconst keldoc = sdk.create()\n```\n\n**From require**\n```javascript\nconst sdk = require('@rimiti/keldoc-js-sdk');\n\nsdk.configure({\n  credentials: {\n    clientAccessKeyId: 'CLIENT_ACCESS_KEY_ID',\n    secretAccessKeyId: 'SECRET_ACCESS_KEY_ID',\n  },\n  host: 'http://www.example.com',\n  routes: {\n    agendas: '/agendas.json',\n    appointments: '/appointments',\n    availabilities: '/availabilities',\n    availableSlots: '/available_slots',\n    motives: '/motives.json',\n    patients: '/patients',\n    specialties: '/specialties',\n    config: '/config',\n    configWebhooks: '/config/webhooks' },\n});\n\nconst keldoc = sdk.create();\n```\n\n## API Methods\n\n\u003ca name=\"getAgendas\"/\u003e\n\n### Agenda\n\n* Fetch all agendas.\n\n  __Function__\n\n```javascript\n    const response = await keldoc.agendas.get();\n```\n\n---------------------------------------\n\n\u003ca name=\"createAppointment\"/\u003e\n\n### Appointments\n\n* Create a new appointment\n\n  __Arguments__\n\n```javascript\n    start_at                  {Datetime} start date (required).\n    agenda_id                 {Integer} Agenda ID (required).\n    state                     {String} 'confirmed' or 'canceled' (required).\n    duration                  {Integer} duration in seconds.\n    no_show                   {Boolean} patient hasn \u0026apos; t come.\n    patient_arrived           {Boolean} patient is waiting in the waiting room.\n    no_show_excused           {Boolean} patient hasn \u0026apos; t come but he excused.\n    motive_id                 {Integer} motive id.\n    skip_sms_confirmation     {Boolean} disable sms confirmation for consultation.\n    skip_email_confirmation   {Boolean} disable email confirmation for consultation.\n    skip_sms_reminder         {Boolean} disable sms reminder for consultation.\n    skip_email_reminder       {Boolean} disable email reminder for consultation.\n    patient_id                {Integer} patient ID.\n    patient.first_name        {String} patient firstname.\n    patient.last_name         {String} patient lastname.\n    patient.maiden_name       {String} patient maiden name.\n    patient.gender            {Char} 'm' or 'f'.\n    patient.phone             {String} patient phone number.\n    patient.phone2            {String} patient alternative phone number.\n    patient.email             {String} patient email address.\n    patient.street            {String} patient street number \u0026 streetnames.\n    patient.city              {String} patient city name.\n    patient.zipcode           {String} patient city zipcode.\n```\n\n```javascript\n    const response = await keldoc.appointments.create({start_at: '2001-09-23', agenda_id: '2135', state: 'confirmed'});\n```\n\n\u003ca name=\"updateAppointment\"/\u003e\n\n* Update an existing appointment\n\n  __Arguments__\n\n```javascript\n    id                        {Integer} KelDoc internal ID for appointment to update.\n    start_at                  {Datetime} start date (required).\n    agenda_id                 {Integer} Agenda ID (required).\n    state                     {String} 'confirmed' or 'canceled' (required).\n    duration                  {Integer} duration in seconds.\n    no_show                   {Boolean} patient hasn \u0026apos; t come.\n    patient_arrived           {Boolean} patient is waiting in the waiting room.\n    no_show_excused           {Boolean} patient hasn \u0026apos; t come but he excused.\n    motive_id                 {Integer} motive id.\n    skip_sms_confirmation     {Boolean} disable sms confirmation for consultation.\n    skip_email_confirmation   {Boolean} disable email confirmation for consultation.\n    skip_sms_reminder         {Boolean} disable sms reminder for consultation.\n    skip_email_reminder       {Boolean} disable email reminder for consultation.\n    patient_id                {Integer} patient ID.\n    patient.first_name        {String} patient firstname.\n    patient.last_name         {String} patient lastname.\n    patient.maiden_name       {String} patient maiden name.\n    patient.gender            {Char} 'm' or 'f'.\n    patient.phone             {String} patient phone number.\n    patient.phone2            {String} patient alternative phone number.\n    patient.email             {String} patient email address.\n    patient.street            {String} patient street number \u0026 streetnames.\n    patient.city              {String} patient city name.\n    patient.zipcode           {String} patient city zipcode.\n```\n\n```javascript\n    const response = await keldoc.appointments.update(21354, {start_at: '2001-09-23', agenda_id: '2135', state: 'confirmed'});\n```\n\n\u003ca name=\"removeAppointment\"/\u003e\n\n* Delete an appointment\n\n  __Arguments__\n\n```javascript\n    id {Integer} KelDoc internal ID for appointment to remove.\n```\n\n```javascript\n    const response = await keldoc.appointments.remove(21321);\n```\n\n---------------------------------------\n\n\u003ca name=\"getAvailabilities\"/\u003e\n\n### Availabilities\n\n* Fetch available slots for agendas. Maximum duration between start date and end date is 7 days.\n\n  __Arguments__\n\n```javascript\n    motive_id   {Integer} KelDoc internal ID (required).\n    start_date  {Datetime} start date.\n    end_date    {Datetime} end date.\n    agenda_ids  {Array} IDs of agendas.\n```\n\n```javascript\n    const response = await keldoc.availabilities.get({\n      agenda_ids: 112,\n      end_date: '2017-09-17',\n      start_date: '2017-09-18',\n      motive_id: '366',\n    });\n```\n\n---------------------------------------\n\n\u003ca name=\"getAvailableSlots\"/\u003e\n\n### Available slots\n\n* Fetch available slots for agendas. Maximum duration between start date and end date is 2 months (default is 2 months from now).\n* When motive_ids is [], it means the available slot is for all motives.\n  __Arguments__\n\n```javascript\n    agenda_id   {Array} ID of agenda.\n    start_date  {Datetime} start date.\n    end_date    {Datetime} end date.\n```\n\n```javascript\n    const response = await keldoc.availableSlots.get({\n      agenda_id: 112,\n      start_date: '2017-09-18',\n      end_date: '2017-09-17',\n    });\n```\n\n---------------------------------------\n\n\u003ca name=\"getConfig\"/\u003e\n\n### Config\n\n* Retrieves account configuration : agendas, motives, specialties\n\n```javascript\n    const response = await keldoc.config.get();\n```\n\n---------------------------------------\n\n\u003ca name=\"getMotives\"/\u003e\n\n### Motives\n\n#### Fetch all motives\n\n```javascript\n    const response = await keldoc.motives.get();\n```\n\n---------------------------------------\n\n\u003ca name=\"createPatient\"/\u003e\n\n### Patients\n\n* Create a new patient\n\n  __Arguments__\n\n```javascript\n    first_name  {String} patient firstname.\n    last_name   {String} patient lastname.\n    maiden_name {String} patient maiden name.\n    gender      {Char} 'm' or 'f'.\n    phone       {String} patient phone number.\n    email       {String} patient email address.\n    street      {String} patient street number \u0026 streetnames.\n    city        {String} patient city name.\n    zipcode     {String} patient city zipcode.\n```\n\n```javascript\n    const response = await keldoc.patients.create({\n      first_name: 'test',\n      last_name: 'john',\n      gender: 'm',\n      email: 'test.john@test.com'\n    });\n```\n\n\u003ca name=\"updatePatient\"/\u003e\n\n* Update an existing patient\n\n  __Arguments__\n\n```javascript\n    id          {Integer} KelDoc internal ID for patient to update.\n    first_name  {String} patient firstname.\n    last_name   {String} patient lastname.\n    maiden_name {String} patient maiden name.\n    gender      {Char} 'm' or 'f'.\n    phone       {String} patient phone number.\n    email       {String} patient email address.\n    street      {String} patient street number \u0026 streetnames.\n    city        {String} patient city name.\n    zipcode     {String} patient city zipcode.\n```\n\n```javascript\n   const response = await keldoc.patients.update(12026, {\n      first_name: 'test',\n      last_name: 'john',\n      gender: 'm',\n      email: 'test.john@test.com'\n    });\n```\n\n---------------------------------------\n\n\u003ca name=\"getSpecialties\"/\u003e\n\n### Specialties\n\n* Fetch all specialties\n\n```javascript\n    const response = await keldoc.specialties.get();\n```\n\n---------------------------------------\n\n\u003ca name=\"createConfigWebhooks\"/\u003e\n\n### ConfigWebhooks\n\n* Create account webhook\n\n  __Arguments__\n\n```javascript\n    url {String} Webhook url.\n```\n\n```javascript\n    const response = await keldoc.configWebhooks.create({url: 'http://test.webhook.com'});\n```\n\n\u003ca name=\"updateConfigWebhooks\"/\u003e\n\n* Update account webhook\n\n  __Arguments__\n\n```javascript\n    url {String} Webhook url.\n```\n\n```javascript\n    const response = await keldoc.configWebhooks.update({url: 'http://test.webhook.com'});\n```\n\n\u003ca name=\"removeConfigWebhooks\"/\u003e\n\n* Delete account webhook\n\n  __Arguments__\n\n```javascript\n    url {String} Webhook url.\n```\n\n```javascript\n    const response = await keldoc.configWebhooks();\n```\n\n---------------------------------------\n\n\n## Scripts\n\nRun using npm run \u003cscript\u003e command.\n\n    clean - remove coverage data, Jest cache and transpiled files,\n    lint - lint source files and tests,\n    typecheck - check type annotations,\n    test - lint, typecheck and run tests with coverage,\n    test-only - run tests with coverage,\n    test:watch - interactive watch mode to automatically re-run tests,\n    build - compile source files,\n    build:watch - interactive watch mode, compile sources on change.\n\n\n## License\nMIT © [Dimitri DO BAIRRO](https://github.com/rimiti/keldoc-js-sdk/blob/master/LICENSE)\n\n[prod-dependencies-badge]: https://david-dm.org/rimiti/keldoc-js-sdk/status.svg\n[prod-dependencies]: https://david-dm.org/rimiti/keldoc-js-sdk\n[coverage-badge]: https://codecov.io/gh/rimiti/keldoc-js-sdk/branch/master/graph/badge.svg\n[coverage]: https://codecov.io/gh/rimiti/keldoc-js-sdk\n[travis-badge]: https://travis-ci.org/rimiti/keldoc-js-sdk.svg?branch=master\n[travis-ci]: https://travis-ci.org/rimiti/keldoc-js-sdk\n[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square\n[license]: https://github.com/rimiti/keldoc-js-sdk/blob/master/LICENSE\n[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\n[prs]: http://makeapullrequest.com","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frimiti%2Fkeldoc-js-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frimiti%2Fkeldoc-js-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frimiti%2Fkeldoc-js-sdk/lists"}