@verys/oracle-sdk NPM

oracle-sdk

OracleSdk - JavaScript client for oracle-sdk Oracle API This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install oracle-sdk --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your oracle-sdk from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var OracleSdk = require('oracle-sdk');

var defaultClient = OracleSdk.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: http_jwt
var http_jwt = defaultClient.authentications['http_jwt'];
http_jwt.accessToken = "YOUR ACCESS TOKEN"

var api = new OracleSdk.BigTimeApi()
var UNKNOWN_BASE_TYPE = new OracleSdk.UNKNOWN_BASE_TYPE(); // {UNKNOWN_BASE_TYPE} BigTime bulk import
api.bigTimeImport(UNKNOWN_BASE_TYPE).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://api.test.oracle.verys.com/v1

Class	Method	HTTP request	Description
OracleSdk.BigTimeApi	bigTimeImport	POST /bigtime/import	Import time entries, clients, projects, and users from BigTime
OracleSdk.ChartsApi	getMyChartsById	GET /my/charts/{id}	Gets charts resource for the currently authenticated employee
OracleSdk.CompaniesApi	createCompanies	POST /companies	Create a new `companies` resource
OracleSdk.CompaniesApi	getCompanies	GET /companies	Get all companies resources
OracleSdk.CompaniesApi	getCompaniesById	GET /companies/{id}	Get a `companies` resource
OracleSdk.CompaniesApi	updateCompaniesById	PATCH /companies/{id}	Update a specific company resource
OracleSdk.CompanyLocationsApi	createCompanyLocations	POST /company-locations	Create a new company location
OracleSdk.CompanyLocationsApi	deleteCompanyLocationsById	DELETE /company-locations/{id}	Delete a `company locations` resource by it's ID
OracleSdk.CompanyLocationsApi	getCompanyLocations	GET /company-locations	Get all `company locations` resources
OracleSdk.CompanyLocationsApi	getCompanyLocationsById	GET /company-locations/{id}	Get a `company locations` resource by it's ID
OracleSdk.CompanyLocationsApi	updateCompanyLocationsById	PATCH /company-locations/{id}	Update a `company locations` resource by it's ID
OracleSdk.EmployeesApi	createEmployees	POST /employees	Create a new `employees` resource
OracleSdk.EmployeesApi	createPasswordResetEmails	POST /employees/password-reset-emails	Creates a `password reset emails` resource for an employee
OracleSdk.EmployeesApi	createPasswordResets	POST /employees/password-resets	Creates a `password resets` resource
OracleSdk.EmployeesApi	createProfileRelationshipsDefaultProjects	POST /my/profile/relationships/default-projects	Adds to the currently authenticated employee's default projects
OracleSdk.EmployeesApi	createRegistrationConfirmationEmails	POST /employees/{id}/registration-confirmation-emails	Creates a `registration confirmation emails` resource
OracleSdk.EmployeesApi	createRegistrationConfirmations	POST /employees/registration-confirmations	Creates a `registration confirmations` resource
OracleSdk.EmployeesApi	createRolesByIdRelationshipsEmployees	POST /roles/{id}/relationships/employees	Create `employees` relationship from a `roles` resource by Id
OracleSdk.EmployeesApi	deleteProfileRelationshipsDefaultProjects	DELETE /my/profile/relationships/default-projects	Deletes from the currently authenticated employee's default projects
OracleSdk.EmployeesApi	deleteRolesByIdRelationshipsEmployees	DELETE /roles/{id}/relationships/employees	Delete `employees` relationship from a `roles` resource by Id
OracleSdk.EmployeesApi	getEmployees	GET /employees	Get all employees resources
OracleSdk.EmployeesApi	getEmployeesById	GET /employees/{id}	Get a specific employee resource
OracleSdk.EmployeesApi	getProfile	GET /my/profile	Gets the currently authenticated employee
OracleSdk.EmployeesApi	getProfileRelationshipsDefaultProjects	GET /my/profile/relationships/default-projects	Gets the currently authenticated employee's default projects
OracleSdk.EmployeesApi	getRolesByIdEmployees	GET /roles/{id}/employees	Get `employees` that belong to a `roles` resource by Id
OracleSdk.EmployeesApi	getRolesByIdRelationshipsEmployees	GET /roles/{id}/relationships/employees	Get `employees` relationship from a `roles` resource by Id
OracleSdk.EmployeesApi	updateEmployeesById	PATCH /employees/{id}	Update a specific employee resource
OracleSdk.EmployeesApi	updateProfile	PATCH /my/profile	Update the currently authenticated employee profile
OracleSdk.EmployeesApi	updateProfileRelationshipsDefaultProjects	PATCH /my/profile/relationships/default-projects	Updates the currently authenticated employee's default projects
OracleSdk.EmployeesApi	updateRolesByIdRelationshipsEmployees	PATCH /roles/{id}/relationships/employees	Update `employees` relationship from a `roles` resource by Id
OracleSdk.HealthCheckApi	getHealthCheck	GET /health-check	Health check
OracleSdk.IntegrationsApi	getIntegrations	GET /integrations	Get all integrations resources
OracleSdk.IntegrationsApi	getIntegrationsById	GET /integrations/{slug}	Get a specific integration resource
OracleSdk.LocalesApi	getLocales	GET /locales	Get all `locales`
OracleSdk.LocalesApi	getLocalesById	GET /locales/{localeCode}	Get a `locales` resource
OracleSdk.MyApi	createMyTimeEntries	POST /my/time-entries	Create a new time entries resource for the currently authenticated employee
OracleSdk.MyApi	createProfileRelationshipsDefaultProjects	POST /my/profile/relationships/default-projects	Adds to the currently authenticated employee's default projects
OracleSdk.MyApi	deleteMyTimeEntries	DELETE /my/time-entries	Delete one or more time entries resources for the currently authenticated employee
OracleSdk.MyApi	deleteMyTimeEntriesById	DELETE /my/time-entries/{id}	Delete a specific time entries resource for the currently authenticated employee
OracleSdk.MyApi	deleteProfileRelationshipsDefaultProjects	DELETE /my/profile/relationships/default-projects	Deletes from the currently authenticated employee's default projects
OracleSdk.MyApi	getMyChartsById	GET /my/charts/{id}	Gets charts resource for the currently authenticated employee
OracleSdk.MyApi	getMyPermissions	GET /my/permissions	Get all permissions resource objects for the currently authenticated employee
OracleSdk.MyApi	getMyPermissionsById	GET /my/permissions/{id}	Get permissions resource object for the currently authenticated employee
OracleSdk.MyApi	getMyRoles	GET /my/roles	Get all roles for the currently authenticated employee
OracleSdk.MyApi	getMyTimeEntries	GET /my/time-entries	Get all time entries for the currently authenticated employee
OracleSdk.MyApi	getMyTimeEntriesById	GET /my/time-entries/{id}	Get a specific time entry for the currently authenticated employee
OracleSdk.MyApi	getProfile	GET /my/profile	Gets the currently authenticated employee
OracleSdk.MyApi	getProfileRelationshipsDefaultProjects	GET /my/profile/relationships/default-projects	Gets the currently authenticated employee's default projects
OracleSdk.MyApi	updateMyTimeEntries	PATCH /my/time-entries	Updates multiple time entries resources for the currently authenticated employee
OracleSdk.MyApi	updateMyTimeEntriesById	PATCH /my/time-entries/{id}	Update a specific time entries resource for the currently authenticated employee
OracleSdk.MyApi	updateProfile	PATCH /my/profile	Update the currently authenticated employee profile
OracleSdk.MyApi	updateProfileRelationshipsDefaultProjects	PATCH /my/profile/relationships/default-projects	Updates the currently authenticated employee's default projects
OracleSdk.ProjectsApi	createProject	POST /projects	Create a new project
OracleSdk.ProjectsApi	getProjects	GET /projects	Get all `projects`
OracleSdk.ProjectsApi	getProjectsById	GET /projects/{id}	Get a `projects` resource
OracleSdk.ProjectsApi	updateProjectsById	PATCH /projects/{id}	Update a specific project resource
OracleSdk.QueueJobsApi	getQueueJobsByQueueNameById	GET /queue-jobs/{queue}/{id}	Get the state of a queue jobs resource
OracleSdk.QuickbooksApi	quickbooksAuthenticate	GET /quickbooks/authenticate	Returns a Quickbooks auth URL
OracleSdk.QuickbooksApi	quickbooksOauthCallback	GET /quickbooks/oauth-callback	Quickbooks OAuth callback
OracleSdk.ResourcesApi	getResources	GET /resources	Get all resources
OracleSdk.RoleResourcesApi	createRoleResources	POST /role-resources	Create a new `role resources` resource
OracleSdk.RoleResourcesApi	getRoleResources	GET /role-resources	Get all `role resources` resouces
OracleSdk.RoleResourcesApi	getRoleResourcesById	GET /role-resources/{id}	Get a `role resources` resouce by Id
OracleSdk.RoleResourcesApi	updateRoleResourcesById	PATCH /role-resources/{id}	Update a `role resources` resource by it's ID
OracleSdk.RolesApi	createRoles	POST /roles	Create a new role
OracleSdk.RolesApi	createRolesByIdRelationshipsEmployees	POST /roles/{id}/relationships/employees	Create `employees` relationship from a `roles` resource by Id
OracleSdk.RolesApi	deleteRolesByIdRelationshipsEmployees	DELETE /roles/{id}/relationships/employees	Delete `employees` relationship from a `roles` resource by Id
OracleSdk.RolesApi	getMyPermissions	GET /my/permissions	Get all permissions resource objects for the currently authenticated employee
OracleSdk.RolesApi	getMyPermissionsById	GET /my/permissions/{id}	Get permissions resource object for the currently authenticated employee
OracleSdk.RolesApi	getMyRoles	GET /my/roles	Get all roles for the currently authenticated employee
OracleSdk.RolesApi	getRoles	GET /roles	Get all roles
OracleSdk.RolesApi	getRolesById	GET /roles/{id}	Get a `roles` resource object by Id
OracleSdk.RolesApi	getRolesByIdEmployees	GET /roles/{id}/employees	Get `employees` that belong to a `roles` resource by Id
OracleSdk.RolesApi	getRolesByIdRelationshipsEmployees	GET /roles/{id}/relationships/employees	Get `employees` relationship from a `roles` resource by Id
OracleSdk.RolesApi	updateRolesById	PATCH /roles/{id}	Update a `roles` resource object by it's Id
OracleSdk.RolesApi	updateRolesByIdRelationshipsEmployees	PATCH /roles/{id}/relationships/employees	Update `employees` relationship from a `roles` resource by Id
OracleSdk.SessionsApi	createSession	POST /sessions	Create a new session
OracleSdk.StatesApi	getStates	GET /states	Get all states resources
OracleSdk.StatesApi	getStatesById	GET /states/{id}	Get a specific state resource
OracleSdk.TimeEntriesApi	createMyTimeEntries	POST /my/time-entries	Create a new time entries resource for the currently authenticated employee
OracleSdk.TimeEntriesApi	createTimeEntries	POST /time-entries	Create a new time entries resource
OracleSdk.TimeEntriesApi	deleteMyTimeEntries	DELETE /my/time-entries	Delete one or more time entries resources for the currently authenticated employee
OracleSdk.TimeEntriesApi	deleteMyTimeEntriesById	DELETE /my/time-entries/{id}	Delete a specific time entries resource for the currently authenticated employee
OracleSdk.TimeEntriesApi	deleteTimeEntries	DELETE /time-entries	Delete one or more time entries resources
OracleSdk.TimeEntriesApi	deleteTimeEntriesById	DELETE /time-entries/{id}	Delete a specific time entries resource
OracleSdk.TimeEntriesApi	getMyTimeEntries	GET /my/time-entries	Get all time entries for the currently authenticated employee
OracleSdk.TimeEntriesApi	getMyTimeEntriesById	GET /my/time-entries/{id}	Get a specific time entry for the currently authenticated employee
OracleSdk.TimeEntriesApi	getTimeEntries	GET /time-entries	Get all time entries
OracleSdk.TimeEntriesApi	getTimeEntriesById	GET /time-entries/{id}	Get a specific time entries resource
OracleSdk.TimeEntriesApi	updateMyTimeEntries	PATCH /my/time-entries	Updates multiple time entries resources for the currently authenticated employee
OracleSdk.TimeEntriesApi	updateMyTimeEntriesById	PATCH /my/time-entries/{id}	Update a specific time entries resource for the currently authenticated employee
OracleSdk.TimeEntriesApi	updateTimeEntries	PATCH /time-entries	Updates multiple time entries resources
OracleSdk.TimeEntriesApi	updateTimeEntriesById	PATCH /time-entries/{id}	Update a specific time entries resource
OracleSdk.TimeEntriesTotalsApi	timeEntriesTotalsTypeGet	GET /time-entries-totals/{type}	Get all time entries totals
OracleSdk.TimeEntriesTotalsApi	timeEntriesTotalsTypeIdGet	GET /time-entries-totals/{type}/{id}	Get time entries totals
OracleSdk.TimeEntriesTotalsApi	timeEntriesTotalsTypeIdPatch	PATCH /time-entries-totals/{type}/{id}	Update time entries totals resource