UNPKG

zcrmsdk

Version:

Node JS SDK for Zoho CRM

github.com/zoho/zohocrm-nodejs-sdk

zoho/zohocrm-nodejs-sdk

97 lines (71 loc) • 5.1 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
# Territories ## Package /core/com/zoho/crm/api/territories The Zoho CRM [Territories API](https://www.zoho.com/crm/developer/docs/api/territories.html) reference provides information about the possible operations on **Territories**. ## Classes | Class | Extends Classes | | :-------------------- | :-------------- | | [Territory](#territory) | | | [TerritoriesOperations](#territoriesoperations) | | | [APIException](#apiexception) | | | [ResponseWrapper](#responsewrapper) | | ---- ## Territory Structure of Zoho CRM [Territory](../../core/com/zoho/crm/api/territories/territory.js). ### Methods | Method | Description | | :------------------------- | :------------------------------------------------- | | getCreatedTime() | The method to get the value of ***Territory CreatedTime*** | | setCreatedTime(createdTime) | The method to set the value of ***Territory CreatedTime*** | | getModifiedTime() | The method to get the value of ***Territory ModifiedTime*** | | setModifiedTime(modifiedTime) | The method to set the value of ***Territory ModifiedTime*** | | getManager() | The method to get the value of ***Territory Manager*** | | setManager(***[manager](users.md#user)***) | The method to set the value of ***Territory Manager*** | | getParentId() | The method to get the value of ***Territory ParentId*** | | setParentId(parentId) | The method to set the value of ***Territory ParentId*** | | getCriteria() | The method to get the value of ***Territory Criteria*** | | setCriteria(***[criteria](custom_views.md#criteria)***) | The method to set the value of ***Territory Criteria*** | | getName() | The method to get the value of ***Territory Name*** | | setName(name) | The method to set the value of ***Territory Name*** | | getModifiedBy() | The method to get the value of ***Territory ModifiedBy*** | | setModifiedBy(***[modifiedBy](users.md#user)***) | The method to set the value of ***Territory ModifiedBy*** | | getDescription() | The method to get the value of ***Territory Description*** | | setDescription(description) | The method to set the value of ***Territory Description*** | | getId() | The method to get the value of ***Territory Id*** | | setId(id) | The method to set the value of ***Territory Id*** | | getCreatedBy() | The method to get the value of ***Territory CreatedBy*** | | setCreatedBy(***[createdBy](users.md#user)***) | The method to set the value of ***Territory CreatedBy*** | ---- [source](../../core/com/zoho/crm/api/territories/territory.js) ## TerritoriesOperations Contains methods for all possible [Territories operations](../../core/com/zoho/crm/api/territories/territories_operations.js). ### Methods | Method | Description | | :------------------------- | :------------------------------------------------- | | getTerritories() | To get the list of all territories. | | getTerritory(id) | To get the details of a specific territory. | ---- [source](../../core/com/zoho/crm/api/territories/territories_operations.js) ## APIException Whenever the **API** returns an error response, an instance of [APIException](../../core/com/zoho/crm/api/territories/api_exception.js) is returned for all operations. ### Methods | Method | Description | | :------------------------- | :------------------------------------------------- | | getCode() | The method to get the value of ***Code*** key in the **API** response | | setCode(***[code](../util/choice.md#choice<t>)***) | The method to set the value of ***Code*** key in the **API** response | | getStatus() | The method to get the value of ***Status*** key in the **API** response | | setStatus(***[status](../util/choice.md#choice<t>)***) | The method to set the value of ***Status*** key in the **API** response | | getMessage() | The method to get the value of ***Message*** key in the **API** response | | setMessage(***[message](../util/choice.md#choice<t>)***) | The method to set the value of ***Message*** key in the **API** response | | getDetails() | The method to get the value of ***Details*** key in the **API** response | | setDetails(details) | The method to set the value of ***Details*** key in the **API** response | ---- [source](../../core/com/zoho/crm/api/territories/api_exception.js) ## ResponseWrapper After a successful **API** request, an instance of [ResponseWrapper](../../core/com/zoho/crm/api/territories/response_wrapper.js) is returned for ***GET*** operations. ### Methods | Method | Description | | :------------------------- | :------------------------------------------------- | | getTerritories() | The method to get the list of obtained ***Territory*** instances. | | setTerritories(***[territories](territories.md#territory)***) | The method to set the list of obtained ***Territory*** instances. | ---- [source](../../core/com/zoho/crm/api/territories/response_wrapper.js)