@platon-net/cp-typescript-sdk
v1.0.0
Published
OpenAPI client for @platon-net/cp-typescript-sdk
Readme
@platon-net/[email protected]
This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run buildPublishing
First build the package then run npm publish
Consuming
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install @platon-net/[email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveDocumentation for API Endpoints
All URIs are relative to https://setup.platon.sk/api
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- DNSApi | createDnsRecord | POST /dns/{domain}/records | Create DNS record DNSApi | deleteDnsRecord | DELETE /dns/{domain}/records/{recordId} | Delete DNS record DNSApi | getDnsRecords | GET /dns/{domain}/records | Get DNS records by domain DNSApi | updateDnsRecord | PATCH /dns/{domain}/records/{recordId} | Update DNS record DomainApi | changeDomainNameservers | PATCH /domains/{domain}/nameservers | Change domain nameservers DomainApi | closeDomain | DELETE /domains/{domain} | Close external customer domain product DomainApi | getDomainInfo | GET /domains/{domain} | Get domain information and availability DomainApi | listDomains | GET /domains | List customer domains DomainApi | registerDomain | POST /domains/{domain}/register | Register domain DomainApi | renewDomain | POST /domains/{domain}/renew | Renew domain EmailApi | changeMailboxPassword | PATCH /email/{domain}/mailboxes/{username}/password | Change mailbox password EmailApi | createMailbox | POST /email/{domain}/mailboxes | Create mailbox OAuthApi | createOauthRequest | POST /oauth/requests | Create OAuth request OAuthApi | deleteOauthToken | DELETE /oauth/tokens | Delete OAuth token OAuthApi | getOauthScopes | GET /oauth/scopes | List available OAuth scopes OAuthApi | refreshOauthToken | POST /oauth/tokens/refresh | Refresh OAuth token OAuthApi | verifyOauthRequest | GET /oauth/requests/verify | Verify OAuth request SystemApi | hello | GET /system/hello | Returns greeting message SystemApi | revision | GET /system/revision | Returns revision number of system SystemApi | time | GET /system/time | Returns current date and time of system VehicleApi | createVehicleEvent | POST /vehicle/events | Create vehicle event without receipt image VehicleApi | deleteVehicleEvent | DELETE /vehicle/events/{eventId} | Delete vehicle event VehicleApi | finalizeVehicleEvent | POST /vehicle/events/{eventId}/finalize | Finalize vehicle event draft VehicleApi | getVehicleEvent | GET /vehicle/events/{eventId} | Get vehicle event detail VehicleApi | getVehicleEventImage | GET /vehicle/events/{eventId}/image | Get event image or thumbnail VehicleApi | listVehicleCurrencies | GET /vehicle/currencies | List currencies for vehicle events VehicleApi | listVehicleEvents | GET /vehicle/events | List vehicle events for the authenticated driver VehicleApi | listVehicleVehicles | GET /vehicle/vehicles | List vehicles available to the authenticated driver VehicleApi | rescanVehicleEventImage | POST /vehicle/events/{eventId}/image | Replace event image and rescan event data VehicleApi | setPreferredVehicle | PATCH /vehicle/preferred-vehicle | Set or clear preferred vehicle VehicleApi | uploadVehicleReceiptImage | POST /vehicle/events/receipt-image | Upload receipt image and create processing event draft
Documentation For Models
- ChangeDomainNameserversRequest
- ChangeMailboxPasswordRequest
- CreateDnsRecord200Response
- CreateDnsRecordRequest
- CreateMailboxRequest
- CreateOauthRequest200Response
- CreateOauthRequest200ResponseData
- CreateOauthRequestRequest
- CreateVehicleEventRequest
- DeleteOauthToken200Response
- DeleteOauthToken200ResponseData
- FinalizeVehicleEventRequest
- FinalizeVehicleEventRequestFueling
- FinalizeVehicleEventRequestLocation
- FinalizeVehicleEventRequestMoney
- GetDnsRecords200Response
- GetDnsRecords200ResponseData
- GetDnsRecords200ResponseDataRecordsInner
- GetOauthScopes200Response
- GetOauthScopes200ResponseDataInner
- Hello200Response
- Hello200ResponseData
- ListDomains200Response
- ListDomains200ResponseData
- RefreshOauthTokenRequest
- RegisterDomainRequest
- RenewDomainRequest
- Revision200Response
- Revision200ResponseData
- SetPreferredVehicleRequest
- Time200Response
- Time200ResponseData
- UpdateDnsRecordRequest
- VerifyOauthRequest200Response
- VerifyOauthRequest200ResponseData
Documentation For Authorization
Authentication schemes defined for the API:
bearerAuth
- Type: Bearer authentication
