pakkasmarja-rest-client

PakkasmarjaRestClient - JavaScript client for pakkasmarja-rest-client REST API for Pakkasmarja This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.0.3
• Package version: 0.0.14
• Build package: io.swagger.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 pakkasmarja-rest-client --save

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

Finally, switch to the directory you want to use your pakkasmarja-rest-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('pakkasmarja-rest-client') in javascript files from the directory you ran the last command above from.

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, that's to say your javascript file where you actually use this library):

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 PakkasmarjaRestClient = require('pakkasmarja-rest-client');

var defaultClient = PakkasmarjaRestClient.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new PakkasmarjaRestClient.ChatThreadsApi()

var threadId = 789; // {Number} chat thread id

var type = "type_example"; // {String} report type. Accepted values summaryReport

var opts = { 
  'accept': "accept_example" // {String} Expected response format. Accepted values application/vnd.openxmlformats for Excel response
};
api.getChatThreadReport(threadId, type, opts).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://localhost/rest/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- PakkasmarjaRestClient.ChatThreadsApi | getChatThreadReport | GET /chatThreads/{threadId}/reports/{type} | Returns chat thread report PakkasmarjaRestClient.ChatThreadsApi | listChatThreads | GET /chatThreads | Returns list of chat threads PakkasmarjaRestClient.ContactsApi | findContact | GET /contacts/{id} | Find contact PakkasmarjaRestClient.ContactsApi | listContacts | GET /contacts | Lists contacts PakkasmarjaRestClient.ContactsApi | updateContact | PUT /contacts/{id} | Update contact PakkasmarjaRestClient.ContactsApi | updateContactCredentials | PUT /contacts/{id}/credentials | Update contact credentials PakkasmarjaRestClient.ContractsApi | createContract | POST /contracts | Create contract PakkasmarjaRestClient.ContractsApi | createContractDocumentSignRequest | POST /contracts/{id}/documents/{type}/signRequests | Requests contract document electronic signing PakkasmarjaRestClient.ContractsApi | createContractDocumentTemplate | POST /contracts/{contractId}/documentTemplates | Create contract document template PakkasmarjaRestClient.ContractsApi | findContract | GET /contracts/{id} | Find contract PakkasmarjaRestClient.ContractsApi | findContractDocumentTemplate | GET /contracts/{contractId}/documentTemplates/{contractDocumentTemplateId} | Find contract document template PakkasmarjaRestClient.ContractsApi | getContractDocument | GET /contracts/{id}/documents/{type} | Returns contract document PakkasmarjaRestClient.ContractsApi | listContractDocumentTemplates | GET /contracts/{contractId}/documentTemplates | List contract document templates PakkasmarjaRestClient.ContractsApi | listContractPrices | GET /contracts/{contractId}/prices | List contract prices PakkasmarjaRestClient.ContractsApi | listContracts | GET /contracts | Lists contracts PakkasmarjaRestClient.ContractsApi | updateContract | PUT /contracts/{id} | Update contract PakkasmarjaRestClient.ContractsApi | updateContractDocumentTemplate | PUT /contracts/{contractId}/documentTemplates/{contractDocumentTemplateId} | Updates contract document template PakkasmarjaRestClient.DeliveryPlacesApi | findDeliveryPlace | GET /deliveryPlaces/{id} | Find delivery place PakkasmarjaRestClient.DeliveryPlacesApi | listDeliveryPlaces | GET /deliveryPlaces | Lists delivery places PakkasmarjaRestClient.ItemGroupsApi | createItemGroupPrice | POST /itemGroups/{itemGroupId}/prices | Creates item group price PakkasmarjaRestClient.ItemGroupsApi | deleteItemGroupPrice | DELETE /itemGroups/{itemGroupId}/prices/{priceId} | Delete item group price PakkasmarjaRestClient.ItemGroupsApi | findItemGroup | GET /itemGroups/{id} | Find item group PakkasmarjaRestClient.ItemGroupsApi | findItemGroupDocumentTemplate | GET /itemGroups/{itemGroupId}/documentTemplates/{id} | Find item group document template PakkasmarjaRestClient.ItemGroupsApi | findItemGroupPrice | GET /itemGroups/{itemGroupId}/prices/{priceId} | Find item group price PakkasmarjaRestClient.ItemGroupsApi | listItemGroupDocumentTemplates | GET /itemGroups/{itemGroupId}/documentTemplates | List item group document templates PakkasmarjaRestClient.ItemGroupsApi | listItemGroupPrices | GET /itemGroups/{itemGroupId}/prices | List item group prices PakkasmarjaRestClient.ItemGroupsApi | listItemGroups | GET /itemGroups | Lists item groups PakkasmarjaRestClient.ItemGroupsApi | updateItemGroupDocumentTemplate | PUT /itemGroups/{itemGroupId}/documentTemplates/{id} | Updates item group document template PakkasmarjaRestClient.ItemGroupsApi | updateItemGroupPrice | PUT /itemGroups/{itemGroupId}/prices/{priceId} | Update item group price PakkasmarjaRestClient.OperationReportsApi | findOperationReport | GET /operationReports/{id} | Find operation report PakkasmarjaRestClient.OperationReportsApi | listOperationReportItems | GET /operationReports/{id}/items | List operation report items PakkasmarjaRestClient.OperationReportsApi | listOperationReports | GET /operationReports | List operation reports PakkasmarjaRestClient.OperationsApi | createOperation | POST /operations | Creates new operation PakkasmarjaRestClient.SignAuthenticationServicesApi | listSignAuthenticationServices | GET /signAuthenticationServices | List sign authentication services

Documentation for Models

• PakkasmarjaRestClient.Address
• PakkasmarjaRestClient.AreaDetail
• PakkasmarjaRestClient.BadRequest
• PakkasmarjaRestClient.ChatThread
• PakkasmarjaRestClient.Contact
• PakkasmarjaRestClient.Contract
• PakkasmarjaRestClient.ContractDocumentSignRequest
• PakkasmarjaRestClient.ContractDocumentTemplate
• PakkasmarjaRestClient.Credentials
• PakkasmarjaRestClient.DeliveryPlace
• PakkasmarjaRestClient.Forbidden
• PakkasmarjaRestClient.InternalServerError
• PakkasmarjaRestClient.ItemGroup
• PakkasmarjaRestClient.ItemGroupDocumentTemplate
• PakkasmarjaRestClient.NotFound
• PakkasmarjaRestClient.NotImplemented
• PakkasmarjaRestClient.Operation
• PakkasmarjaRestClient.OperationReport
• PakkasmarjaRestClient.OperationReportItem
• PakkasmarjaRestClient.Price
• PakkasmarjaRestClient.SignAuthenticationService

Documentation for Authorization

bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header