v0.1.0

Author: kaisa-kassila

.gitignore

@@ -0,0 +1,107 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+nodemon.json
+test.js

README.md

@@ -1 +1,59 @@
-# ytj-api-client
+# ytj-api-client
+
+**YtjApiClient** is a third party api client for NodeJS. It is a wrapper around a SOAP client that has been [automatically generated](https://github.com/dderevjanik/wsdl-tsclient) using the [WSDL schema](https://api.tietopalvelu.ytj.fi/yritystiedot.asmx?WSDL) provided by YTJ.
+
+## Installation
+
+Add to project's package.json:
+
+```
+npm install @rantalainen/ytj-api-client
+```
+
+### Import
+
+```javascript
+import { YtjApiClient } from '@rantalainen/ytj-api-client';
+```
+
+## Authentication / Setup client
+
+In order to obtain a user id and api key, please contact YTJ API support. User id and apikey is needed to access all API functions.
+
+```javascript
+const ytjApiClient = new YtjApiClient({
+  userId: 'your-user',
+  apiKey: 'your-apikey'
+});
+```
+
+SOAP client handles authentication based on YtjApiClient userId and apiKey.
+
+```javascript
+// Set up SOAP client for calling functions
+const client = await ytjApiClient.createSoapClient();
+```
+
+Example usage after initialization:
+
+```javascript
+const [companyForms] = await client.wmYritysMuodotAsync();
+console.log(companyForms);
+```
+
+:warning: NOTE: All parameters for methods are mandatory. For example wmYritysHakuAsync requires a complete WmYritysHaku object:
+
+```javascript
+const organizationId = 'my_organizationid';
+
+const [company] = await client.wmYritysHakuAsync({
+  ytunnus: organizationId,
+  yritysmuoto: '',
+  sanahaku: 'false',
+  voimassaolevat: 'true',
+  hakusana: ''
+});
+console.log(company);
+```
+
+Available methods can be found in the [API documentation](https://api.tietopalvelu.ytj.fi/yritystiedot.asmx).