Merge pull request #2 from Dorthu/managedContacts

Managed contacts

Author: Steve Szyszkiewicz

prebuild.js

@@ -388,6 +388,12 @@ const endpointMap = {
     routePath: `${ROUTE_BASE_PATH}/volumes`,
     groups: {},
   },
+  managed: {
+    name: 'Managed',
+    path: '/managed',
+    routePath: `${ROUTE_BASE_PATH}/managed`,
+    groups: {},
+  },
 };
 
 allEndpoints.forEach(function (endpointContainer) {

src/data/endpoints/managed.yaml

@@ -0,0 +1,83 @@
+# vim: set et ts=2 sw=2 tw=80 :
+name: Managed
+sort: 1
+description: >
+  Managed service endpoints provide a means of manipulating the information related to your Managed service preferences.
+endpoints:
+  /managed/contacts:
+    group: Contacts
+    type: resource
+    description: >
+      Manage your managed service contacts list.
+    methods:
+      GET:
+        response: ManagedContact
+        description: >
+          Returns your contact list.
+        examples:
+          curl: |
+            curl https://$api_root/$version/managed/contacts
+      POST:
+        description: >
+          Registers a new contact to your managed service contacts list.
+        params:
+          name:
+            description: The contact's full name.
+            type: String
+            limit: "1-64 characters"
+          email:
+            description: The email address for the contact.
+            type: String
+          phone_primary:
+            description: A primary phone number for the contact.
+            type: String
+          phone_secondary:
+            description: A secondary phone number for the contact.
+            type: String
+          group:
+            description: Contacts can be associated with a monitored service by the group they belong to.
+            type: String
+        examples:
+          curl: |
+            curl -H "Content-Type: application/json" \
+                -H "Authorization: Bearer $TOKEN" \
+                -X POST -d '{
+                    "name": "John Q. Public",
+                    "email": "johnqpublic@linode.com",
+                    "phone_primary": "215-555-3000",
+                    "phone_secondary": "215-555-3001",
+                    "group": "Support",
+                }' \
+                https://$api_root/$version/managed/contacts
+
+  /managed/contacts/$id:
+    group: Contacts
+    type: resource
+    authenticated: true
+    description: >
+      Manage a particular Managed service contact your account may access.
+    methods:
+      GET:
+        response: ManagedContact
+        description: >
+          Returns information about this contact.
+        examples:
+          curl: |
+            curl -H "Authorization: Bearer $TOKEN" \
+                https://$api_root/$version/managed/contact/$contact_id
+      PUT:
+        description: >
+          Edits this contact.
+        examples:
+          curl: |
+            curl -H "Content-Type: application/json" \
+                -H "Authorization: Bearer $TOKEN" \
+                -X PUT -d '{
+                    "name": "John Q. Public, Jr.",
+                    "email": "johnqpublicjr@linode.com",
+                    "phone": {
+                        "primary": "215-555-4000",
+                        "secondary": "215-555-4001",
+                    "group": "Developers"
+                }' \
+                https://$api_root/$version/account/oauth-clients/$client_id

src/data/objects/managedcontact.yaml

@@ -0,0 +1,32 @@
+# vim: set et ts=2 sw=2 tw=80 :
+name: ManagedContact
+prefix: managed/contacts
+description: >
+  A list of people we can contact if we require further information regarding your Managed service.
+schema:
+  name:
+    value: John Q. Public
+    type: String
+    description: >
+      The name of the contact person.
+  email:
+    value: jsmith@mycompany.com
+    type: String
+    description: >
+      The email address of the contact person.
+  phone:
+    primary:
+      value: 215-555-3000
+      type: String
+      description: >
+        If we need further information regarding a service, we may call this contact if a phone number is provided.
+    secondary:
+      value: 215-555-3001
+      type: String
+      description: >
+        The secondary phone number of the contact person.
+  group:
+    value: Support
+    type: String
+    description: >
+      Contacts can be associated with a monitored service by the group they belong to.