minbox.json

{
    "endpoints": [
        {
            "name": "User",
            "methods": [
                {
                    "MethodName": "show",
                    "Synopsis": "Gets information about the authenticated user",
                    "HTTPMethod": "GET",
                    "URI": "/user",
                    "RequiresOAuth": "Y",
                    "parameters": [
                    ]
                },
                {
                    "MethodName": "update",
                    "Synopsis": "Updates user account information",
                    "HTTPMethod": "PUT",
                    "URI": "/user",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "name",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The name of the user"
                        },
                        {
                            "Name": "stationery_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Stationery to set"
                        },
                        {
                            "Name": "settings",
                            "Required": "N",
                            "Default": "",
                            "Type": "hash",
                            "Description": "A hash of settings like default background, stationary, etc."
                        },
                        {
                            "Name": "facebook_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The Facebook ID for this user, determined during the Facebook authorization process."
                        },
                        {
                            "Name": "facebook_access_token",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The access token returned after a successful Facebook authorization. These tend to expire after a couple hours unles exchanged for a long-running token."
                        },
                        {
                            "Name": "facebook_access_token_expiry",
                            "Required": "N",
                            "Default": "",
                            "Type": "integer",
                            "Description": "The UTC timestamp for when the access token will expire. Only really necessary when a long-running token has been requested, otherwise defaults to a couple hours."
                        },
                        {
                            "Name": "device_token",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The APN token of the iOS Device being used. Optional, but necessary to enable APNs."
                        },
                        {
                            "Name": "invalidate",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value here will invalidate the user's current oauth token. Intended for testing purposes only."
                        },
                        {
                            "Name": "refresh_unread",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value here will send a Push containing the latest unread Folds, Conversations, and Messages. Intended for testing purposes only."
                        },
                        {
                            "Name": "apns",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value here will send an APN via the development provisioning profile, containing the most recent message the authenticated user has received."
                        },
                        {
                            "Name": "pusher_test",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value here will send a test Pusher message via the pusher_channel of the user."
                        },
                        {
                            "Name": "connection",
                            "Required": "N",
                            "Default": "",
                            "Type": "enumerated",
                            "EnumeratedList": [
                                "error",
                                "warn",
                                "ok"
                            ],
                            "Description": "Will send a Pusher message related to email account connectivity for the level specified. Connection status specified here is not saved permanently."
                        }
                    ]
                },
                {
                    "MethodName": "destroy",
                    "Synopsis": "Completely destroys the authenticated user.",
                    "HTTPMethod": "DELETE",
                    "URI": "/user",
                    "RequiresOAuth": "Y",
                    "parameters": [
                    ]
                }
            ]
        },
        {
            "name": "EmailAccounts",
            "methods": [
                {
                    "MethodName": "index",
                    "Synopsis": "List the email accounts of the authenticated user",
                    "HTTPMethod": "GET",
                    "URI": "/email_accounts",
                    "RequiresOAuth": "Y",
                    "parameters": [
                    ]
                },
                {
                    "MethodName": "show",
                    "Synopsis": "Show information about a specific email account",
                    "HTTPMethod": "GET",
                    "URI": "/email_accounts/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID or email address"
                        }
                    ]
                },
                {
                    "MethodName": "create",
                    "Synopsis": "Adds a new email account to the user",
                    "HTTPMethod": "POST",
                    "URI": "/email_accounts",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "email",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The email address to add"
                        }
                    ]
                },
                {
                    "MethodName": "update",
                    "Synopsis": "Updates information about an email account",
                    "HTTPMethod": "PUT",
                    "URI": "/email_accounts/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID or email address"
                        },
                        {
                            "Name": "verify",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The verification code. Will mark this email account as verified if correct."
                        },
                        {
                            "Name": "resend",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "When present, the verification email will be resent for unverified email accounts."
                        }
                    ]
                },
                {
                    "MethodName": "destroy",
                    "Synopsis": "Removes an email account. For the moment this will only work for unverified, non-primary email accounts",
                    "HTTPMethod": "DELETE",
                    "URI": "/email_accounts/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID or email address"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Contacts",
            "methods": [
                {
                    "MethodName": "index",
                    "Synopsis": "Gets a list of the User's Contacts",
                    "HTTPMethod": "GET",
                    "URI": "/contacts",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "fold_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of a Fold to filter the Contacts by"
                        },
                        {
                            "Name": "stack_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of a Stack to filter the Contacts by"
                        },
                        {
                            "Name": "limit",
                            "Required": "N",
                            "Default": "10",
                            "Type": "integer",
                            "Description": "The maximum number of results to return, or the number per page when requesting paginated results"
                        },
                        {
                            "Name": "page",
                            "Required": "N",
                            "Default": "1",
                            "Type": "integer",
                            "Description": "The page number, when requesting paginated results, minimum 1"
                        }
                    ]
                },
                {
                    "MethodName": "show",
                    "Synopsis": "Gets information about a specific Contact",
                    "HTTPMethod": "GET",
                    "URI": "/contacts/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Contact (can be appended to the path of the URL)"
                        }
                    ]
                },
                {
                    "MethodName": "bulk_create",
                    "Synopsis": "Creates multiple contacts in one go. Returns an array of either contact hashes or {errors: [a hash of errors on each field]}",
                    "HTTPMethod": "POST",
                    "URI": "/contacts/bulk",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "contacts",
                            "Required": "Y",
                            "Default": "",
                            "Type": "array",
                            "Description": "An array of attribute hashes, one for each contact to be created. Should include at least 'name' and 'email' keys, and may optionally include a 'classification_from_user' parameter that can be 'home' or 'work'."
                        }
                    ],
                    "response": {
                        "parameters": [
                            {
                                "Name": "contacts",
                                "Type": "array",
                                "Description": "An array of both attribute hashes for the created contacts or error hashes for the contacts that had errors"
                            }
                        ],
                        "examples": [
                            {
                                "contacts": [
                                   {
                                                 "id": "512d0644fd8774c156000042",
                                              "email": "some_email@example.com",
                                          "remote_id": "some_email@example.com",
                                               "name": "Some Name",
                                         "first_name": "Some",
                                             "pinned": false,
                                               "rank": 0.0,
                                        "avatar_urls": {
                                           "largest": "/avatar/api/person/some_email@example.com/largest/image.jpg",
                                            "larger": "/avatar/api/person/some_email@example.com/larger/image.jpg",
                                             "large": "/avatar/api/person/some_email@example.com/large/image.jpg",
                                            "medium": "/avatar/api/person/some_email@example.com/medium/image.jpg",
                                             "small": "/avatar/api/person/some_email@example.com/small/image.jpg",
                                           "smaller": "/avatar/api/person/some_email@example.com/smaller/image.jpg",
                                             "round": "/avatar/api/person/some_email@example.com/round/image.jpg",
                                               "300": "/avatar/api/person/some_email@example.com/300/image.jpg"
                                       },
                                         "is_service": false,
                                       "last_seen_at": null,
                                               "type": "contact"
                                   },
                                   {
                                     "errors": {
                                       "remote_id": ["can't be blank"],
                                       "email": ["does not appear to be valid"]
                                     }
                                   }
                                 ]
                            }
                        ]
                    }
                },
                {
                    "MethodName": "create",
                    "Synopsis": "Creates a new Contact for the User, or can be used to add new OR EXISTING Contacts to a specified Stack",
                    "HTTPMethod": "POST",
                    "URI": "/contacts",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "email",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The email address of the Contact"
                        },
                        {
                            "Name": "stack_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "If using this call to add a Contact to a Stack, the ID of the specific Stack"
                        },
                        {
                            "Name": "name",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A name for this Contact. If none given, will default to the email prefix"
                        },
                        {
                            "Name": "service_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "If this Contact is to be associated with a Service, the ID of the specific Service"
                        }
                    ]
                },
                {
                    "MethodName": "update",
                    "Synopsis": "Updates information about a Contact. This method can also be used for removing Contacts from a specific Stack.",
                    "HTTPMethod": "PUT",
                    "URI": "/contacts/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Contact (can be appended to the path of the URL)"
                        },
                        {
                            "Name": "email",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A new email address for the Contact (must not already exist in the User's Contact list)"
                        },
                        {
                            "Name": "name",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A new name for the Contact"
                        },
                        {
                            "Name": "pinned",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value for this parameter will mark the Contact as pinned (favourite)"
                        },
                        {
                            "Name": "unfave",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value for this parameter will remove the Contact as a favourite (unpin)"
                        },
                        {
                            "Name": "stack_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Adds the Contact to the Stack specified"
                        },
                        {
                            "Name": "nonperson",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value for this parameter will convert a person Contact into a non-person Contact (company)."
                        },
                        {
                            "Name": "person",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value for this parameter will convert a non-person (company) Contact into a person Contact."
                        }
                    ]
                },
                {
                    "MethodName": "destroy",
                    "Synopsis": "Removes a Contact from a Stack, or entirely from the User's Contact list.",
                    "HTTPMethod": "DELETE",
                    "URI": "/contacts/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Contact (can be appended to the path of the URL)"
                        },
                        {
                            "Name": "stack_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Stack to remove the Contact from"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Conversations",
            "methods": [
                {
                    "MethodName": "index",
                    "Synopsis": "Gets a list of the user's Conversations",
                    "HTTPMethod": "GET",
                    "URI": "/conversations",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "fold_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of a Fold to filter the Conversations by"
                        },
                        {
                            "Name": "contact_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of a Contact to query the Conversations by. Will return all conversations the contact is a member of."
                        },
                        {
                            "Name": "limit",
                            "Required": "N",
                            "Default": "5",
                            "Type": "integer",
                            "Description": "The maximum number of results to return, or the number per page when requesting paginated results"
                        },
                        {
                            "Name": "page",
                            "Required": "N",
                            "Default": "1",
                            "Type": "integer",
                            "Description": "The page number, when requesting paginated results, minimum 1"
                        },
                        {
                            "Name": "message_ids",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Specific messages to include in the response. In comma delimited or array form. This overrides any message pagination parameters."
                        },
                        {
                            "Name": "messages_limit",
                            "Required": "N",
                            "Default": "",
                            "Type": "integer",
                            "Description": "The number of messages to return per each conversation. Note the default is zero!"
                        },
                        {
                            "Name": "messages_page",
                            "Required": "N",
                            "Default": "",
                            "Type": "integer",
                            "Description": "The messages page number, when including messages in request, minimum 1"
                        },
                        {
                            "Name": "filter",
                            "Required": "N",
                            "Default": "",
                            "Type": "enumerated",
                            "EnumeratedList": [
                                "date",
                                "updated_since",
                                "read"
                            ],
                            "Description": "An attribute to filter results by (eg. \"date\")"
                        },
                        {
                            "Name": "criteria",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A value to use for the filter parameter (eg. a timestamp for the \"date\" filter, \"true\" or \"false\" for the \"read\" filter.)"
                        }
                    ]
                },
                {
                    "MethodName": "show",
                    "Synopsis": "Gets information about a specific Conversation",
                    "HTTPMethod": "GET",
                    "URI": "/conversations/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Conversation (can be appended to the path of the URL)"
                        },
                        {
                            "Name": "quoted_text",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value here will return a 'quoted_text' string instead of the array of messages"
                        },
                        {
                            "Name": "quoted_text_sort",
                            "Required": "N",
                            "Default": "",
                            "Type": "enumerated",
                            "EnumeratedList": [
                                "desc",
                                "asc"
                            ],
                            "Description": "The direction to sort messages in the quoted text by. Sort is by date in this direction, default is 'desc'."
                        },
                        {
                            "Name": "message_ids",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Specific messages to include in the response, including in quoted text. In comma delimited or array form. This overrides any message pagination parameters."
                        },
                        {
                            "Name": "messages_limit",
                            "Required": "N",
                            "Default": "",
                            "Type": "integer",
                            "Description": "The number of messages to return with this conversation. If quoted_text is specified, this parameter is ignored."
                        },
                        {
                            "Name": "messages_page",
                            "Required": "N",
                            "Default": "",
                            "Type": "integer",
                            "Description": "The messages page number, when including messages in request, minimum 1"
                        }
                    ]
                },
                {
                    "MethodName": "update",
                    "Synopsis": "Updates information about a Conversation",
                    "HTTPMethod": "PUT",
                    "URI": "/conversations/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Conversation (can be appended to the path of the URL)"
                        },
                        {
                            "Name": "read",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value for this parameter will mark all Messages in this Conversation as read"
                        },
                        {
                            "Name": "unread",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value for this parameter will mark all Messages in this Conversation as unread"
                        },
                        {
                            "Name": "message_ids",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Specific messages to include in the response. In comma delimited or array form. This overrides any message pagination parameters."
                        },
                        {
                            "Name": "messages_limit",
                            "Required": "N",
                            "Default": "",
                            "Type": "integer",
                            "Description": "The number of messages to return with this conversation."
                        },
                        {
                            "Name": "messages_page",
                            "Required": "N",
                            "Default": "",
                            "Type": "integer",
                            "Description": "The messages page number, when including messages in request, minimum 1"
                        },
                        {
                            "Name": "undo_destroy",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value here will attempt to undo a previous delete request. After a timeout undo is no longer possible."
                        }
                    ]
                },
                {
                    "MethodName": "destroy",
                    "Synopsis": "Deletes a Conversation from our system after a brief timeout for undo. All messages are moved into the Trash folder on the IMAP server.",
                    "HTTPMethod": "DELETE",
                    "URI": "/conversations/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Conversation (can be appended to the path of the URL)"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Messages",
            "methods": [
                {
                    "MethodName": "index",
                    "Synopsis": "Gets a list of the user's Messages, with optional filter/search criteria.",
                    "HTTPMethod": "GET",
                    "URI": "/messages",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "conversation_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Conversation to scope Messages by"
                        },
                        {
                            "Name": "limit",
                            "Required": "N",
                            "Default": "10",
                            "Type": "integer",
                            "Description": "The maximum number of results to return, or the number per page when requesting paginated results"
                        },
                        {
                            "Name": "page",
                            "Required": "N",
                            "Default": "1",
                            "Type": "integer",
                            "Description": "The page number, when requesting paginated results, minimum 1"
                        },
                        {
                            "Name": "filter",
                            "Required": "N",
                            "Default": "",
                            "Type": "enumerated",
                            "EnumeratedList": [
                                "date",
                                "updated_since"
                            ],
                            "Description": "An attribute to filter results by (eg. \"date\")"
                        },
                        {
                            "Name": "criteria",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A value to use for the filter parameter (eg. a timestamp for the \"date\" filter)"
                        }
                    ]
                },
                {
                    "MethodName": "show",
                    "Synopsis": "Gets information about a specific Message",
                    "HTTPMethod": "GET",
                    "URI": "/messages/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Message (can be appended to the path of the URL)"
                        },
                        {
                            "Name": "conversation_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Conversation to scope Messages by"
                        },
                        {
                            "Name": "quoted_text",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value here will return a quoted_text attribute containing the message body in email quoted format."
                        }
                    ]
                },
                {
                    "MethodName": "create",
                    "Synopsis": "Creates a new Message *AND SENDS IT* 10 seconds later",
                    "HTTPMethod": "POST",
                    "URI": "/messages",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "email_account_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the EmailAccount belonging to the user that this message shall be sent from. If omitted, the primary EmailAccount is used."
                        },
                        {
                            "Name": "conversation_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of a Conversation that this Message is to be a part of. All Contacts on the Conversation will receive a copy of the Message."
                        },
                        {
                            "Name": "subject",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A custom subject for the Message. Will default to the Conversation subject, or a generic subject if it is the first Message."
                        },
                        {
                            "Name": "to",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A single email address, or a list of email addresses. One of to or cc are required."
                        },
                        {
                            "Name": "cc",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A single email address, or a list of email addresses. One of to or cc are required."
                        },
                        {
                            "Name": "body",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The body text of the message. Should be plain text (for the moment)."
                        },
                        {
                            "Name": "stack_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of a Stack, if specified all Contacts in the Stack will receive a copy of the message"
                        },
                        {
                            "Name": "contact_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of a Contact to receive the message"
                        },
                        {
                            "Name": "draft_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Draft that this Message was created from. *When the Message is delivered, the Draft is destroyed automatically.*"
                        },
                        {
                            "Name": "deliver_at",
                            "Required": "N",
                            "Default": "",
                            "Type": "number",
                            "Description": "A UTC unix timestamp (in seconds) for a future time to deliver the message. Will be ignored if invalid."
                        },
                        {
                            "Name": "forward_conversation_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Conversation that this message is a forward of. All messages in the conversation will be quoted below the body."
                        },
                        {
                            "Name": "forward_message_ids",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The IDs of specifc Messages from the Forwarded Conversation to be quoted. If ommitted, all Messages are quoted."
                        },
                        {
                            "Name": "attachment_ids",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "An array of existing attachment ids to be associated with this message"
                        },
                        {
                            "Name": "gallery_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of an existing Gallery to attach to this Message. A link to the Gallery will be embedded in the Message body."
                        }
                    ]
                },
                {
                    "MethodName": "update",
                    "Synopsis": "Updates information about a Message. Used only for specific functions like marking as read/unread, etc.",
                    "HTTPMethod": "PUT",
                    "URI": "/messages/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Message (can be appended to the path of the URL)"
                        },
                        {
                            "Name": "unread",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value for this parameter will the Message as unread"
                        },
                        {
                            "Name": "read",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value for this parameter will mark the Message as read"
                        },
                        {
                            "Name": "spam",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value for this parameter will mark the Message as spam"
                        },
                        {
                            "Name": "undo_send",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value for this parameter will attempt to undo delivery of the message (unless it has already been delivered or is not eligible)."
                        }
                    ]
                },
                {
                    "MethodName": "destroy",
                    "Synopsis": "Deletes a Message from our system, and moves it into the Trash folder on the IMAP server.",
                    "HTTPMethod": "DELETE",
                    "URI": "/messages/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Message (can be appended to the path of the URL)"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Drafts",
            "methods": [
                {
                    "MethodName": "index",
                    "Synopsis": "Gets a list of the user's Drafts.",
                    "HTTPMethod": "GET",
                    "URI": "/drafts",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "limit",
                            "Required": "N",
                            "Default": "20",
                            "Type": "integer",
                            "Description": "The maximum number of results to return, or the number per page when requesting paginated results"
                        },
                        {
                            "Name": "page",
                            "Required": "N",
                            "Default": "1",
                            "Type": "integer",
                            "Description": "The page number, when requesting paginated results, minimum 1"
                        }
                    ]
                },
                {
                    "MethodName": "show",
                    "Synopsis": "Gets information about a specific Draft",
                    "HTTPMethod": "GET",
                    "URI": "/drafts/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Draft (can be appended to the path of the URL)"
                        }
                    ]
                },
                {
                    "MethodName": "create",
                    "Synopsis": "Creates a new Draft",
                    "HTTPMethod": "POST",
                    "URI": "/drafts",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "subject",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A subject for the Draft."
                        },
                        {
                            "Name": "body",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The body text of the Draft. Should be plain text (for the moment)."
                        }
                    ]
                },
                {
                    "MethodName": "update",
                    "Synopsis": "Updates an existing Draft.",
                    "HTTPMethod": "PUT",
                    "URI": "/drafts/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Draft (can be appended to the path of the URL)"
                        },
                        {
                            "Name": "subject",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A subject for the Draft."
                        },
                        {
                            "Name": "body",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The body text of the Draft. Should be plain text (for the moment)."
                        }
                    ]
                },
                {
                    "MethodName": "destroy",
                    "Synopsis": "Deletes a Draft.",
                    "HTTPMethod": "DELETE",
                    "URI": "/drafts/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Draft (can be appended to the path of the URL)"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Suggestions",
            "methods": [
                {
                    "MethodName": "index",
                    "Synopsis": "Used to request suggestions using server-side algorithms, based on the requesting user and some optional criteria.",
                    "HTTPMethod": "GET",
                    "URI": "/suggestions",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "type",
                            "Required": "Y",
                            "Default": "contact",
                            "Type": "enumerated",
                            "EnumeratedList": [
                                "contact",
                                "service"
                            ],
                            "Description": "The type of suggestions being requested. Contacts (typically for creating/editing a Stack), or Services (typically for subscribing to more)."
                        },
                        {
                            "Name": "service_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A reference Service to use when suggesting more Services"
                        },
                        {
                            "Name": "contact_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A reference Contact to use when suggesting more Contacts *OR* more Services"
                        },
                        {
                            "Name": "limit",
                            "Required": "N",
                            "Default": "10",
                            "Type": "integer",
                            "Description": "The maximum number of results to return, or the number per page when requesting paginated results"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Discovery",
            "methods": [
                {
                    "MethodName": "show",
                    "Synopsis": "Used to determine the type of email account provided. Possible results for type are: gmail, googleapps, and generic (for any other IMAP provider). This method will return 404 if no information could be found, or if the email provider does not support IMAP.",
                    "HTTPMethod": "GET",
                    "URI": "/discovery",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "email",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The email address to query, this can also be appended to the end of the URL path."
                        }
                    ]
                }
            ]
        },
        {
            "name": "SignIn",
            "methods": [
                {
                    "MethodName": "create",
                    "Synopsis": "Attempts to sign-in a user. This performs a login if the user is already registered, or creates a new account for them if not.",
                    "HTTPMethod": "POST",
                    "URI": "/sign_in",
                    "RequiresOAuth": "N",
                    "parameters": [
                        {
                            "Name": "email",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The email address of the user"
                        },
                        {
                            "Name": "password",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The password for the email address"
                        },
                        {
                            "Name": "terms_accepted",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value indicates that the user has read and accepted the terms and conditions. Required only for new users."
                        },
                        {
                            "Name": "device_token",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The APN token of the iOS Device being used. Optional, but necessary to enable APNs. Can also be set later via User.update."
                        }
                    ]
                }
            ]
        },
        {
            "name": "Attachments",
            "methods": [
                {
                    "MethodName": "create",
                    "Synopsis": "Upload the specified attachment and create a new Attachment record.",
                    "HTTPMethod": "POST",
                    "URI": "/attachments",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "message_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the Message the Attachment belongs to"
                        },
                        {
                            "Name": "attachment_index",
                            "Required": "Y",
                            "Default": "",
                            "Type": "integer",
                            "Description": "The position (order) of the attachment among multiple attachments for a message."
                        },
                        {
                            "Name": "asset",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The contents of the attachment file as a multipart form upload"
                        },
                        {
                            "Name": "is_public",
                            "Required": "N",
                            "Default": "false",
                            "Type": "string",
                            "Description": "Whether the attachment being created can be viewed by other users"
                        }
                    ]
                },
                {
                    "MethodName": "update",
                    "Synopsis": "Updates the specified Attachment record with any of the given fields",
                    "HTTPMethod": "PUT",
                    "URI": "/attachments/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": ":id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the attachment as returned by create"
                        },
                        {
                            "Name": "message_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the Message the Attachment belongs to."
                        },
                        {
                            "Name": "attachment_index",
                            "Required": "N",
                            "Default": "",
                            "Type": "integer",
                            "Description": "The position (order) of the attachment among multiple attachments for a message."
                        },
                        {
                            "Name": "is_public",
                            "Required": "N",
                            "Default": "false",
                            "Type": "string",
                            "Description": "Whether the attachment being created can be viewed by other users"
                        }
                    ]
                },
                {
                    "MethodName": "index",
                    "Synopsis": "Queries attachments by attachment name using a query, and paginates by page results by pages holding 25 records a page.  This returns a JSON array of results.  If no parameters are given, the action will return the first page of results of all attachments.",
                    "HTTPMethod": "GET",
                    "URI": "/attachments",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "message_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of a message to scope the Attachments by"
                        },
                        {
                            "Name": "conversation_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of a conversation to scope the Attachments by"
                        },
                        {
                            "Name": "filename",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A string that will be matched against the attachments' original filenames"
                        },
                        {
                            "Name": "limit",
                            "Required": "N",
                            "Default": "25",
                            "Type": "integer",
                            "Description": "The number of attachments to return in a page"
                        },
                        {
                            "Name": "page",
                            "Required": "N",
                            "Default": "1",
                            "Type": "integer",
                            "Description": "The page of records matching the string, returns 25 records per page"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Candidates",
            "methods": [
                {
                    "MethodName": "show",
                    "Synopsis": "Gets information about a specific Candidate",
                    "HTTPMethod": "GET",
                    "URI": "/candidates/:id",
                    "RequiresOAuth": "N",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "This can be an email address, or an ID if one is known"
                        }
                    ]
                },
                {
                    "MethodName": "create",
                    "Synopsis": "Registers a new Candidate for the beta list",
                    "HTTPMethod": "POST",
                    "URI": "/candidates",
                    "RequiresOAuth": "N",
                    "parameters": [
                        {
                            "Name": "email",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The email address to register for the beta list"
                        },
                        {
                            "Name": "referrer_id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Minbox user who referred them (optional)"
                        }
                    ]
                },
                {
                    "MethodName": "update",
                    "Synopsis": "Used to upload an optional avatar after a Candidate has been registered. This request should be formated as an html multipart form upload.",
                    "HTTPMethod": "PUT",
                    "URI": "/candidates/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "This can be an email address, or an ID if one is known"
                        },
                        {
                            "Name": "avatar",
                            "Required": "N",
                            "Default": "",
                            "Type": "file",
                            "Description": "The avatar file"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Events",
            "methods": [
                {
                    "MethodName": "index",
                    "Synopsis": "Gets a listing of Events in the User's account, with a number of optional criteria.",
                    "HTTPMethod": "GET",
                    "URI": "/events",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "fold_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of a specific Fold to filter by"
                        },
                        {
                            "Name": "conversation_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of a specific Conversation to filter by"
                        },
                        {
                            "Name": "message_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of a specific Message to filter by"
                        },
                        {
                            "Name": "contact_id",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of a specific Contact to filter by"
                        },
                        {
                            "Name": "since",
                            "Required": "N",
                            "Default": "",
                            "Type": "integer",
                            "Description": "A unix timestamp. Events returned will be after this date/time (inclusive)."
                        },
                        {
                            "Name": "before",
                            "Required": "N",
                            "Default": "",
                            "Type": "integer",
                            "Description": "A unix timestamp. Events returned will be before this date/time (inclusive)."
                        },
                        {
                            "Name": "type",
                            "Required": "N",
                            "Default": "",
                            "Type": "enumerated",
                            "EnumeratedList": [
                                "fold",
                                "conversation",
                                "message",
                                "contact"
                            ],
                            "Description": "The class type of Event to filter by. Eg. 'fold': all Fold-level events for the user."
                        },
                        {
                            "Name": "name",
                            "Required": "N",
                            "Default": "",
                            "Type": "enumerated",
                            "EnumeratedList": [
                                "fold_deleted",
                                "fold_dismissed",
                                "fold_recalled",
                                "fold_marked_as_person",
                                "fold_marked_as_service",
                                "fold_marked_as_read",
                                "fold_marked_as_unread",
                                "conversation_deleted",
                                "conversation_marked_as_read",
                                "conversation_marked_as_unread",
                                "message_created",
                                "message_deleted",
                                "message_marked_as_read",
                                "message_marked_as_unread",
                                "contact_deleted",
                                "contact_converted_to_service",
                                "contact_converted_to_person"
                            ],
                            "Description": "A specific event name to filter by. Note: certain event names only go with certain class types."
                        },
                        {
                            "Name": "limit",
                            "Required": "N",
                            "Default": "100",
                            "Type": "integer",
                            "Description": "The number of folds to return in a page"
                        },
                        {
                            "Name": "page",
                            "Required": "N",
                            "Default": "1",
                            "Type": "integer",
                            "Description": "The page number, when requesting paginated results, minimum 1"
                        }
                    ]
                },
                {
                    "MethodName": "show",
                    "Synopsis": "Gets information about a specific Event",
                    "HTTPMethod": "GET",
                    "URI": "/events/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The ID of the Event (can be appended to the path of the URL)"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Galleries",
            "methods": [
                {
                    "MethodName": "index",
                    "Synopsis": "Lists all galleries owned by this user, sorted by date.",
                    "HTTPMethod": "GET",
                    "URI": "/galleries",
                    "RequiresOAuth": "N",
                    "parameters": [
                        {
                            "Name": "limit",
                            "Required": "N",
                            "Default": "5",
                            "Type": "integer",
                            "Description": "The number of items to return in a page"
                        },
                        {
                            "Name": "page",
                            "Required": "N",
                            "Default": "1",
                            "Type": "integer",
                            "Description": "The page number, when requesting paginated results, minimum 1"
                        },
                        {
                            "Name": "query",
                            "Required": "N",
                            "Default": "",
                            "Type": "enumerated",
                            "EnumeratedList": ["active", "sent", "pending", "deleted", "expired", "all"],
                            "Description": "Criteria to filter the galleries by. Active is the default, and Sent indicates both active and sent via email."
                        }
                    ]
                },
                {
                    "MethodName": "show",
                    "Synopsis": "Fetches meta data about a specific gallery.",
                    "HTTPMethod": "GET",
                    "URI": "/galleries/:id",
                    "RequiresOAuth": "N",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery to fetch"
                        }
                    ]
                },
                {
                    "MethodName": "create",
                    "Synopsis": "Creates a new gallery.",
                    "HTTPMethod": "POST",
                    "URI": "/galleries",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "name",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A custom name for this gallery"
                        },
                        {
                            "Name": "source",
                            "Required": "N",
                            "Default": "",
                            "Type": "enumerated",
                            "EnumeratedList": ["", "composer", "screenshot", "context-menu", "direct"],
                            "Description": "The way that the gallery is being created"
                        },
                        {
                            "Name": "screenshots",
                            "Required": "N",
                            "Default": "",
                            "Type": "boolean",
                            "Description": "Indicates creation of the special screenshots gallery (will only create it if not already existing)."
                        }
                    ]
                },
                {
                    "MethodName": "update",
                    "Synopsis": "Updates gallery information.",
                    "HTTPMethod": "PUT",
                    "URI": "/galleries/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery to fetch"
                        },
                        {
                            "Name": "name",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A custom name for this gallery"
                        },
                        {
                            "Name": "delete",
                            "Required": "N",
                            "Default": "",
                            "Type": "boolean",
                            "Description": "Soft destroys the Gallery (undo is possible)"
                        },
                        {
                            "Name": "undo",
                            "Required": "N",
                            "Default": "",
                            "Type": "boolean",
                            "Description": "Undo a previous soft destroy call"
                        },
                        {
                            "Name": "cancel",
                            "Required": "N",
                            "Default": "",
                            "Type": "boolean",
                            "Description": "Marks the Gallery as cancelled"
                        },
                        {
                            "Name": "remove_lock",
                            "Required": "N",
                            "Default": "",
                            "Type": "boolean",
                            "Description": "Removes any password protection on the gallery"
                        }
                    ]
                },
                {
                    "MethodName": "unlock",
                    "Synopsis": "Unlocks a locked gallery.",
                    "HTTPMethod": "PUT",
                    "URI": "/galleries/:id/unlock",
                    "RequiresOAuth": "N",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery to unlock"
                        },
                        {
                            "Name": "password",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The password to unlock it with"
                        }
                    ]
                },
                {
                    "MethodName": "lock",
                    "Synopsis": "Locks a gallery.",
                    "HTTPMethod": "PUT",
                    "URI": "/galleries/:id/lock",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery to lock"
                        },
                        {
                            "Name": "password",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The password to lock it with"
                        },
                        {
                            "Name": "password_hint",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "A hint to include with the password"
                        }
                    ]
                },
                {
                    "MethodName": "destroy",
                    "Synopsis": "Deletes a Gallery (this is a \"soft delete\", so it can be undone).",
                    "HTTPMethod": "DELETE",
                    "URI": "/galleries/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery to fetch"
                        }
                    ]
                }
            ]
        },
        {
            "name": "GalleryItems",
            "methods": [
                {
                    "MethodName": "index",
                    "Synopsis": "Lists all gallery items for a gallery, sorted by date.",
                    "HTTPMethod": "GET",
                    "URI": "/gallery_items",
                    "RequiresOAuth": "N",
                    "parameters": [
                        {
                            "Name": "gallery_id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery to list items from"
                        },
                        {
                            "Name": "filter",
                            "Required": "N",
                            "Default": "",
                            "Type": "enumerated",
                            "EnumeratedList": ["", "visible", "pending", "fresh_pending", "terminal", "all"],
                            "Description": "Use a pre-defined filter. The default is typically 'visible' but when used in conjunction with the status parameter, 'all' becomes the default."
                        },
                        {
                            "Name": "status",
                            "Required": "N",
                            "Default": "",
                            "Type": "enumerated",
                            "EnumeratedList": ["incomplete", "uploaded", "processing", "complete", "cancelled", "failed", "deleted"],
                            "Description": "Query by a specific state/status. Typically best to avoid using both this parameter and the 'filter' parameter on the same request."
                        },
                        {
                            "Name": "limit",
                            "Required": "N",
                            "Default": "25",
                            "Type": "integer",
                            "Description": "The number of items to return in a page"
                        },
                        {
                            "Name": "page",
                            "Required": "N",
                            "Default": "1",
                            "Type": "integer",
                            "Description": "The page number, when requesting paginated results, minimum 1"
                        },
                        {
                            "Name": "from",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A reference to a GalleryItem to start pagination from. Can be an ID, or an integer array index (0..N). By default, one page of results will be returned with the reference GalleryItem in the middle. This can be modified using the `previous` and `next` optional parameters."
                        },
                        {
                            "Name": "previous",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "When using the `from` parameter as reference, this requests the previous page of GalleryItems, excluding the GalleryItem referenced by `from`."
                        },
                        {
                            "Name": "next",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "When using the `from` parameter as reference, this requests the next page of GalleryItems, excluding the GalleryItem referenced by `from`."
                        }
                    ]
                },
                {
                    "MethodName": "show",
                    "Synopsis": "Fetches data about a specific gallery item.",
                    "HTTPMethod": "GET",
                    "URI": "/gallery_items/:id",
                    "RequiresOAuth": "N",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery item to fetch"
                        },
                        {
                            "Name": "gallery_id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery the gallery item belongs to"
                        }
                    ]
                },
                {
                    "MethodName": "create",
                    "Synopsis": "Creates a new gallery item.",
                    "HTTPMethod": "POST",
                    "URI": "/gallery_items",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "gallery_id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery the gallery item belongs to"
                        },
                        {
                            "Name": "filename",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The complete name of the file the item will contain, including extension"
                        },
                        {
                            "Name": "size",
                            "Required": "Y",
                            "Default": "",
                            "Type": "integer",
                            "Description": "The size of the file in bytes"
                        },
                        {
                            "Name": "content_type",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The content type of the file (server will attempt to guess this if not provided)"
                        },
                        {
                            "Name": "display_name",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A display name for the file, no extension required. Defaults to the filename if not specified."
                        },
                        {
                            "Name": "asset",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The contents of the file as a multipart form upload. If uploading in chunks afterward, this parameter should be ommitted."
                        }
                    ]
                },
                {
                    "MethodName": "update",
                    "Synopsis": "Updates an existing gallery item.",
                    "HTTPMethod": "PUT",
                    "URI": "/gallery_items/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery item to update"
                        },
                        {
                            "Name": "gallery_id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery the gallery item belongs to"
                        },
                        {
                            "Name": "filename",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The complete name of the file the item will contain, including extension"
                        },
                        {
                            "Name": "size",
                            "Required": "Y",
                            "Default": "",
                            "Type": "integer",
                            "Description": "The size of the file in bytes"
                        },
                        {
                            "Name": "content_type",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The content type of the file (server will attempt to guess this if not provided)"
                        },
                        {
                            "Name": "display_name",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "A display name for the file, no extension required. Defaults to the filename if not specified."
                        },
                        {
                            "Name": "asset",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "The contents of the file as a multipart form upload. If uploading in chunks afterward, this parameter should be ommitted."
                        },
                        {
                            "Name": "complete",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value here will mark the GalleryItem as complete, all other parameters will be ignored."  
                        },
                        {
                            "Name": "cancelled",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value here will mark the GalleryItem as cancelled, all other parameters will be ignored."  
                        },
                        {
                            "Name": "failed",
                            "Required": "N",
                            "Default": "",
                            "Type": "string",
                            "Description": "Any truthy value here will mark the GalleryItem as failed, all other parameters will be ignored."  
                        }
                    ]
                },
                {
                    "MethodName": "destroy",
                    "Synopsis": "Deletes a gallery item. This is a \"soft delete\" and can be undone",
                    "HTTPMethod": "DELETE",
                    "URI": "/gallery_items/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery item"
                        }
                    ]
                },
                {
                    "MethodName": "fave",
                    "Synopsis": "Assigns favourite status to a GalleryItem for the witness",
                    "HTTPMethod": "POST",
                    "URI": "/gallery_items/:id/fave",
                    "RequiresOAuth": "N",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery item"
                        }
                    ]
                },
                {
                    "MethodName": "fave",
                    "Synopsis": "Removes favourite status from a GalleryItem for the witness",
                    "HTTPMethod": "DELETE",
                    "URI": "/gallery_items/:id/fave",
                    "RequiresOAuth": "N",
                    "parameters": [
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery item"
                        }
                    ]
                },
                {
                    "MethodName": "cancel",
                    "Synopsis": "Sets the status of all pending GalleryItems in the Gallery to cancelled.",
                    "HTTPMethod": "PUT",
                    "URI": "/galleries/:gallery_id/gallery_items/cancel",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "gallery_id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery whose items will be modified"
                        }
                    ]
                },
                {
                    "MethodName": "fail",
                    "Synopsis": "Sets the status of all pending GalleryItems in the Gallery to failed.",
                    "HTTPMethod": "PUT",
                    "URI": "/galleries/:gallery_id/gallery_items/fail",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "gallery_id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery whose items will be modified"
                        }
                    ]
                }
            ]
        },
        {
            "name": "GalleryItemChunks",
            "methods": [
                {
                    "MethodName": "show",
                    "Synopsis": "Checks for the existence of a gallery item chunk.",
                    "HTTPMethod": "GET",
                    "URI": "/gallery_items/:gallery_item_id/gallery_item_chunks/:chunk_number",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "gallery_item_id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery item the chunk belongs to"
                        },
                        {
                            "Name": "chunk_number",
                            "Required": "Y",
                            "Default": "",
                            "Type": "integer",
                            "Description": "The chunk number"
                        }
                    ]
                },
                {
                    "MethodName": "create",
                    "Synopsis": "Creates and uploads a new chunk.",
                    "HTTPMethod": "POST",
                    "URI": "/gallery_items/:gallery_item_id/gallery_item_chunks",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "gallery_item_id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery item the chunk belongs to"
                        },
                        {
                            "Name": "chunk_number",
                            "Required": "Y",
                            "Default": "",
                            "Type": "integer",
                            "Description": "The chunk number"
                        },
                        {
                            "Name": "chunk_size",
                            "Required": "Y",
                            "Default": "",
                            "Type": "integer",
                            "Description": "The size in bytes of this chunk"
                        },
                        {
                            "Name": "total_size",
                            "Required": "Y",
                            "Default": "",
                            "Type": "integer",
                            "Description": "The total size in bytes of the entire file (all chunks)"
                        }
                    ]
                }
            ]
        },
        {
            "name": "GalleryItemStyles",
            "methods": [
                {
                    "MethodName": "index",
                    "Synopsis": "Lists all possible styles items for an existing gallery item.",
                    "HTTPMethod": "GET",
                    "URI": "/gallery_items/:gallery_item_id/styles",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "gallery_item_id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery item to list styles for"
                        }
                    ]
                },
                {
                    "MethodName": "update",
                    "Synopsis": "Replaces the file for an existing gallery item style. Uploaded files must match the content type and dimension restrictions of the style.",
                    "HTTPMethod": "PUT",
                    "URI": "/gallery_items/:gallery_item_id/styles/:id",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "gallery_item_id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "string",
                            "Description": "The id of the gallery item to work with"
                        },
                        {
                            "Name": "id",
                            "Required": "Y",
                            "Default": "",
                            "Type": "enumerated",
                            "EnumeratedList": ["thumb", "preview", "preview_2x", "gallery", "gallery_2x", "large", "full", "full_2x", "small_thumbs", "midsize_thumbs", "all_thumbs", "display", "all"],
                            "Description": "The name of the style to replace. Eg. 'thumb', or 'preview'."
                        },
                        {
                            "Name": "style",
                            "Required": "Y",
                            "Default": "",
                            "Type": "file",
                            "Description": "The actual file to upload and replace"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Witness",
            "methods": [
                {
                    "MethodName": "show",
                    "Synopsis": "Displays meta data about the current witness.",
                    "HTTPMethod": "GET",
                    "URI": "/witness",
                    "RequiresOAuth": "N",
                    "parameters": [
                    ],
                    "response": {
                        "parameters": [
                            {
                                "Name": "id",
                                "Type": "string",
                                "Description": "The id of the current witness"
                            },
                            {
                                "Name": "galleries",
                                "Type": "array",
                                "Description": "An array of gallery ids that the witness has viewed"
                            },
                            {
                                "Name": "faves",
                                "Type": "array",
                                "Description": "An array of gallery item ids that the witness has set as her favourite"
                            }
                        ],
                        "examples": []
                    }
                }
            ]
        },
        {
            "name": "TrackingEvents",
            "methods": [
                {
                    "MethodName": "create",
                    "Synopsis": "Stores a tracking event. This call should use OAuth most of the time, though there are a few edge cases where it may not.",
                    "HTTPMethod": "POST",
                    "URI": "/tracking_events",
                    "RequiresOAuth": "N",
                    "parameters": [
                        {
                            "Name": "name",
                            "Required": "Y",
                            "Type": "enumerated",
                            "EnumeratedList": [
                                "waiting_list",
                                "signup",
                                "app_downloaded",
                                "gallery_shared",
                                "message_sent",
                                "email_link_clicked",
                                "pro_link_clicked",
                                "pro_requested",
                                "contact_name_changed",
                                "gallery_created",
                                "message_created",
                                "gallery_viewed",
                                "login"
                            ],
                            "Description": "The event name. Any string will be accepted here without error, but events will only be stored if they are in our accepted list."
                        },
                        {
                            "Name": "referrer_id",
                            "Type": "string",
                            "Required": "N",
                            "Description": "The the ID of the referrer of the person performing the event. Leave blank if unknown."
                        },
                        {
                            "Name": "source",
                            "Type": "string",
                            "Required": "N",
                            "Description": "The source of the event, defaults to 'direct', should match one of our known sources."
                        },
                        {
                            "Name": "properties",
                            "Type": "hash",
                            "Required": "N",
                            "Description": "A hash of additional properties to be included with the event. These can be any set of key-value pairs."
                        }
                    ]
                }
            ]
        },
        {
            "name": "Settings",
            "methods": [
                {
                    "MethodName": "show",
                    "Synopsis": "Displays the current settings for the authenticated user.",
                    "HTTPMethod": "GET",
                    "URI": "/settings",
                    "RequiresOAuth": "Y",
                    "parameters": [ ],
                    "response": {
                        "parameters": [
                            {
                                "Name": "send_delivery_confirmations",
                                "Type": "boolean",
                                "Description": "Whether the gallery delivery confirmation email is sent to the user."
                            },
                            {
                                "Name": "send_view_notifications",
                                "Type": "boolean",
                                "Description": "Whether gallery view notification emails are sent to the user."
                            },
                            {
                                "Name": "send_download_notifications",
                                "Type": "boolean",
                                "Description": "Whether gallery download notification emails are sent to the user."
                            },
                            {
                                "Name": "send_comment_notifications",
                                "Type": "boolean",
                                "Description": "Whether new comment notification emails are sent to the user."
                            }
                        ],
                        "examples": []
                    }
                },
                {
                    "MethodName": "update",
                    "Synopsis": "Updates settings for this user.",
                    "HTTPMethod": "PUT",
                    "URI": "/settings",
                    "RequiresOAuth": "Y",
                    "parameters": [
                        {
                            "Name": "send_delivery_confirmations",
                            "Required": "N",
                            "Type": "boolean",
                            "Description": "Whether the gallery delivery confirmation email is sent to the user."
                        },
                        {
                            "Name": "send_view_notifications",
                            "Required": "N",
                            "Type": "boolean",
                            "Description": "Whether gallery view notification emails are sent to the user."
                        },
                        {
                            "Name": "send_download_notifications",
                            "Required": "N",
                            "Type": "boolean",
                            "Description": "Whether gallery download notification emails are sent to the user."
                        },
                        {
                            "Name": "send_comment_notifications",
                            "Required": "N",
                            "Type": "boolean",
                            "Description": "Whether new comment notification emails are sent to the user."
                        }
                    ]
                }
            ]
        }
    ]
}