forked from HubSpot/haPiHP
-
Notifications
You must be signed in to change notification settings - Fork 1
/
class.properties.php
244 lines (220 loc) · 5.95 KB
/
class.properties.php
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
<?php
/**
* Copyright 2013 HubSpot, Inc.
*
* Licensed under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
require_once('class.baseclient.php');
class HubSpot_Properties extends HubSpot_Baseclient{
protected $API_PATH = 'contacts';
protected $API_VERSION = 'v1';
/**
* Get all Properties
*
*
* @return Array of all properties in portal
*
* @throws HubSpot_Exception
**/
public function get_all_properties(){
$endpoint = 'properties';
try{
return json_decode($this->execute_get_request($this->get_request_url($endpoint,null)));
}
catch(HubSpot_Exception $e){
print_r('Unable to retrieve properties: '.$e);
}
}
/**
* Create a new Property
*
*@param name: Name for the new property
* params: Array of info for the new property. Example of fields to include:
*
* "name": "newcustomproperty",
* "label": "A New Custom Property",
* "description": "A new property for you",
* "groupName": "contactinformation",
* "type": "string",
* "fieldType": "text",
* "formField": true,
* "displayOrder": 6,
* "options": []
*
*
* @return Response body from HTTP PUT request
*
* @throws HubSpot_Exception
**/
public function create_property($name,$params){
$endpoint = 'properties/'.$name;
try{
return json_decode($this->execute_put_request($this->get_request_url($endpoint,null),json_encode($params)));
}
catch(HubSpot_Exception $e){
print_r('Unable to create property: '.$e);
}
}
/**
* Update a Property
*
*@param name: Name for the new property
* params: Array of info for the property. Example of fields to include:
*
* "name": "newcustomproperty",
* "label": "A New Custom Property",
* "description": "A new property for you",
* "groupName": "contactinformation",
* "type": "string",
* "fieldType": "text",
* "formField": true,
* "displayOrder": 6,
* "options": []
*
*
* @return Response body of HTTP POST request
*
* @throws HubSpot_Exception
**/
public function update_property($name,$params){
$endpoint = 'properties/'.$name;
try{
return json_decode($this->execute_JSON_post_request($this->get_request_url($endpoint,null),json_encode($params)));
}
catch(HubSpot_Exception $e){
print_r('Unable to update property: '.$e);
}
}
/**
* Delete a Property
*
* @param name: Name of property to delete
*
* @return Response body from HTTP DELETE request
*
* @throws HubSpot_Exception
**/
public function delete_property($name){
$endpoint = 'properties/'.$name;
try{
return $this->execute_delete_request($this->get_request_url($endpoint,null));
}
catch(HubSpot_Exception $e){
print_r('Unable to delete property: '.$e);
}
}
/**
* Get all Properties Groups
*
*
* @return Array of all property groups in portal
*
* @throws HubSpot_Exception
**/
public function get_property_groups(){
$endpoint = 'groups';
try{
return json_decode($this->execute_get_request($this->get_request_url($endpoint,null)));
}
catch(HubSpot_Exception $e){
print_r('Unable to retrieve property groups: '.$e);
}
}
/**
* Get specific Property Group
*
*@param name: Name of property group to retrieve
*
* @return Array containing requested property group
*
* @throws HubSpot_Exception
**/
public function get_property_group($name){
$endpoint = 'groups/'.$name;
try{
return json_decode($this->execute_get_request($this->get_request_url($endpoint,null)));
}
catch(HubSpot_Exception $e){
print_r('Unable to retrieve property group: '.$e);
}
}
/**
* Create a Property Group
*
*@param name: Name of property group to retrieve
* params: Array for the fields to create the Group. Ex:
* {
* "name": "newcustomgroup",
* "displayName": "A New Custom Group",
* "displayOrder": 5
* }
*
* @return Array containing requested property group
*
* @throws HubSpot_Exception
**/
public function create_property_group($name,$params){
$endpoint = 'groups/'.$name;
try{
return json_decode($this->execute_put_request($this->get_request_url($endpoint,null),json_encode($params)));
}
catch(HubSpot_Exception $e){
print_r('Unable to create property group: '.$e);
}
}
/**
* Update a Property Group
*
*@param name: Name of property group to retrieve
* params: Array for the fields to create the Group. Ex:
* {
* "name": "newcustomgroup",
* "displayName": "A New Custom Group",
* "displayOrder": 5
* }
*
* @return Array containing requested property group
*
* @throws HubSpot_Exception
**/
public function update_property_group($name,$params){
$endpoint = 'groups/'.$name;
try{
return json_decode($this->execute_JSON_post_request($this->get_request_url($endpoint,null),json_encode($params)));
}
catch(HubSpot_Exception $e){
print_r('Unable to update property group: '.$e);
}
}
/**
* Delete a Property Group
*
*@param name: Name of property group to retrieve
*
* @return Array containing requested property group
*
* @throws HubSpot_Exception
**/
public function delete_property_group($name){
$endpoint = 'groups/'.$name;
try{
return json_decode($this->execute_delete_request($this->get_request_url($endpoint,null),null));
}
catch(HubSpot_Exception $e){
print_r('Unable to delete property group: '.$e);
}
}
}
?>