http://git-wip-us.apache.org/repos/asf/usergrid/blob/867060fa/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Application.php ---------------------------------------------------------------------- diff --git a/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Application.php b/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Application.php new file mode 100644 index 0000000..0054a8c --- /dev/null +++ b/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Application.php @@ -0,0 +1,979 @@ +<?php +/** + * Copyright 2010-2014 baas-platform.com, Pty Ltd. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * A copy of the License is located at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * or in the "license" file accompanying this file. This file is distributed + * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either + * express or implied. See the License for the specific language governing + * permissions and limitations under the License. + */ + +return [ + + 'AuthPasswordGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/token', + 'notes' => 'Get the app access token. See the OAuth2 specification for details.', + 'summary' => 'Get app access token', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'grant_type' => [ + 'description' => 'Grant type.', + 'location' => 'query', + 'type' => 'string', + 'defaultValue' => 'password', + 'required' => true, + ], + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'username' => [ + 'description' => 'Username (for grant_type=password).', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'password' => [ + 'description' => 'Password (for grant_type=password).', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'client_id' => [ + 'description' => 'Client ID (for grant_type=client_credentials).', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'client_secret' => [ + 'description' => 'Client Secret (for grant_type=client_credentials).', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'AuthPasswordPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/token', + 'notes' => 'Get the app access token. See the OAuth2 specification for details.', + 'summary' => 'Get app access token', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'grant_type' => [ + 'description' => 'Grant type.', + 'location' => 'postField', + 'type' => 'string', + 'defaultValue' => 'password', + 'required' => true, + ], + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'username' => [ + 'description' => 'Username (for grant_type=password).', + 'location' => 'postField', + 'type' => 'string', + 'required' => false, + ], + 'password' => [ + 'description' => 'Password (for grant_type=password).', + 'location' => 'postField', + 'type' => 'string', + 'required' => false, + ], + 'client_id' => [ + 'description' => 'Client ID (for grant_type=client_credentials).', + 'location' => 'postField', + 'type' => 'string', + 'required' => false, + ], + 'client_secret' => [ + 'description' => 'Client Secret (for grant_type=client_credentials).', + 'location' => 'postField', + 'type' => 'string', + 'required' => false, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'AuthorizeGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/authorize', + 'notes' => 'Authorize the app client. See the OAuth2 specification.', + 'summary' => 'Authorize app client', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => false, + ], + 'response_type' => [ + 'description' => 'Response type', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + 'default' => 'token' + ], + 'redirect_uri' => [ + 'description' => 'Redirect URI', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'client_id' => [ + 'description' => 'Client ID', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'scope' => [ + 'description' => 'Access Token Scope.', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'state' => [ + 'description' => 'Client State.', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'AuthorizePost' => [ + 'httpMethod' => 'POST', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/authorize', + 'notes' => 'Authorize the app client. See the OAuth2 specification.', + 'summary' => 'Authorize app client', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => false, + ], + 'response_type' => [ + 'description' => 'Response type', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + 'default' => 'token' + ], + 'redirect_uri' => [ + 'description' => 'Redirect URI', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'client_id' => [ + 'description' => 'Client ID', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'scope' => [ + 'description' => 'Access Token Scope.', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'state' => [ + 'description' => 'Client State.', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'CredentialsGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/credentials', + 'notes' => 'Get the app client credentials.', + 'summary' => 'Get app client credentials', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => false, + ], + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'CredentialsPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/credentials', + 'notes' => 'Generate new app client credentials', + 'summary' => 'Generate app client credentials', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => false, + ], + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'UserJsonPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/users', + 'notes' => 'Create new app user', + 'summary' => 'Create new app user. See Usergrid documentation for JSON format of body.', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => false, + ], + 'username' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Username' + ], + 'name' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Name' + ], + 'email' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Email' + ], + 'password' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Password' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'UserFormPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/users', + 'notes' => 'Create new app user', + 'summary' => 'Create new app user using form post parameters.', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => false, + ], + 'username' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Username' + ], + 'name' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Name' + ], + 'email' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Email' + ], + 'password' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Password' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'UserPasswordRestGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/users/resetpw', + 'notes' => 'Initiate a user password reset. Returns browser-viewable HTML page.', + 'summary' => 'Initiate a user password reset', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'UserPasswordFormPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/users/resetpw', + 'notes' => 'Complete a user password reset. Handles form POST response.', + 'summary' => 'Complete a user password reset', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'email' => [ + 'description' => 'User Email', + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + ], + 'recaptcha_challenge_field' => [ + 'description' => 'Recaptcha Challenge Field', + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + ], + 'recaptcha_response_field' => [ + 'description' => 'Recaptcha Response Field', + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'UserGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/users/{user_username_email_or_uuid}', + 'notes' => 'Returns the app user details.', + 'summary' => 'Returns the app user details', + 'responseClass' => 'Apache\Usergrid\Api\Models\User', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'access_token' => [ + 'description' => 'The OAuth2 access token', + 'location' => 'query', + 'type' => 'string', + 'required' => true, + ], + 'user_username_email_or_uuid' => [ + 'description' => 'User username, email or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'UserJsonPut' => [ + 'httpMethod' => 'PUT', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/users/{user_username_email_or_uuid}', + 'notes' => 'Updates the app user details.', + 'summary' => 'Updates the app user details', + 'responseClass' => 'Apache\Usergrid\Api\Models\User', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'access_token' => [ + 'description' => 'The OAuth2 access token', + 'location' => 'query', + 'type' => 'string', + 'required' => true, + ], + 'user_username_email_or_uuid' => [ + 'description' => 'User username, email or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ], + 'additionalParameters' => [ + 'location' => 'json' + ] + ], + 'UserActivateGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/users/{user_username_email_or_uuid}/activate', + 'notes' => 'Activates the app user from link provided in email notification.', + 'summary' => 'Activates the app user', + 'responseClass' => 'Apache\Usergrid\Api\Models\User', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'token' => [ + 'description' => 'Activation Token (supplied via email)', + 'location' => 'query', + 'type' => 'string', + 'required' => true, + ], + 'user_username_email_or_uuid' => [ + 'description' => 'User username, email or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'confirm' => [ + 'description' => 'Send confirmation email', + 'location' => 'query', + 'type' => 'boolean', + 'required' => true, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'UserReactivateGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/users/{user_username_email_or_uuid}/reactivate', + 'notes' => 'Request app user reactivation.', + 'summary' => 'Reactivates the app user', + 'responseClass' => 'Apache\Usergrid\Api\Models\User', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'user_username_email_or_uuid' => [ + 'description' => 'User username, email or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'UserFeedGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/users/{user_username_email_or_uuid}/feed', + 'notes' => 'Get app user activity feed.', + 'summary' => 'Get app user activity feed', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'user_username_email_or_uuid' => [ + 'description' => 'User username, email or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'access_token' => [ + 'description' => 'The OAuth2 access token', + 'location' => 'query', + 'type' => 'string', + 'required' => true, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'UserPasswordJsonPut' => [ + 'httpMethod' => 'PUT', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/users/{user_username_email_or_uuid}/password', + 'notes' => 'Set app user password. See Usergrid documentation for JSON format of body.', + 'summary' => 'Set app user password', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'user_username_email_or_uuid' => [ + 'description' => 'User username, email or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'access_token' => [ + 'description' => 'The OAuth2 access token', + 'location' => 'query', + 'type' => 'string', + 'required' => true, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ], + 'additionalParameters' => [ + "description" => "Old and new password", + 'location' => 'json' + ] + ], + 'UserResetPasswordGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/users/{user_username_email_or_uuid}/resetpw', + 'notes' => 'Initiate a user password reset. Returns browser-viewable HTML page.', + 'summary' => 'Initiate a user password reset', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'user_username_email_or_uuid' => [ + 'description' => 'User username, email or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'UserResetPasswordFormPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/users/{user_username_email_or_uuid}/resetpw', + 'notes' => 'Complete a user password reset. Handles form POST response.', + 'summary' => 'Complete a user password reset', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'user_username_email_or_uuid' => [ + 'description' => 'User username, email or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'recaptcha_challenge_field' => [ + 'description' => 'Recaptcha Challenge Field', + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + ], + 'recaptcha_response_field' => [ + 'description' => 'Recaptcha Response Field', + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'EntityGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}', + 'notes' => 'Query an app collection.', + 'summary' => 'Query an app collection', + 'responseClass' => 'Apache\Usergrid\Api\Models\Collection', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ], + 'collection' => [ + 'description' => 'collection name (entity type)', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'access_token' => [ + 'description' => 'The OAuth2 access token', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'ql' => [ + 'description' => 'a query in the query language', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'reversed' => [ + 'description' => 'return results in reverse order', + 'location' => 'query', + 'type' => 'boolean', + 'required' => false, + ], + 'start' => [ + 'description' => 'the first entity UUID to return', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'cursor' => [ + 'description' => 'an encoded representation of the query position for paging', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'limit' => [ + 'description' => 'an encoded representation of the query position for paging', + 'location' => 'query', + 'type' => 'integer', + 'required' => false, + ], + 'filter' => [ + 'description' => 'a condition to filter on', + 'location' => 'query', + 'type' => 'integer', + 'required' => false, + ] + ], + 'additionalParameters' => [ + "description" => "Other parameters", + 'location' => 'query' + ] + ], + 'EntityJsonPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}', + 'notes' => 'Create new app entity. See Usergrid documentation for JSON format of body.', + 'summary' => 'Create new app entity', + 'responseClass' => 'Apache\Usergrid\Api\Models\Entity', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'collection' => [ + 'description' => 'collection name (entity type)', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'access_token' => [ + 'description' => 'The OAuth2 access token', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ], + 'additionalParameters' => [ + "description" => "Entity data", + 'location' => 'json' + ] + ], + 'EntityPut' => [ + 'httpMethod' => 'PUT', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}/{entity_name_or_uuid}', + 'notes' => 'Update an app entity in a collection.', + 'summary' => 'Update an app entity', + 'responseClass' => 'Apache\Usergrid\Api\Models\Entity', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'entity_name_or_uuid' => [ + 'description' => 'entity name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'collection' => [ + 'description' => 'collection name (entity type)', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'access_token' => [ + 'description' => 'The OAuth2 access token', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ], + 'additionalParameters' => [ + "description" => "Entity data", + 'location' => 'json' + ] + ], + 'EntityDelete' => [ + 'httpMethod' => 'DELETE', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}/{entity_name_or_uuid}', + 'notes' => 'Delete an app entity.', + 'summary' => 'Delete an app entity', + 'responseClass' => 'Apache\Usergrid\Api\Models\Entity', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'entity_name_or_uuid' => [ + 'description' => 'entity name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'collection' => [ + 'description' => 'collection name (entity type)', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'access_token' => [ + 'description' => 'The OAuth2 access token', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'PostEvents' => [ + 'httpMethod' => 'POST', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}', + 'notes' => 'Create new app entity. See Usergrid documentation for JSON format of body.', + 'summary' => 'Create new app entity', + 'responseClass' => 'Apache\Usergrid\Api\Models\Event', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'collection' => [ + 'description' => 'collection name (entity type)', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'access_token' => [ + 'description' => 'The OAuth2 access token', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ], + 'additionalParameters' => [ + "description" => "Entity data", + 'location' => 'json' + ] + ], + + +]; \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/usergrid/blob/867060fa/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Errors.php ---------------------------------------------------------------------- diff --git a/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Errors.php b/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Errors.php new file mode 100644 index 0000000..603d60f --- /dev/null +++ b/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Errors.php @@ -0,0 +1,53 @@ +<?php +/** + * Copyright 2010-2014 baas-platform.com, Pty Ltd. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * A copy of the License is located at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * or in the "license" file accompanying this file. This file is distributed + * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either + * express or implied. See the License for the specific language governing + * permissions and limitations under the License. + */ + + +return [ + + [ + 'class' => 'Apache\Usergrid\Api\Exception\BadRequestException', + 'code' => 400, + ], + [ + 'class' => 'Apache\Usergrid\Api\Exception\UnauthorizedException', + 'code' => 401, + ], + [ + 'class' => 'Apache\Usergrid\Api\Exception\RequestFailedException', + 'code' => 402, + ], + [ + 'class' => 'Apache\Usergrid\Api\Exception\NotFoundException', + 'code' => 404, + ], + [ + 'class' => 'Apache\Usergrid\Api\Exception\ServerErrorException', + 'code' => 500, + ], + [ + 'class' => 'Apache\Usergrid\Api\Exception\ServerErrorException', + 'code' => 502, + ], + [ + 'class' => 'Apache\Usergrid\Api\Exception\ServerErrorException', + 'code' => 503, + ], + [ + 'class' => 'Apache\Usergrid\Api\Exception\ServerErrorException', + 'code' => 504, + ], + +]; http://git-wip-us.apache.org/repos/asf/usergrid/blob/867060fa/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Management.php ---------------------------------------------------------------------- diff --git a/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Management.php b/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Management.php new file mode 100644 index 0000000..e59154d --- /dev/null +++ b/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Management.php @@ -0,0 +1,1076 @@ +<?php +/** + * Copyright 2010-2014 baas-platform.com, Pty Ltd. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * A copy of the License is located at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * or in the "license" file accompanying this file. This file is distributed + * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either + * express or implied. See the License for the specific language governing + * permissions and limitations under the License. + */ + +return [ + + 'AuthPasswordGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/token', + 'summary' => 'Get management access token', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'grant_type' => [ + 'description' => 'Grant type.', + 'location' => 'query', + 'type' => 'string', + 'defaultValue' => 'password', + 'required' => true, + ], + 'username' => [ + 'description' => 'Username (for grant_type=password).', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'password' => [ + 'description' => 'Password (for grant_type=password).', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'client_id' => [ + 'description' => 'Client ID (for grant_type=client_credentials).', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'client_secret' => [ + 'description' => 'Client Secret (for grant_type=client_credentials).', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ] + ] + ], + 'AuthorizeGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/authorize', + 'summary' => 'Authorize the client. See the OAuth2 specification.', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'response_type' => [ + 'description' => 'Response type.', + 'location' => 'query', + 'type' => 'string', + 'defaultValue' => 'token', + 'required' => true, + 'allowableValues' => ['code', 'token'] + ], + 'client_id' => [ + 'description' => 'Client ID.', + 'location' => 'query', + 'type' => 'string', + 'required' => true, + ], + 'redirect_uri' => [ + 'description' => 'Redirect URI.', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'scope' => [ + 'description' => 'Access Token Scope.', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'state' => [ + 'description' => 'Client State.', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ] + ] + + ], + 'OrgJsonPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/management/orgs', + 'summary' => 'Create new organization. See Usergrid documentation for JSON format of body.', + 'responseClass' => 'Apache\Usergrid\Api\Models\Organization', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'organization' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization Name' + ], + 'username' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Username' + ], + 'name' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Name' + ], + 'email' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Email' + ], + 'password' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Password' + ] + ], + 'additionalParameters' => [ + 'location' => 'json' + ] + ], + 'OrgGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/orgs/{org_name_or_uuid}', + 'summary' => 'Find organization by name or UUID', + 'responseClass' => 'Apache\Usergrid\Api\Models\Organization', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'OrgActivateGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/orgs/{org_name_or_uuid}/activate', + 'summary' => 'Activates the organization', + 'responseClass' => 'Apache\Usergrid\Api\Models\Organization', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ], + 'token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'confirm' => [ + 'location' => 'query', + 'type' => 'boolean', + 'required' => false, + 'description' => 'Send confirmation email' + ] + + ] + ], + 'OrgReactivateGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/orgs/{org_name_or_uuid}/reactivate', + 'summary' => 'Reactivates the organization', + 'responseClass' => 'Apache\Usergrid\Api\Models\Organization', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ], + ] + ], + 'OrgFeedGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/orgs/{org_name_or_uuid}/feed', + 'summary' => 'Get organization activity feed', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'OrgCredentialsGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/orgs/{org_name_or_uuid}/credentials', + 'summary' => 'Get organization client credentials', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'OrgCredentialsPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/management/orgs/{org_name_or_uuid}/credentials', + 'summary' => 'Generate organization client credentials', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'OrgUsersGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/orgs/{org_name_or_uuid}/users', + 'summary' => 'Get admin users for organization', + 'responseClass' => 'Apache\Usergrid\Api\Models\User', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'OrgUsersJsonPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/management/orgs/{org_name_or_uuid}/users', + 'summary' => 'Create new admin user for organization using JSON payload.', + 'responseClass' => 'Apache\Usergrid\Api\Models\User', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ], + 'username' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Username' + ], + 'name' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Name' + ], + 'email' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Email' + ], + 'password' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Password' + ] + ], + 'additionalParameters' => [ + 'location' => 'json' + ] + ], + 'OrgUsersFormPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/management/orgs/{org_name_or_uuid}/users', + 'summary' => 'Create new admin user for organization using form parameters.', + 'responseClass' => 'Apache\Usergrid\Api\Models\User', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ], + 'username' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Username' + ], + 'name' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Name' + ], + 'email' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Email' + ], + 'password' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Password' + ] + ], + 'additionalParameters' => [ + 'location' => 'postField' + ] + ], + 'OrgUserPut' => [ + 'httpMethod' => 'PUT', + 'uri' => '/management/orgs/{org_name_or_uuid}/users/{user_username_email_or_uuid}', + 'summary' => 'Adds existing admin users for organization.', + 'responseClass' => 'Apache\Usergrid\Api\Models\User', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ], + 'user_username_email_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin user username, email, or uuid' + ] + ] + ], + 'OrgUserDelete' => [ + 'httpMethod' => 'DELETE', + 'uri' => '/management/orgs/{org_name_or_uuid}/users/{user_username_email_or_uuid}', + 'summary' => 'Remove an admin user from organization.', + 'responseClass' => 'Apache\Usergrid\Api\Models\User', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ], + 'user_username_email_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin user username, email, or uuid' + ] + ] + ], + 'OrgAppsGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/orgs/{org_name_or_uuid}/apps', + 'summary' => 'Get apps for organization', + 'responseClass' => 'Apache\Usergrid\Api\Models\Application', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'OrgAppsJsonPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/management/orgs/{org_name_or_uuid}/apps', + 'summary' => 'Create new application for organization using JSON payload.', + 'responseClass' => 'Apache\Usergrid\Api\Models\Application', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ], + 'name' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Application Name' + ] + ], + 'additionalParameters' => [ + 'location' => 'json' + ] + ], + 'OrgAppsFormPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/management/orgs/{org_name_or_uuid}/apps', + 'summary' => 'Create new application for organization using form parameters.', + 'responseClass' => 'Apache\Usergrid\Api\Models\Application', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ], + 'name' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Application Name' + ] + ], + 'additionalParameters' => [ + 'location' => 'postField' + ] + ], + 'OrgAppDelete' => [ + 'httpMethod' => 'DELETE', + 'uri' => '/management/orgs/{org_name_or_uuid}/apps/{app_name_or_uuid}', + 'summary' => 'Delete an application in an organization.', + 'responseClass' => 'Apache\Usergrid\Api\Models\Application', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ], + 'app_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Application name or uuid' + ] + ] + ], + 'OrgAppCredentialsGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/orgs/{org_name_or_uuid}/apps/{app_name_or_uuid}/credentials', + 'summary' => 'Get application keys.', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ], + 'app_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Application name or uuid' + ] + ] + ], + 'OrgAppCredentialsPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/management/orgs/{org_name_or_uuid}/apps/{app_name_or_uuid}/credentials', + 'summary' => 'Generate application keys.', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ], + 'app_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Application name or uuid' + ] + ] + ], + 'OrgUserJsonPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/management/users', + 'summary' => 'Create new admin user. See Usergrid documentation for JSON format of body.', + 'responseClass' => 'Apache\Usergrid\Api\Models\User', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'username' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Username' + ], + 'name' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Name' + ], + 'email' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Email' + ], + 'password' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Password' + ] + ], + 'additionalParameters' => [ + 'location' => 'json' + ] + ], + 'OrgUserFormPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/management/users', + 'summary' => 'Create new admin using form post parameters.', + 'responseClass' => 'Apache\Usergrid\Api\Models\User', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'username' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Username' + ], + 'name' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Name' + ], + 'email' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Email' + ], + 'password' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Password' + ] + ], + 'additionalParameters' => [ + 'location' => 'postField' + ] + + ], + 'OrgUserResetPasswordGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/users/resetpw', + 'summary' => 'Initiate a user password reset. Returns browser-viewable HTML page.', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + ], + 'OrgUserResetPasswordFormPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/management/users/resetpw', + 'summary' => 'Complete a user password reset. Handles form POST response.', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'email' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin Email' + ], + 'recaptcha_challenge_field' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Recaptcha Challenge Field' + ], + 'recaptcha_response_field' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Recaptcha Response Field' + ], + ] + ], + 'AdminUserGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/users/{user_username_email_or_uuid}', + 'summary' => 'Returns the admin user details', + 'responseClass' => 'Apache\Usergrid\Api\Models\User', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'user_username_email_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin username, email or uuid' + ], + ] + + ], + 'AdminUserJsonPut' => [ + 'httpMethod' => 'PUT', + 'uri' => '/management/users/{user_username_email_or_uuid}', + 'summary' => 'Updates the admin user details.', + 'responseClass' => 'Apache\Usergrid\Api\Models\User', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'user_username_email_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin username, email or uuid' + ], + ], + 'additionalParameters' => [ + 'location' => 'json' + ] + + ], + 'AdminUserActivateGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/users/{user_username_email_or_uuid}/activate', + 'summary' => 'Activates the admin user from link provided in email notification.', + 'responseClass' => 'Apache\Usergrid\Api\Models\User', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'user_username_email_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin username, email or uuid' + ], + 'confirm' => [ + 'location' => 'uri', + 'type' => 'boolean', + 'required' => false, + 'description' => 'Send confirmation email' + ], + ] + ], + 'AdminUserReactivateGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/users/{user_username_email_or_uuid}/reactivate', + 'summary' => 'Request admin user reactivation.', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'user_username_email_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin username, email or uuid' + ] + ] + ], + 'AdminUserFeedGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/users/{user_username_email_or_uuid}/feed', + 'summary' => 'Get admin user activity feed.', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'user_username_email_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin username, email or uuid' + ], + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + ] + ], + 'AdminUserPasswordJsonPut' => [ + 'httpMethod' => 'PUT', + 'uri' => '/management/users/{user_username_email_or_uuid}/password', + 'summary' => 'Set admin user password. See Usergrid documentation for JSON format of body.', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'user_username_email_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin username, email or uuid' + ], + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'old_password' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Old and new password' + ], + 'new_password' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Old and new password' + ], + ] + ], + 'AdminUserResetPasswordGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/users/{user_username_email_or_uuid}/resetpw', + 'summary' => 'Initiate a user password reset. Returns browser-viewable HTML page.', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'user_username_email_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin username, email or uuid' + ] + ] + ], + 'AdminUserResetPasswordFormPost' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/users/{user_username_email_or_uuid}/resetpw', + 'summary' => 'Complete a user password reset. Handles form POST response.', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'user_username_email_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin username, email or uuid' + ], + 'recaptcha_challenge_field' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Recaptcha Challenge Field' + ], + 'recaptcha_response_field' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Recaptcha Response Field' + ] + ] + ], + 'AdminUserOrgsGet' => [ + 'httpMethod' => 'GET', + 'uri' => '/management/users/{user_username_email_or_uuid}/orgs', + 'summary' => 'Get organizations for admin user.', + 'responseClass' => 'Apache\Usergrid\Api\Models\Organization', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'user_username_email_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin username, email or uuid' + ], + + ] + ], + 'AdminUserOrgsJsonPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/management/users/{user_username_email_or_uuid}/orgs', + 'summary' => 'Create new organization for admin user using JSON payload.', + 'responseClass' => 'Apache\Usergrid\Api\Models\Organization', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'user_username_email_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin username, email or uuid' + ], + 'organization' => [ + 'location' => 'json', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin username, email or uuid' + ], + + ], + 'additionalParameters' => [ + 'location' => 'json' + ] + ], + 'AdminUserOrgsFormPost' => [ + 'httpMethod' => 'POST', + 'uri' => '/management/users/{user_username_email_or_uuid}/orgs', + 'summary' => 'Create new organization for admin user using form parameters.', + 'responseClass' => 'Apache\Usergrid\Api\Models\Organization', + 'responseType' => 'class', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'user_username_email_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin username, email or uuid' + ], + 'organization' => [ + 'location' => 'postField', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin username, email or uuid' + ], + + ], + 'additionalParameters' => [ + 'location' => 'postField' + ] + ], + 'AdminUserOrgPut' => [ + 'httpMethod' => 'PUT', + 'uri' => '/management/users/{user_username_email_or_uuid}/orgs/{org_name_or_uuid}', + 'summary' => 'Add admin users to organization.', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'user_username_email_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin username, email or uuid' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ], + + ], + 'additionalParameters' => [ + 'location' => 'json' + ] + ], + 'AdminUserOrgDelete' => [ + 'httpMethod' => 'DELETE', + 'uri' => '/management/users/{user_username_email_or_uuid}/orgs/{org_name_or_uuid}', + 'summary' => 'Remove an admin user from organization.', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'location' => 'query', + 'type' => 'string', + 'required' => true, + 'description' => 'The OAuth2 access token' + ], + 'user_username_email_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Admin username, email or uuid' + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ], + + ] + ] + +]; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/usergrid/blob/867060fa/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Manifest.php ---------------------------------------------------------------------- diff --git a/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Manifest.php b/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Manifest.php new file mode 100644 index 0000000..0a16a62 --- /dev/null +++ b/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Manifest.php @@ -0,0 +1,25 @@ +<?php +/** + * Copyright 2010-2014 baas-platform.com, Pty Ltd. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * A copy of the License is located at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * or in the "license" file accompanying this file. This file is distributed + * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either + * express or implied. See the License for the specific language governing + * permissions and limitations under the License. + */ + +return [ + + 'name' => 'Usergrid', + 'apiVersion' => '1.0.0', + // 'baseUrl' => 'http://localhost:8080', + 'baseUrl' => $baseURL, + 'description' => 'Client to Usergrid application service', + 'operations' => [] +]; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/usergrid/blob/867060fa/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Notification.php ---------------------------------------------------------------------- diff --git a/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Notification.php b/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Notification.php new file mode 100644 index 0000000..0606eb2 --- /dev/null +++ b/sdks/other/php5/apache-usergrid/src/Manifests/1.0.0/Notification.php @@ -0,0 +1,154 @@ +<?php +/** + * Copyright 2010-2014 baas-platform.com, Pty Ltd. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * A copy of the License is located at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * or in the "license" file accompanying this file. This file is distributed + * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either + * express or implied. See the License for the specific language governing + * permissions and limitations under the License. + */ + +return [ + 'ToGroup' => [ + 'httpMethod' => 'POST', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/groups/{group}/notifications', + 'notes' => 'Create Notification for group. See Usergrid documentation for JSON format of body.', + 'summary' => 'Create new app notification', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'description' => 'The OAuth2 access token', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ], + 'group' => [ + 'description' => 'group name', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + + ] + ], + 'ToDevice' => [ + 'httpMethod' => 'POST', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/devices/{device_uuid}/notifications', + 'notes' => 'Create Notification for single Device. See Usergrid documentation for JSON format of body.', + 'summary' => 'Create new app notification', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'description' => 'The OAuth2 access token', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ], + 'device_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'device name or uuid' + ], + + ] + ], + 'ToDevices' => [ + 'httpMethod' => 'POST', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/devices/*/notifications', + 'notes' => 'Create Notification all Devices. See Usergrid documentation for JSON format of body.', + 'summary' => 'Create new app notification', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'description' => 'The OAuth2 access token', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ] + ] + ], + 'ToUser' => [ + 'httpMethod' => 'POST', + 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/users/{user_name}/notifications', + 'notes' => 'Create Notification single User. See Usergrid documentation for JSON format of body.', + 'summary' => 'Create new app notification', + 'responseClass' => '', + 'responseType' => 'object', + 'errorResponses' => $errors, + 'parameters' => [ + 'access_token' => [ + 'description' => 'The OAuth2 access token', + 'location' => 'query', + 'type' => 'string', + 'required' => false, + ], + 'app_name_or_uuid' => [ + 'description' => 'app name or uuid', + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + ], + 'org_name_or_uuid' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'Organization name or uuid' + ], + 'user_name' => [ + 'location' => 'uri', + 'type' => 'string', + 'required' => true, + 'description' => 'User name or uuid' + ], + ] + ] +]; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/usergrid/blob/867060fa/sdks/other/php5/apache-usergrid/src/Manifests/1.0.1/Activities.php ---------------------------------------------------------------------- diff --git a/sdks/other/php5/apache-usergrid/src/Manifests/1.0.1/Activities.php b/sdks/other/php5/apache-usergrid/src/Manifests/1.0.1/Activities.php new file mode 100644 index 0000000..a51055f --- /dev/null +++ b/sdks/other/php5/apache-usergrid/src/Manifests/1.0.1/Activities.php @@ -0,0 +1,24 @@ +<?php +/** + * Copyright 2010-2014 baas-platform.com, Pty Ltd. or its affiliates. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"). + * You may not use this file except in compliance with the License. + * A copy of the License is located at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * or in the "license" file accompanying this file. This file is distributed + * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either + * express or implied. See the License for the specific language governing + * permissions and limitations under the License. + */ + +return [ + + 'all' => [], + 'find' => [], + 'create' => [], + 'destroy' => [], + 'update' => [] +]; \ No newline at end of file
