wdia-client-alpha v1.0.7

Client

Client class for WDIA. Token is optional but required for methods with auth.

Kind: global class

• Client
  • new Client([url], [protocol], [host], [port], [token])
  • .commonResources() ⇒ Promise
  • .fieldsList([limit], [offset], [order]) ⇒ Promise
  • .fieldsTemplatesList([limit], [offset], [order]) ⇒ Promise
  • .companiesList([limit], [offset], [order], [updatedAt], [name], [type], [state]) ⇒ Promise
  • .companyServicesList(companyId, [limit], [offset], [order], [state]) ⇒ Promise
  • .servicesList([limit], [offset], [order], [updatedAt], [name], [type], [state]) ⇒ Promise
  • .verfiersList([limit], [offset], [order], [updatedAt], [name], [state]) ⇒ Promise
  • .serviceListVerifiers(hash, [limit], [offset], [order], [updatedAt], [name], [state]) ⇒ Promise
  • .verifierListServices(hash, [limit], [offset], [order], [updatedAt], [name], [type], [state]) ⇒ Promise
  • .getServicePubKeys(hash) ⇒ Promise
  • .getVerfierPubKeys(hash) ⇒ Promise
  • .getProviderPubKeys(hash) ⇒ Promise
  • .checkServiceKey([scriptHash]) ⇒ Promise
  • .checkVerifierKey([scriptHash]) ⇒ Promise
  • .checkProviderKey([scriptHash]) ⇒ Promise
  • .getServiceFields(hash) ⇒ Promise
  • .getVerifierFields(hash) ⇒ Promise
  • .getService(hash, [logo], [fields]) ⇒ Promise
  • .getVerifier(hash, [logo], [fields]) ⇒ Promise
  • .addService(type, name, [description], url, fields) ⇒ Promise
  • .addVerifier(name, [description], url, fields) ⇒ Promise
  • .updateCompany([name], [description], [url], [details], [logo]) ⇒ Promise
  • .getUserRoles([limit], [offset]) ⇒ Promise
  • .addCompanyUser(email, firstname, lastname, role) ⇒ Promise
  • .getCompanyUsers() ⇒ Promise
  • .updateService(hash, [type], [name], [description], [url], [fields]) ⇒ Promise
  • .updateVerifier(hash, [name], [description], [url], [fields]) ⇒ Promise
  • .addServicePubKeys(hash, keys) ⇒ Promise
  • .addVerifierPubKeys(hash, keys) ⇒ Promise
  • .disableServicePubKeys(keys) ⇒ Promise
  • .disableVerifierPubKeys(keys) ⇒ Promise

new Client(url, protocol, host, port, token)

client.commonResources() ⇒ Promise

get common resources (states, types, sources)

Kind: instance method of Client
Returns: Promise - Promise with {states, types, sources}

client.fieldsList(limit, offset, order) ⇒ Promise

get fields list

Kind: instance method of Client
Returns: Promise - Promise with array of fields

client.fieldsTemplatesList(limit, offset, order) ⇒ Promise

get fieldsTemplates list

Kind: instance method of Client
Returns: Promise - Promise with array of fieldsTemplates

client.companiesList(limit, offset, order, updatedAt, name, type, state) ⇒ Promise

get companies list

Kind: instance method of Client
Returns: Promise - Promise with array of companies and count

client.companyServicesList(companyId, limit, offset, order, state) ⇒ Promise

get company services or verifiers

Kind: instance method of Client
Returns: Promise - Promise with array of services and count

client.servicesList(limit, offset, order, updatedAt, name, type, state) ⇒ Promise

get services list

Kind: instance method of Client
Returns: Promise - Promise with array of services and count

client.verfiersList(limit, offset, order, updatedAt, name, state) ⇒ Promise

get verifiers list

Kind: instance method of Client
Returns: Promise - Promise with array of verifiers and count

client.serviceListVerifiers(hash, limit, offset, order, updatedAt, name, state) ⇒ Promise

get verifiers list for service

Kind: instance method of Client
Returns: Promise - Promise with array of verifiers and count

client.verifierListServices(hash, limit, offset, order, updatedAt, name, type, state) ⇒ Promise

get services list for verifier

Kind: instance method of Client
Returns: Promise - Promise with array of services and count

client.getServicePubKeys(hash) ⇒ Promise

get service`s keys (salts)

Kind: instance method of Client
Returns: Promise - Promise array of keys

client.getVerfierPubKeys(hash) ⇒ Promise

get verifier`s keys (salts)

Kind: instance method of Client
Returns: Promise - Promise array of keys

client.getProviderPubKeys(hash) ⇒ Promise

get verifier or service keys (salts)

Kind: instance method of Client
Returns: Promise - Promise array of keys

client.checkServiceKey(scriptHash) ⇒ Promise

check service key (salt)

Kind: instance method of Client
Returns: Promise - Promise object with service object and key state

client.checkVerifierKey(scriptHash) ⇒ Promise

check verifier key (salt)

Kind: instance method of Client
Returns: Promise - Promise object with verifier object and key state

client.checkProviderKey(scriptHash) ⇒ Promise

check service or verifier key (salt)

Kind: instance method of Client
Returns: Promise - Promise object with service or verifier object and key state

client.getServiceFields(hash) ⇒ Promise

get service`s fields

Kind: instance method of Client
Returns: Promise - Promise with array of fields

client.getVerifierFields(hash) ⇒ Promise

get verifier`s fields

Kind: instance method of Client
Returns: Promise - Promise with array of fields

client.getService(hash, logo, fields) ⇒ Promise

get service

Kind: instance method of Client
Returns: Promise - Promise with service

client.getVerifier(hash, logo, fields) ⇒ Promise

get verifier

Kind: instance method of Client
Returns: Promise - Promise with verifier

client.addService(type, name, description, url, fields) ⇒ Promise

add service

Kind: instance method of Client
Returns: Promise - Promise with service

client.addVerifier(name, description, url, fields) ⇒ Promise

add verifier

Kind: instance method of Client
Returns: Promise - Promise with verifier

client.updateCompany(name, description, url, details, logo) ⇒ Promise

update company

Kind: instance method of Client
Returns: Promise - Promise with service

client.getUserRoles(limit, offset) ⇒ Promise

get user roles

Kind: instance method of Client
Returns: Promise - Promise with roles

client.addCompanyUser(email, firstname, lastname, role) ⇒ Promise

add company user

Kind: instance method of Client
Returns: Promise - Promise with service

client.getCompanyUsers() ⇒ Promise

get company users

Kind: instance method of Client
Returns: Promise - Promise with service

client.updateService(hash, type, name, description, url, fields) ⇒ Promise

update service

Kind: instance method of Client
Returns: Promise - Promise with service

client.updateVerifier(hash, name, description, url, fields) ⇒ Promise

update verifier

Kind: instance method of Client
Returns: Promise - Promise with verifier

client.addServicePubKeys(hash, keys) ⇒ Promise

add service keys (salts)

Kind: instance method of Client
Returns: Promise - Promise with keys and status

client.addVerifierPubKeys(hash, keys) ⇒ Promise

add verifier keys (salts)

Kind: instance method of Client
Returns: Promise - Promise with keys and status

client.disableServicePubKeys(keys) ⇒ Promise

disable service keys (salts)

Kind: instance method of Client
Returns: Promise - Promise with result

client.disableVerifierPubKeys(keys) ⇒ Promise

disable verifier keys (salts)

Kind: instance method of Client
Returns: Promise - Promise with result