@pahlevani/pfm-js-client NPM

swagger-js-client

SwaggerJsClient - JavaScript client for swagger-js-client This SDK is automatically generated by the Swagger Codegen project:

API version:
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.javascript.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 swagger-js-client --save

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 SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AccountEntityControllerApi()
var id = "id_example"; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteItemResourceAccountDelete(id, callback);

Documentation for API Endpoints

All URIs are relative to /pfm

Class	Method	HTTP request
SwaggerJsClient.AccountEntityControllerApi	deleteItemResourceAccountDelete	DELETE /accounts/{id}
SwaggerJsClient.AccountEntityControllerApi	getCollectionResourceAccountGet1	GET /accounts
SwaggerJsClient.AccountEntityControllerApi	getItemResourceAccountGet	GET /accounts/{id}
SwaggerJsClient.AccountEntityControllerApi	patchItemResourceAccountPatch	PATCH /accounts/{id}
SwaggerJsClient.AccountEntityControllerApi	postCollectionResourceAccountPost	POST /accounts
SwaggerJsClient.AccountEntityControllerApi	putItemResourceAccountPut	PUT /accounts/{id}
SwaggerJsClient.AccountPropertyReferenceControllerApi	createPropertyReferenceAccountPatch	PATCH /accounts/{id}/bank
SwaggerJsClient.AccountPropertyReferenceControllerApi	createPropertyReferenceAccountPut	PUT /accounts/{id}/bank
SwaggerJsClient.AccountPropertyReferenceControllerApi	deletePropertyReferenceAccountDelete	DELETE /accounts/{id}/bank
SwaggerJsClient.AccountPropertyReferenceControllerApi	deletePropertyReferenceIdAccountDelete	DELETE /accounts/{id}/bank/{propertyId}
SwaggerJsClient.AccountPropertyReferenceControllerApi	followPropertyReferenceAccountGet	GET /accounts/{id}/bank/{propertyId}
SwaggerJsClient.AccountPropertyReferenceControllerApi	followPropertyReferenceAccountGet1	GET /accounts/{id}/bank
SwaggerJsClient.AccountSearchControllerApi	executeSearchAccountGet	GET /accounts/search/findAll
SwaggerJsClient.AccountSearchControllerApi	executeSearchAccountGet1	GET /accounts/search/findById
SwaggerJsClient.AllocationEntityControllerApi	deleteItemResourceAllocationDelete	DELETE /allocations/{id}
SwaggerJsClient.AllocationEntityControllerApi	getCollectionResourceAllocationGet1	GET /allocations
SwaggerJsClient.AllocationEntityControllerApi	getItemResourceAllocationGet	GET /allocations/{id}
SwaggerJsClient.AllocationEntityControllerApi	patchItemResourceAllocationPatch	PATCH /allocations/{id}
SwaggerJsClient.AllocationEntityControllerApi	postCollectionResourceAllocationPost	POST /allocations
SwaggerJsClient.AllocationEntityControllerApi	putItemResourceAllocationPut	PUT /allocations/{id}
SwaggerJsClient.AllocationPropertyReferenceControllerApi	createPropertyReferenceAllocationPatch	PATCH /allocations/{id}/category
SwaggerJsClient.AllocationPropertyReferenceControllerApi	createPropertyReferenceAllocationPatch1	PATCH /allocations/{id}/transaction
SwaggerJsClient.AllocationPropertyReferenceControllerApi	createPropertyReferenceAllocationPut	PUT /allocations/{id}/category
SwaggerJsClient.AllocationPropertyReferenceControllerApi	createPropertyReferenceAllocationPut1	PUT /allocations/{id}/transaction
SwaggerJsClient.AllocationPropertyReferenceControllerApi	deletePropertyReferenceAllocationDelete	DELETE /allocations/{id}/category
SwaggerJsClient.AllocationPropertyReferenceControllerApi	deletePropertyReferenceAllocationDelete1	DELETE /allocations/{id}/transaction
SwaggerJsClient.AllocationPropertyReferenceControllerApi	deletePropertyReferenceIdAllocationDelete	DELETE /allocations/{id}/category/{propertyId}
SwaggerJsClient.AllocationPropertyReferenceControllerApi	deletePropertyReferenceIdAllocationDelete1	DELETE /allocations/{id}/transaction/{propertyId}
SwaggerJsClient.AllocationPropertyReferenceControllerApi	followPropertyReferenceAllocationGet	GET /allocations/{id}/category/{propertyId}
SwaggerJsClient.AllocationPropertyReferenceControllerApi	followPropertyReferenceAllocationGet1	GET /allocations/{id}/category
SwaggerJsClient.AllocationPropertyReferenceControllerApi	followPropertyReferenceAllocationGet2	GET /allocations/{id}/transaction/{propertyId}
SwaggerJsClient.AllocationPropertyReferenceControllerApi	followPropertyReferenceAllocationGet21	GET /allocations/{id}/transaction
SwaggerJsClient.AllocationSearchControllerApi	executeSearchAllocationGet	GET /allocations/search/findAll
SwaggerJsClient.AllocationSearchControllerApi	executeSearchAllocationGet1	GET /allocations/search/findById
SwaggerJsClient.BankEntityControllerApi	deleteItemResourceBankDelete	DELETE /banks/{id}
SwaggerJsClient.BankEntityControllerApi	getCollectionResourceBankGet1	GET /banks
SwaggerJsClient.BankEntityControllerApi	getItemResourceBankGet	GET /banks/{id}
SwaggerJsClient.BankEntityControllerApi	patchItemResourceBankPatch	PATCH /banks/{id}
SwaggerJsClient.BankEntityControllerApi	postCollectionResourceBankPost	POST /banks
SwaggerJsClient.BankEntityControllerApi	putItemResourceBankPut	PUT /banks/{id}
SwaggerJsClient.BudgetEntityControllerApi	deleteItemResourceBudgetDelete	DELETE /budgets/{id}
SwaggerJsClient.BudgetEntityControllerApi	getCollectionResourceBudgetGet1	GET /budgets
SwaggerJsClient.BudgetEntityControllerApi	getItemResourceBudgetGet	GET /budgets/{id}
SwaggerJsClient.BudgetEntityControllerApi	patchItemResourceBudgetPatch	PATCH /budgets/{id}
SwaggerJsClient.BudgetEntityControllerApi	postCollectionResourceBudgetPost	POST /budgets
SwaggerJsClient.BudgetEntityControllerApi	putItemResourceBudgetPut	PUT /budgets/{id}
SwaggerJsClient.BudgetPropertyReferenceControllerApi	createPropertyReferenceBudgetPatch	PATCH /budgets/{id}/category
SwaggerJsClient.BudgetPropertyReferenceControllerApi	createPropertyReferenceBudgetPut	PUT /budgets/{id}/category
SwaggerJsClient.BudgetPropertyReferenceControllerApi	deletePropertyReferenceBudgetDelete	DELETE /budgets/{id}/category
SwaggerJsClient.BudgetPropertyReferenceControllerApi	deletePropertyReferenceIdBudgetDelete	DELETE /budgets/{id}/category/{propertyId}
SwaggerJsClient.BudgetPropertyReferenceControllerApi	followPropertyReferenceBudgetGet	GET /budgets/{id}/category/{propertyId}
SwaggerJsClient.BudgetPropertyReferenceControllerApi	followPropertyReferenceBudgetGet1	GET /budgets/{id}/category
SwaggerJsClient.BudgetSearchControllerApi	executeSearchBudgetGet	GET /budgets/search/findAll
SwaggerJsClient.BudgetSearchControllerApi	executeSearchBudgetGet1	GET /budgets/search/findById
SwaggerJsClient.CategoryEntityControllerApi	deleteItemResourceCategoryDelete	DELETE /categories/{id}
SwaggerJsClient.CategoryEntityControllerApi	getCollectionResourceCategoryGet1	GET /categories
SwaggerJsClient.CategoryEntityControllerApi	getItemResourceCategoryGet	GET /categories/{id}
SwaggerJsClient.CategoryEntityControllerApi	patchItemResourceCategoryPatch	PATCH /categories/{id}
SwaggerJsClient.CategoryEntityControllerApi	postCollectionResourceCategoryPost	POST /categories
SwaggerJsClient.CategoryEntityControllerApi	putItemResourceCategoryPut	PUT /categories/{id}
SwaggerJsClient.CategoryPropertyReferenceControllerApi	createPropertyReferenceCategoryPatch	PATCH /categories/{id}/parent
SwaggerJsClient.CategoryPropertyReferenceControllerApi	createPropertyReferenceCategoryPut	PUT /categories/{id}/parent
SwaggerJsClient.CategoryPropertyReferenceControllerApi	deletePropertyReferenceCategoryDelete	DELETE /categories/{id}/parent
SwaggerJsClient.CategoryPropertyReferenceControllerApi	deletePropertyReferenceIdCategoryDelete	DELETE /categories/{id}/parent/{propertyId}
SwaggerJsClient.CategoryPropertyReferenceControllerApi	followPropertyReferenceCategoryGet	GET /categories/{id}/parent/{propertyId}
SwaggerJsClient.CategoryPropertyReferenceControllerApi	followPropertyReferenceCategoryGet1	GET /categories/{id}/parent
SwaggerJsClient.CategorySearchControllerApi	executeSearchCategoryGet	GET /categories/search/findAll
SwaggerJsClient.CategorySearchControllerApi	executeSearchCategoryGet1	GET /categories/search/findById
SwaggerJsClient.DueEntityControllerApi	deleteItemResourceDueDelete	DELETE /dues/{id}
SwaggerJsClient.DueEntityControllerApi	getCollectionResourceDueGet1	GET /dues
SwaggerJsClient.DueEntityControllerApi	getItemResourceDueGet	GET /dues/{id}
SwaggerJsClient.DueEntityControllerApi	patchItemResourceDuePatch	PATCH /dues/{id}
SwaggerJsClient.DueEntityControllerApi	postCollectionResourceDuePost	POST /dues
SwaggerJsClient.DueEntityControllerApi	putItemResourceDuePut	PUT /dues/{id}
SwaggerJsClient.DueSearchControllerApi	executeSearchDueGet	GET /dues/search/findAll
SwaggerJsClient.DueSearchControllerApi	executeSearchDueGet1	GET /dues/search/findById
SwaggerJsClient.ProfileControllerApi	descriptor111	GET /profile/accounts
SwaggerJsClient.ProfileControllerApi	descriptor112	GET /profile/allocations
SwaggerJsClient.ProfileControllerApi	descriptor113	GET /profile/banks
SwaggerJsClient.ProfileControllerApi	descriptor114	GET /profile/budgets
SwaggerJsClient.ProfileControllerApi	descriptor115	GET /profile/categories
SwaggerJsClient.ProfileControllerApi	descriptor116	GET /profile/dues
SwaggerJsClient.ProfileControllerApi	descriptor117	GET /profile/reminders
SwaggerJsClient.ProfileControllerApi	descriptor118	GET /profile/tags
SwaggerJsClient.ProfileControllerApi	descriptor119	GET /profile/transactions
SwaggerJsClient.ProfileControllerApi	listAllFormsOfMetadata1	GET /profile
SwaggerJsClient.ReminderEntityControllerApi	deleteItemResourceReminderDelete	DELETE /reminders/{id}
SwaggerJsClient.ReminderEntityControllerApi	getCollectionResourceReminderGet1	GET /reminders
SwaggerJsClient.ReminderEntityControllerApi	getItemResourceReminderGet	GET /reminders/{id}
SwaggerJsClient.ReminderEntityControllerApi	patchItemResourceReminderPatch	PATCH /reminders/{id}
SwaggerJsClient.ReminderEntityControllerApi	postCollectionResourceReminderPost	POST /reminders
SwaggerJsClient.ReminderEntityControllerApi	putItemResourceReminderPut	PUT /reminders/{id}
SwaggerJsClient.ReminderPropertyReferenceControllerApi	createPropertyReferenceReminderPatch	PATCH /reminders/{id}/dues
SwaggerJsClient.ReminderPropertyReferenceControllerApi	createPropertyReferenceReminderPut	PUT /reminders/{id}/dues
SwaggerJsClient.ReminderPropertyReferenceControllerApi	deletePropertyReferenceIdReminderDelete	DELETE /reminders/{id}/dues/{propertyId}
SwaggerJsClient.ReminderPropertyReferenceControllerApi	deletePropertyReferenceReminderDelete	DELETE /reminders/{id}/dues
SwaggerJsClient.ReminderPropertyReferenceControllerApi	followPropertyReferenceReminderGet	GET /reminders/{id}/dues/{propertyId}
SwaggerJsClient.ReminderPropertyReferenceControllerApi	followPropertyReferenceReminderGet1	GET /reminders/{id}/dues
SwaggerJsClient.ReminderSearchControllerApi	executeSearchReminderGet	GET /reminders/search/findAll
SwaggerJsClient.ReminderSearchControllerApi	executeSearchReminderGet1	GET /reminders/search/findById
SwaggerJsClient.TagEntityControllerApi	deleteItemResourceTagDelete	DELETE /tags/{id}
SwaggerJsClient.TagEntityControllerApi	getCollectionResourceTagGet1	GET /tags
SwaggerJsClient.TagEntityControllerApi	getItemResourceTagGet	GET /tags/{id}
SwaggerJsClient.TagEntityControllerApi	patchItemResourceTagPatch	PATCH /tags/{id}
SwaggerJsClient.TagEntityControllerApi	postCollectionResourceTagPost	POST /tags
SwaggerJsClient.TagEntityControllerApi	putItemResourceTagPut	PUT /tags/{id}
SwaggerJsClient.TagSearchControllerApi	executeSearchTagGet	GET /tags/search/findAll
SwaggerJsClient.TagSearchControllerApi	executeSearchTagGet1	GET /tags/search/findById
SwaggerJsClient.TransactionEntityControllerApi	deleteItemResourceTransactionDelete	DELETE /transactions/{id}
SwaggerJsClient.TransactionEntityControllerApi	getCollectionResourceTransactionGet1	GET /transactions
SwaggerJsClient.TransactionEntityControllerApi	getItemResourceTransactionGet	GET /transactions/{id}
SwaggerJsClient.TransactionEntityControllerApi	patchItemResourceTransactionPatch	PATCH /transactions/{id}
SwaggerJsClient.TransactionEntityControllerApi	postCollectionResourceTransactionPost	POST /transactions
SwaggerJsClient.TransactionEntityControllerApi	putItemResourceTransactionPut	PUT /transactions/{id}
SwaggerJsClient.TransactionPropertyReferenceControllerApi	createPropertyReferenceTransactionPatch	PATCH /transactions/{id}/account
SwaggerJsClient.TransactionPropertyReferenceControllerApi	createPropertyReferenceTransactionPatch1	PATCH /transactions/{id}/allocations
SwaggerJsClient.TransactionPropertyReferenceControllerApi	createPropertyReferenceTransactionPatch2	PATCH /transactions/{id}/tags
SwaggerJsClient.TransactionPropertyReferenceControllerApi	createPropertyReferenceTransactionPut	PUT /transactions/{id}/account
SwaggerJsClient.TransactionPropertyReferenceControllerApi	createPropertyReferenceTransactionPut1	PUT /transactions/{id}/allocations
SwaggerJsClient.TransactionPropertyReferenceControllerApi	createPropertyReferenceTransactionPut2	PUT /transactions/{id}/tags
SwaggerJsClient.TransactionPropertyReferenceControllerApi	deletePropertyReferenceIdTransactionDelete	DELETE /transactions/{id}/account/{propertyId}
SwaggerJsClient.TransactionPropertyReferenceControllerApi	deletePropertyReferenceIdTransactionDelete1	DELETE /transactions/{id}/allocations/{propertyId}
SwaggerJsClient.TransactionPropertyReferenceControllerApi	deletePropertyReferenceIdTransactionDelete2	DELETE /transactions/{id}/tags/{propertyId}
SwaggerJsClient.TransactionPropertyReferenceControllerApi	deletePropertyReferenceTransactionDelete	DELETE /transactions/{id}/account
SwaggerJsClient.TransactionPropertyReferenceControllerApi	deletePropertyReferenceTransactionDelete1	DELETE /transactions/{id}/allocations
SwaggerJsClient.TransactionPropertyReferenceControllerApi	deletePropertyReferenceTransactionDelete2	DELETE /transactions/{id}/tags
SwaggerJsClient.TransactionPropertyReferenceControllerApi	followPropertyReferenceTransactionGet	GET /transactions/{id}/account/{propertyId}
SwaggerJsClient.TransactionPropertyReferenceControllerApi	followPropertyReferenceTransactionGet1	GET /transactions/{id}/account
SwaggerJsClient.TransactionPropertyReferenceControllerApi	followPropertyReferenceTransactionGet2	GET /transactions/{id}/allocations/{propertyId}
SwaggerJsClient.TransactionPropertyReferenceControllerApi	followPropertyReferenceTransactionGet21	GET /transactions/{id}/allocations
SwaggerJsClient.TransactionPropertyReferenceControllerApi	followPropertyReferenceTransactionGet3	GET /transactions/{id}/tags/{propertyId}
SwaggerJsClient.TransactionPropertyReferenceControllerApi	followPropertyReferenceTransactionGet31	GET /transactions/{id}/tags
SwaggerJsClient.TransactionSearchControllerApi	executeSearchTransactionGet	GET /transactions/search/findAll
SwaggerJsClient.TransactionSearchControllerApi	executeSearchTransactionGet1	GET /transactions/search/findById

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

@babel/cli superagent

@infinitebrahmanuniverse/nolb-_pah @everything-registry/sub-chunk-701 @zalastax/nolb-_pah

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago