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

102 lines (55 loc) • 3.55 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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
[DigitalHumani JS SDK](../README.md) / [repositories/TreeRepository/tree.interface](../modules/repositories_TreeRepository_tree_interface.md) / ITreeRepository # Interface: ITreeRepository [repositories/TreeRepository/tree.interface](../modules/repositories_TreeRepository_tree_interface.md).ITreeRepository ## Implemented by - [`TreeRepository`](../classes/repositories_TreeRepository_tree_repository.TreeRepository.md) ## Table of contents ### Properties - [getTree](repositories_TreeRepository_tree_interface.ITreeRepository.md#gettree) - [getTrees](repositories_TreeRepository_tree_interface.ITreeRepository.md#gettrees) - [plantTrees](repositories_TreeRepository_tree_interface.ITreeRepository.md#planttrees) ## Properties ### getTree • `Readonly` **getTree**: (`params`: [`GetTreeRequest`](repositories_TreeRepository_tree_models.GetTreeRequest.md)) => `Promise`<[`Tree`](repositories_TreeRepository_tree_models.Tree.md)\> #### Type declaration ▸ (`params`): `Promise`<[`Tree`](repositories_TreeRepository_tree_models.Tree.md)\> Used to get a planted tree details by ID ##### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `params` | [`GetTreeRequest`](repositories_TreeRepository_tree_models.GetTreeRequest.md) | This object contain only the treeId to search | ##### Returns `Promise`<[`Tree`](repositories_TreeRepository_tree_models.Tree.md)\> An object with all the informations about the tree #### Defined in [repositories/TreeRepository/tree.interface.ts:22](https://github.com/impe93/digital-humani-js-sdk/blob/31e498c/src/repositories/TreeRepository/tree.interface.ts#L22) ___ ### getTrees • `Readonly` **getTrees**: (`params`: [`GetTreesRequest`](repositories_TreeRepository_tree_models.GetTreesRequest.md)) => `Promise`<[`GetTreesResponse`](repositories_TreeRepository_tree_models.GetTreesResponse.md)\> #### Type declaration ▸ (`params`): `Promise`<[`GetTreesResponse`](repositories_TreeRepository_tree_models.GetTreesResponse.md)\> Used to get how many trees has planted the user passed as a parameter. ##### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `params` | [`GetTreesRequest`](repositories_TreeRepository_tree_models.GetTreesRequest.md) | Those params are used to understand wich trees to get | ##### Returns `Promise`<[`GetTreesResponse`](repositories_TreeRepository_tree_models.GetTreesResponse.md)\> A response with the user, enterpriseId and the planted tree count. #### Defined in [repositories/TreeRepository/tree.interface.ts:15](https://github.com/impe93/digital-humani-js-sdk/blob/31e498c/src/repositories/TreeRepository/tree.interface.ts#L15) ___ ### plantTrees • `Readonly` **plantTrees**: (`body`: [`PlanteTreesRequest`](../modules/repositories_TreeRepository_tree_models.md#plantetreesrequest)) => `Promise`<[`Tree`](repositories_TreeRepository_tree_models.Tree.md)\> #### Type declaration ▸ (`body`): `Promise`<[`Tree`](repositories_TreeRepository_tree_models.Tree.md)\> Used to get a planted tree details by ID ##### Parameters | Name | Type | | :------ | :------ | | `body` | [`PlanteTreesRequest`](../modules/repositories_TreeRepository_tree_models.md#plantetreesrequest) | ##### Returns `Promise`<[`Tree`](repositories_TreeRepository_tree_models.Tree.md)\> An object with all the informations about the tree #### Defined in [repositories/TreeRepository/tree.interface.ts:29](https://github.com/impe93/digital-humani-js-sdk/blob/31e498c/src/repositories/TreeRepository/tree.interface.ts#L29)