@medipass/web-sdk 11.37.8 → 11.38.1-feature-typescript-claudia.0

package/lib/resources/staff.js.flow

@@ -1,583 +0,0 @@
-// @flow
-
-import request from '../utils/request';
-import doesParamExist from '../utils/does-param-exist';
-import type { MedipassRequestOpts } from '../_types';
-
-const pathBusinessPracticeStaffMembers = (businessId, practiceId) =>
-  `/businesses/${businessId}/practices/${practiceId}/staff`;
-const pathBusinessPracticeStaffMember = (businessId, practiceId, staffId) =>
-  `/businesses/${businessId}/practices/${practiceId}/staff/${staffId}`;
-const pathBusinessFormPracticeStaffMembers = (businessId, formId, practiceId) =>
-  `/businesses/${businessId}/forms/${formId}/practices/${practiceId}/staff`;
-const pathBusinessServiceStaffMembers = (businessId, serviceId) =>
-  `/businesses/${businessId}/services/${serviceId}/staff`;
-const pathBusinessStaff = businessId => `/businesses/${businessId}/staff`;
-const pathBusinessStaffMember = (businessId, staffId) => `/businesses/${businessId}/staff/${staffId}`;
-const pathOrganisationStaff = organisationId => `/organisations/${organisationId}/staff`;
-const pathOrganisationStaffMember = (organisationId, staffId) => `/organisations/${organisationId}/staff/${staffId}`;
-const pathStaffMember = staffId => `/staff/${staffId}`;
-const pathProviderSetItems = (businessId, staffId) => `/businesses/${businessId}/staff/${staffId}/providersetitems`;
-const pathProviderSetItem = (businessId, staffId, providerSetItemId) =>
-  `/businesses/${businessId}/staff/${staffId}/providersetitems/${providerSetItemId}`;
-const pathProvidersStatus = '/providers/status';
-
-/**
- * Create business staff member
- * @param {String} businessId - Organisation ID
- * @param {Object} body - Request body
- * @param {Object} opts - Additional options
- */
-export const createBusinessStaffMember = async (
-  businessId: string,
-  body: Object,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId }, opts.hyperMediaEndpoint);
-  return request({ ...opts, path: pathBusinessStaff(businessId) }, { method: 'post', data: body });
-};
-
-/**
- * Create organisation staff member
- * @param {String} organisationId - Organisation ID
- * @param {Object} body - Request body
- * @param {Object} opts - Additional options
- */
-export const createOrganisationStaffMember = async (
-  organisationId: string,
-  body: Object,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ organisationId }, opts.hyperMediaEndpoint);
-  return request({ ...opts, path: pathOrganisationStaff(organisationId) }, { method: 'post', data: body });
-};
-
-/**
- * Delete business staff member
- * @param {String} businessId - Business ID
- * @param {String} staffId - Staff ID
- * @param {Object} opts - Additional options
- */
-export const deleteBusinessStaffMember = async (
-  businessId: string,
-  staffId: string,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, staffId }, opts.hyperMediaEndpoint);
-  return request({ ...opts, path: pathBusinessStaffMember(businessId, staffId) }, { method: 'delete' });
-};
-
-/**
- * Delete business staff member email
- * @param {String} businessId - Business ID
- * @param {String} staffId - Staff ID
- * @param {Object} opts - Additional options
- */
-export const deleteBusinessStaffMemberEmail = async (
-  businessId: string,
-  staffId: string,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, staffId }, opts.hyperMediaEndpoint);
-  return request({ ...opts, path: `${pathBusinessStaffMember(businessId, staffId)}/email` }, { method: 'delete' });
-};
-
-/**
- * Get business staff member
- * @param {Object} businessId - Business ID
- * @param {Object} staffId - Staff ID
- * @param {Object} opts - Additional options
- */
-export const getBusinessStaffMember = async (
-  businessId: string,
-  staffId: string,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, staffId }, opts.hyperMediaEndpoint);
-  return request({ ...opts, path: pathBusinessStaffMember(businessId, staffId) }, { method: 'get' });
-};
-
-/**
- * Get business staff member roles
- * @param {String} businessId - Business ID
- * @param {String} staffId - Staff ID
- * @param {String} roleFullName - Role
- * @param {Object} opts - Additional options
- */
-export const getBusinessStaffMemberRoles = async (
-  businessId: string,
-  staffId: string,
-  roleFullName: string,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, staffId }, opts.hyperMediaEndpoint);
-  return request(
-    { ...opts, path: `${pathBusinessStaffMember(businessId, staffId)}/roles` },
-    { method: 'get', params: { fullName: roleFullName } }
-  );
-};
-
-/**
- * Get business practice staff member
- * @param {Object} businessId - Business ID
- * @param {Object} practiceId - Practice ID
- * @param {Object} staffId - Staff ID
- * @param {Object} opts - Additional options
- */
-export const getBusinessPracticeStaffMember = async (
-  businessId: string,
-  practiceId: string,
-  staffId: string,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, practiceId, staffId }, opts.hyperMediaEndpoint);
-  return request(
-    { ...opts, path: pathBusinessPracticeStaffMember(businessId, practiceId, staffId) },
-    { method: 'get' }
-  );
-};
-
-/**
- * Get business practice staff member modalities
- * @param {Object} businessId - Business ID
- * @param {Object} practiceId - Practice ID
- * @param {Object} staffId - Staff ID
- * @param {Object} query - Query parameters
- * @param {Object} opts - Additional options
- */
-export const getBusinessPracticeStaffMemberModalities = async (
-  businessId: string,
-  practiceId: string,
-  staffId: string,
-  query?: Object = {},
-  opts?: MedipassRequestOpts = {}
-): Promise<Array<Object>> => {
-  doesParamExist({ businessId, practiceId, staffId }, opts.hyperMediaEndpoint);
-  return request(
-    { ...opts, path: `${pathBusinessPracticeStaffMember(businessId, practiceId, staffId)}/modalities` },
-    { method: 'get', params: query }
-  );
-};
-
-/**
- * Get business practice staff members
- * @param {Object} businessId - Business ID
- * @param {Object} practiceId - Practice ID
- * @param {Object} query - Query parameters
- * @param {Object} opts - Additional options
- */
-export const getBusinessPracticeStaffMembers = async (
-  businessId: string,
-  practiceId: string,
-  query?: Object,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, practiceId }, opts.hyperMediaEndpoint);
-  return request(
-    { ...opts, path: pathBusinessPracticeStaffMembers(businessId, practiceId) },
-    { method: 'get', params: query }
-  );
-};
-
-/**
- * Get business form practice staff members
- * @param {Object} businessId - Business ID
- * @param {Object} formId - Form ID
- * @param {Object} practiceId - Practice ID
- * @param {Object} query - Query parameters
- * @param {Object} opts - Additional options
- */
-export const getBusinessFormPracticeStaffMembers = async (
-  businessId: string,
-  formId: string,
-  practiceId: string,
-  query?: Object,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, formId, practiceId }, opts.hyperMediaEndpoint);
-  return request(
-    { ...opts, path: pathBusinessFormPracticeStaffMembers(businessId, formId, practiceId) },
-    { method: 'get', params: query }
-  );
-};
-
-/**
- * Get business service staff members
- * @param {Object} businessId - Business ID
- * @param {Object} serviceId - Service ID
- * @param {Object} query - Query parameters
- * @param {Object} opts - Additional options
- */
-export const getBusinessServiceStaffMembers = async (
-  businessId: string,
-  serviceId: string,
-  query?: Object = {},
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, serviceId }, opts.hyperMediaEndpoint);
-  return request(
-    { ...opts, path: pathBusinessServiceStaffMembers(businessId, serviceId) },
-    { method: 'get', params: query }
-  );
-};
-
-/**
- * Get business staff members
- * @param {Object} opts - Additional options
- */
-export const getBusinessStaffMembers = async (
-  businessId: string,
-  query?: Object,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId }, opts.hyperMediaEndpoint);
-  return request({ ...opts, path: pathBusinessStaff(businessId) }, { method: 'get', params: query });
-};
-
-/**
- * Get business staff upload urls
- * @param {String} businessId - Business ID
- * @param {String} staffId - Staff ID
- * @param {String} contentType - Mime type
- * @param {Object} opts - Additional options
- */
-export const getBusinessStaffUploadUrl = async (
-  businessId: string,
-  staffId: string,
-  contentType: string,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, staffId, contentType }, opts.hyperMediaEndpoint);
-  return request(
-    { ...opts, path: `${pathBusinessStaffMember(businessId, staffId)}/uploadurlv2` },
-    { method: 'get', params: { contentType } }
-  );
-};
-
-/**
- * Get organisation staff members
- * @param {String} organisationId - Organisation ID
- * @param {Object} opts - Additional options
- */
-export const getOrganisationStaffMembers = async (
-  organisationId: string,
-  query?: Object = {},
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ organisationId }, opts.hyperMediaEndpoint);
-  return request({ ...opts, path: pathOrganisationStaff(organisationId) }, { method: 'get', params: query });
-};
-
-/**
- * Get staff member
- * @param {String} staffId - Staff ID
- * @param {Object} opts - Additional options
- */
-export const getStaffMember = async (staffId: string, opts?: MedipassRequestOpts = {}): Promise<Object> => {
-  doesParamExist({ staffId }, opts.hyperMediaEndpoint);
-  return request({ ...opts, path: pathStaffMember(staffId) }, { method: 'get' });
-};
-
-/**
- * Grant business practice staff role
- * @param {String} businessId - Business ID
- * @param {String} practiceId - Practice ID
- * @param {String} staffId - Staff ID
- * @param {String} roleFullName - Role
- * @param {Object} opts - Additional options
- */
-export const grantBusinessPracticeStaffRole = async (
-  businessId: string,
-  practiceId: string,
-  staffId: string,
-  roleFullName: string,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, practiceId, staffId }, opts.hyperMediaEndpoint);
-  return request(
-    { ...opts, path: `${pathBusinessPracticeStaffMember(businessId, practiceId, staffId)}/roles` },
-    { method: 'post', data: { roleFullName } }
-  );
-};
-
-/**
- * Grant business practice staff role
- * @param {String} businessId - Business ID
- * @param {String} staffId - Staff ID
- * @param {String} roleFullName - Role
- * @param {Object} body - Request body
- * @param {Object} opts - Additional options
- */
-export const grantBusinessStaffRole = async (
-  businessId: string,
-  staffId: string,
-  roleFullName: string,
-  body?: Object,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, staffId }, opts.hyperMediaEndpoint);
-  return request(
-    { ...opts, path: `${pathBusinessStaffMember(businessId, staffId)}/roles` },
-    { method: 'post', data: { roleFullName, ...body } }
-  );
-};
-
-/**
- * Invite a new business staff member
- * @param {String} businessId - Business ID
- * @param {Object} body - Request body
- * @param {Object} opts - Additional options
- */
-export const inviteNewBusinessStaffMember = async (
-  businessId: string,
-  body?: Object,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId }, opts.hyperMediaEndpoint);
-  return request({ ...opts, path: `${pathBusinessStaff(businessId)}/invites` }, { method: 'post', data: body });
-};
-
-/**
- * Invite business staff
- * @param {String} businessId - Business ID
- * @param {String} staffId - Staff ID
- * @param {Object} opts - Additional options
- */
-export const inviteBusinessStaffMember = async (
-  businessId: string,
-  staffId: string,
-  body?: Object = { createNewAccount: false },
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId }, opts.hyperMediaEndpoint);
-  return request(
-    { ...opts, path: `${pathBusinessStaffMember(businessId, staffId)}/invites` },
-    { method: 'post', data: body }
-  );
-};
-
-/**
- * Revoke business practice staff role
- * @param {String} businessId - Business ID
- * @param {String} practiceId - Practice ID
- * @param {String} staffId - Staff ID
- * @param {String} roleFullName - Role
- * @param {Object} opts - Additional options
- */
-export const revokeBusinessPracticeStaffRole = async (
-  businessId: string,
-  practiceId: string,
-  staffId: string,
-  roleFullName: string,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, practiceId, staffId }, opts.hyperMediaEndpoint);
-  return request(
-    { ...opts, path: `${pathBusinessPracticeStaffMember(businessId, practiceId, staffId)}/roles` },
-    { method: 'delete', data: { roleFullName } }
-  );
-};
-
-/**
- * Revoke business practice staff role
- * @param {String} businessId - Business ID
- * @param {String} staffId - Staff ID
- * @param {String} roleFullName - Role
- * @param {Object} body - Request body
- * @param {Object} opts - Additional options
- */
-export const revokeBusinessStaffRole = async (
-  businessId: string,
-  staffId: string,
-  roleFullName: string,
-  body?: Object,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, staffId }, opts.hyperMediaEndpoint);
-  return request(
-    { ...opts, path: `${pathBusinessStaffMember(businessId, staffId)}/roles` },
-    { method: 'delete', data: { roleFullName, ...body } }
-  );
-};
-
-/**
- * Update business staff member
- * @param {String} businessId - Business ID
- * @param {String} staffId - Staff ID
- * @param {Object} body - Request body
- * @param {Object} opts - Additional options
- */
-export const updateBusinessStaffMember = async (
-  businessId: string,
-  staffId: string,
-  body: Object,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, staffId }, opts.hyperMediaEndpoint);
-  return request({ ...opts, path: pathBusinessStaffMember(businessId, staffId) }, { method: 'put', data: body });
-};
-
-/**
- * Create or resend a magic link to update current staff's email
- * @param {String} businessId - Business ID
- * @param {String} staffId - Staff ID
- * @param {Object} body - Request body
- * @param {Object} opts - Additional options
- */
-export const updateBusinessStaffMemberEmail = async (
-  businessId: string,
-  staffId: string,
-  body: Object,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, staffId }, opts.hyperMediaEndpoint);
-  return request(
-    { ...opts, path: `${pathBusinessStaffMember(businessId, staffId)}/changeemail` },
-    { method: 'post', data: body }
-  );
-};
-
-/**
- * Update organisation staff member
- * @param {String} organisationId - Organisation ID
- * @param {String} staffId - Staff ID
- * @param {Object} body - Request body
- * @param {Object} opts - Additional options
- */
-export const updateOrganisationStaffMember = async (
-  organisationId: string,
-  staffId: string,
-  body: Object,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ organisationId, staffId }, opts.hyperMediaEndpoint);
-  return request(
-    { ...opts, path: pathOrganisationStaffMember(organisationId, staffId) },
-    { method: 'put', data: body }
-  );
-};
-
-/**
- * Verify staff member
- * @param {String} staffId - Staff ID
- * @param {Object} body - Request body
- * @param {Object} opts - Additional options
- */
-export const verifyStaffMember = async (
-  staffId: string,
-  body: Object,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ staffId }, opts.hyperMediaEndpoint);
-  return request({ ...opts, path: `${pathStaffMember(staffId)}/verify` }, { method: 'post', data: body });
-};
-
-/**
- * Clone staff member into another business
- * @param {String} staffId - Staff ID
- * @param {Object} body - Request body
- * @param {Object} opts - Additional options
- */
-export const cloneStaffMemberIntoBusiness = async (
-  staffId: string,
-  body: Object,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ staffId }, opts.hyperMediaEndpoint);
-  return request({ ...opts, path: `${pathStaffMember(staffId)}/clone` }, { method: 'post', data: body });
-};
-
-/**
- * Check if email exists
- * @param {String} businessId - Business ID
- * @param {Object} query - Query parameters
- * @param {Object} opts - Additional options
- */
-export const checkStaffMemberEmailExists = (
-  businessId: string,
-  query: { email: string },
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId }, opts.hyperMediaEndpoint);
-  return request({ ...opts, path: `${pathBusinessStaff(businessId)}/exists` }, { method: 'get', params: query });
-};
-
-/**
- * Create business staff provider set item
- * @param {String} businessId - Business ID
- * @param {String} staffId - Staff ID
- * @param {Object} body - Request body
- * @param {Object} opts - Additional options
- */
-export const createStaffProviderSetItem = async (
-  businessId: string,
-  staffId: string,
-  body: Object,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, staffId }, opts.hyperMediaEndpoint);
-  return request({ ...opts, path: `${pathProviderSetItems(businessId, staffId)}` }, { method: 'post', data: body });
-};
-
-/**
- * Update business staff provider set item
- * @param {String} businessId - Business ID
- * @param {String} staffId - Staff ID
- * @param {String} providerSetItemId - Provider set item ID
- * @param {Object} body - Request body
- * @param {Object} opts - Additional options
- */
-export const updateStaffProviderSetItem = async (
-  businessId: string,
-  staffId: string,
-  providerSetItemId: string,
-  body: Object,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, staffId, providerSetItemId }, opts.hyperMediaEndpoint);
-  return request(
-    { ...opts, path: pathProviderSetItem(businessId, staffId, providerSetItemId) },
-    { method: 'put', data: body }
-  );
-};
-
-/**
- * Delete business staff provider set item
- * @param {String} businessId - Business ID
- * @param {String} staffId - Staff ID
- * @param {String} providerSetItemId - Provider set item ID
- * @param {Object} opts - Additional options
- */
-export const deleteStaffProviderSetItem = async (
-  businessId: string,
-  staffId: string,
-  providerSetItemId: string,
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId, staffId, providerSetItemId }, opts.hyperMediaEndpoint);
-  return request({ ...opts, path: pathProviderSetItem(businessId, staffId, providerSetItemId) }, { method: 'delete' });
-};
-
-/**
- * Gets a list of providers and their current status.
- * @param {String} businessId - Business ID
- * @param {Object} query - Query parameters
- * @param {Object} opts - Additional options
- */
-export const getProvidersStatus = (
-  businessId: string,
-  query: { providerNumber?: string },
-  opts?: MedipassRequestOpts = {}
-): Promise<Object> => {
-  doesParamExist({ businessId }, opts.hyperMediaEndpoint);
-  return request(
-    { ...opts, path: pathProvidersStatus },
-    {
-      method: 'get',
-      params: {
-        ...query,
-        businessId
-      }
-    }
-  );
-};