UNPKG

digital-humani-js-sdk

Version:

[![Continuous Integrations](https://github.com/impe93/digital-humani-js-sdk/actions/workflows/continuous-integrations.yaml/badge.svg?branch=main)](https://github.com/impe93/digital-humani-js-sdk/actions/workflows/continuous-integrations.yaml) [![License](

github.com/impe93/digital-humani-js-sdk

impe93/digital-humani-js-sdk

75 lines (40 loc) • 2.72 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
[DigitalHumani JS SDK](../README.md) / [repositories/EnterpriseRepository/enterprise.interface](../modules/repositories_EnterpriseRepository_enterprise_interface.md) / IEnterpriseRepository # Interface: IEnterpriseRepository [repositories/EnterpriseRepository/enterprise.interface](../modules/repositories_EnterpriseRepository_enterprise_interface.md).IEnterpriseRepository ## Implemented by - [`EnterpriseRepository`](../classes/repositories_EnterpriseRepository_enterprise_repository.EnterpriseRepository.md) ## Table of contents ### Properties - [getEnterprise](repositories_EnterpriseRepository_enterprise_interface.IEnterpriseRepository.md#getenterprise) - [getTreeCount](repositories_EnterpriseRepository_enterprise_interface.IEnterpriseRepository.md#gettreecount) ## Properties ### getEnterprise • `Readonly` **getEnterprise**: (`enterpriseId`: `string`) => `Promise`<[`Enterprise`](repositories_EnterpriseRepository_enterprise_models.Enterprise.md)\> #### Type declaration ▸ (`enterpriseId`): `Promise`<[`Enterprise`](repositories_EnterpriseRepository_enterprise_models.Enterprise.md)\> This method is used to get an enterprise by its ID ##### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `enterpriseId` | `string` | Enterprise ID, is used to get the right enterprise details | ##### Returns `Promise`<[`Enterprise`](repositories_EnterpriseRepository_enterprise_models.Enterprise.md)\> The associated enterprise #### Defined in [repositories/EnterpriseRepository/enterprise.interface.ts:13](https://github.com/impe93/digital-humani-js-sdk/blob/31e498c/src/repositories/EnterpriseRepository/enterprise.interface.ts#L13) ___ ### getTreeCount • `Readonly` **getTreeCount**: (`params`: [`GetTreeCountRequest`](../modules/repositories_EnterpriseRepository_enterprise_models.md#gettreecountrequest)) => `Promise`<[`Count`](repositories_EnterpriseRepository_enterprise_models.Count.md)\> #### Type declaration ▸ (`params`): `Promise`<[`Count`](repositories_EnterpriseRepository_enterprise_models.Count.md)\> **`Throws`** Throw an error when the explained parameters logic is not satisfied. ##### Parameters | Name | Type | | :------ | :------ | | `params` | [`GetTreeCountRequest`](../modules/repositories_EnterpriseRepository_enterprise_models.md#gettreecountrequest) | ##### Returns `Promise`<[`Count`](repositories_EnterpriseRepository_enterprise_models.Count.md)\> an object with `count` field that rapresent the enterprise buyed trees. #### Defined in [repositories/EnterpriseRepository/enterprise.interface.ts:21](https://github.com/impe93/digital-humani-js-sdk/blob/31e498c/src/repositories/EnterpriseRepository/enterprise.interface.ts#L21)