UNPKG

heroku-client

Version:

A wrapper for the Heroku v3 API

jclem/node-heroku-client

111 lines (67 loc) • 2 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
103
104
105
106
107
108
109
110
111
# Add-on Add-ons represent add-ons that have been provisioned for an app. ## Actions ### `create` `heroku.apps({app_id_or_name}).addons().create({attributes}, {callback});` Method | Path | Expected Status(es) --- | --- | --- POST | /apps/{app_id_or_name}/addons | 201 #### Optional Attributes - config - plan:id - plan:name ### `list` `heroku.apps({app_id_or_name}).addons().list({callback});` Method | Path | Expected Status(es) --- | --- | --- GET | /apps/{app_id_or_name}/addons | 200, 206 ### `info` `heroku.apps({app_id_or_name}).addons({addon_id}).info({callback});` Method | Path | Expected Status(es) --- | --- | --- GET | /apps/{app_id_or_name}/addons/{addon_id} | 200 ### `update` `heroku.apps({app_id_or_name}).addons({addon_id}).update({attributes}, {callback});` Method | Path | Expected Status(es) --- | --- | --- PATCH | /apps/{app_id_or_name}/addons/{addon_id} | 200 #### Optional Attributes - config - plan:id - plan:name ### `delete` `heroku.apps({app_id_or_name}).addons({addon_id}).delete({callback});` Method | Path | Expected Status(es) --- | --- | --- DELETE | /apps/{app_id_or_name}/addons/{addon_id} | 200 ## Attributes ### `config` *Additional add-on service specific configuration.* Example | Serialized? | Type --- | --- | --- `[object Object]` | false | object ### `created_at` *When add-on was created.* Example | Serialized? | Type --- | --- | --- `2012-01-01T12:00:00Z` | true | datetime ### `id` *Unique identifier of this add-on.* Example | Serialized? | Type --- | --- | --- `01234567-89ab-cdef-0123-456789abcdef` | true | uuid ### `plan:id` *Unique identifier for plan.* Example | Serialized? | Type --- | --- | --- `01234567-89ab-cdef-0123-456789abcdef` | true | uuid ### `plan:name` *Unique name for plan.* Example | Serialized? | Type --- | --- | --- `heroku-postgresql:dev` | true | string ### `updated_at` *When add-on was updated.* Example | Serialized? | Type --- | --- | --- `2012-01-01T12:00:00Z` | true | datetime