sam-data
This repository contains all request and response type/interface models for sam-api-private. Please refer to our postman's API collections first before you read or learn this repository.
If you look at our sam-api-private collection in postman. Each collection have some request method to create, read, update, or delete data in our database. Each request method have a request and response data type/interface that may differ from one another. And each data type/interface defined in this repository.
If your role is as a FRONTEND, you have to make sure that the data carried during request should meet the data format in this repository. Likewise, the format of the response data received should meet the data format in this repository too.
If your role is as a BACKEND, you have to make sure that the data received from a request should meet the data format in this repository. Likewise, the format of the response data should meet the data format in this repository too.
Contents
Installing
To install the latest version from npm
npm install @samelement/sam-dataHow-to-Use
Each of the subtopics below represents a collection defined in postman. Collection's name in postman has the same name as the subtopic below. Each subtopic described how to import and use all of the data type/interface required for request and response.
Example: if you want to import data type/interface to GET all devices, see subtopics with the name Devices, and then find the GET ALL method. You will see code to import and use all request and response data type/interface.
Account-Config
Import:
import { accountConfig } from '@samelement/sam-data';Update Setting:
type requestType = accountConfig.configSetting.request;
type responseType = accountConfig.configSetting.response;Update Whitelabel:
type requestType = accountConfig.configWhiteLabel.request;
type responseType = accountConfig.configWhiteLabel.response;Account-Profile
Import:
import { accountProfile } from '@samelement/sam-data';Get Profile:
type responseType = accountProfile.profileGet.response;Update Profile:
type requestType = accountProfile.profileUpdate.request;
type responseType = accountProfile.profileUpdate.response;Update Organization:
type requestType = accountProfile.organizationUpdate.request;
type responseType = accountProfile.organizationUpdate.response;API-Key
Import:
import { apiKey } from '@samelement/sam-data';Get All API:
type requestType = apiKey.apiGet.allRequest;
type responseType = apiKey.apiGet.allResponse;Get API By ID:
type requestType = apiKey.apiGet.byIdRequest;
type responseType = apiKey.apiGet.byIdResponse;Get Count API:
type requestType = apiKey.apiGet.countRequest;
type responseType = apiKey.apiGet.countResponse;Export PDF & CSV:
type requestType = apiKey.apiExport.request;Create API:
type requestType = apiKey.apiCreate.request;
type responseType = apiKey.apiCreate.response;Update API
type requestType = apiKey.apiUpdate.request;
type responseType = apiKey.apiUpdate.response;Delete API
type requestType = apiKey.apiDelete.request;
type responseType = apiKey.apiDelete.response;City
Import:
import { city } from '@samelement/sam-data';Get All City:
type requestType = city.cityGet.allRequest;
type responseType = city.cityGet.allResponse;Get City By ID:
type responseType = city.cityGet.byIdResponse;Country
Import:
import { country } from '@samelement/sam-data';Get All Country:
type requestType = country.countryGet.allRequest;
type responseType = country.countryGet.allResponse;Get Country By ID:
type responseType = country.countryGet.byIdResponse;Devices
Import:
import { devices } from '@samelement/sam-data';Get All Devices:
type requestType = devices.devicesGet.allRequest;
type responseType = devices.devicesGet.allResponse;Get Devices By ID:
type responseType = devices.devicesGet.byIdResponse;Get Count Devices:
type requestType = devices.devicesGet.countRequest;
type responseType = devices.devicesGet.countResponse;Export PDF & CSV
type requestType = devices.devicesExport.request;Update Device Log
type requestType = devices.devicesUpdate.logRequest;
type responseType = devices.devicesUpdate.logResponse;Update Device State
type requestType = devices.devicesUpdate.stateRequest;
type responseType = devices.devicesUpdate.stateResponse;Delete Device
type requestType = devices.devicesDelete.request;
type responseType = devices.devicesDelete.response;Forgot-and-Reset-Password
Import:
import { devices } from '@samelement/sam-data';Forgot Password
type requestType = forgotResetPwd.forgot.request;
type responeseType = forgotResetPwd.forgot.response;Confirm Reset Password
type requestType = forgotResetPwd.reset.confirm;
type responeseType = forgotResetPwd.reset.response;Reset Password
type requestType = forgotResetPwd.reset.request;
type responeseType = forgotResetPwd.reset.response;Index-or-Dashboard
Import:
import { dashboard } from '@samelement/sam-data';Get Widget Growth
type requestType = dashboard.dashboardWidget.request;
type responseType = dashboard.dashboardWidget.growthResponse;Get Widget Users
type requestType = dashboard.dashboardWidget.request;
type responseType = dashboard.dashboardWidget.usersResponse;Get Widget Devices
type requestType = dashboard.dashboardWidget.request;
type responseType = dashboard.dashboardWidget.devicesResponse;Messages
Import:
import { dashboard } from '@samelement/sam-data';Get All Messages
type requestType = messages.messagesGet.allRequest;
type responseType = messages.messagesGet.allResponse;Get Messages By ID
type responseType = messages.messagesGet.byIdResponse;Update Messages
type responseType = messages.messagesUpdate.response;Sign-Up
Import:
import { signup } from '@samelement/sam-data';Signup
type requestType = signup.signup.request;
type responseType = signup.signup.response;Confirm Signup
type requestType = signup.confirm.request;
type responseType = signup.confirm.response;Users
Import:
import { users } from '@samelement/sam-data';Get All Users:
type requestType = users.usersGet.allRequest;
type responseType = users.usersGet.allResponse;Get Users By ID:
type responseType = users.usersGet.byIdResponse;Get Count Users:
type requestType = users.usersGet.countRequest;
type responseType = users.usersGet.countResponse;Export PDF & CSV
type requestType = users.usersExport.request;Update Users Confirmation
type requestType = users.usersUpdate.request;
type responseType = users.usersUpdate.response;Delete Users
type requestType = users.usersDelete.request;
type responseType = users.usersDelete.response;Widget-Declare
Import:
import { widgets } from '@samelement/sam-data';Get All Widgets:
type requestType = widgets.widgetsGet.allRequest;
type responseType = widgets.widgetsGet.allResponse;Get Widgets By ID:
type requestType = widgets.widgetsGet.byIdRequest;
type responseType = widgets.widgetsGet.byIdResponse;Get Count Widgets:
type requestType = widgets.widgetsGet.countRequest;
type responseType = widgets.widgetsGet.countResponse;Create/Update Widgets
type requestType = widgets.widgetsCreate.request;
type responseType = widgets.widgetsCreate.response;Update Widgets Status
type requestType = widgets.widgetsUpdate.request;
type responseType = widgets.widgetsUpdate.response;Delete Widgets
type requestType = widgets.widgetsDelete.request;
type responseType = widgets.widgetsDelete.response;Delete Widgets Logo
type requestType = widgets.widgetsLogo.deleteRequest;
type responseType = widgets.widgetsLogo.deleteResponse;Widget-Default
Import:
import { models } from '@samelement/sam-data';Get All Widget Models:
type requestType = models.modelsGet.allRequest;
type responseType = models.modelsGet.allResponse;Get Widget Models By ID:
type responseType = models.modelsGet.byIdResponse;Get Count Widget Models:
type requestType = models.modelsGet.countRequest;
type responseType = models.modelsGet.countResponse;Create/Update Widget Models
type requestType = models.modelsCreate.request;
type responseType = models.modelsCreate.response;Delete Widget Models
type requestType = models.modelsDelete.request;
type responseType = models.modelsDelete.response;Delete Widget Models Logo
type responseType = models.modelsLogo.deleteResponse;