{"name":"hipchat-sns-bridge","organization":{"key":"teambytes"},"application":{"key":"hipchat-sns-bridge"},"namespace":"com.teambytes.hipchat.sns.bridge.v1","version":"1.0.0","info":{},"headers":[],"imports":[],"enums":[{"name":"hipchat_scope","plural":"hipchat_scopes","values":[{"name":"send_message","attributes":[]},{"name":"send_notification","attributes":[]}],"attributes":[],"description":"Your add-on must declare the scopes it requires based on which API endpoints it needs to use, via its descriptor."}],"interfaces":[],"unions":[],"models":[{"name":"error","plural":"errors","fields":[{"name":"description","type":"string","required":true,"attributes":[],"annotations":[]}],"attributes":[],"interfaces":[],"description":"A request semantic failure reason."},{"name":"hipchat_api_consumer","plural":"hipchat_api_consumers","fields":[{"name":"scopes","type":"[hipchat_scope]","required":true,"attributes":[],"annotations":[],"description":"An array of scopes that are required to consume the HipChat API."},{"name":"fromName","type":"string","required":false,"attributes":[],"annotations":[],"description":"The name that messages should be from when sent from the integration itself."}],"attributes":[],"interfaces":[]},{"name":"hipchat_capabilities","plural":"hipchat_capabilities","fields":[{"name":"configurable","type":"hipchat_configuration_page","required":false,"attributes":[],"annotations":[],"description":"Most integrations will need to be configured in order to work correctly. For this purpose, an integration can expose a 'configurable' capability that provides an HTML page to be included as a panel in the configuration dialog."},{"name":"hipchatApiConsumer","type":"hipchat_api_consumer","required":false,"attributes":[],"annotations":[],"description":"The ability to consume the HipChat API."},{"name":"installable","type":"hipchat_installable","required":false,"attributes":[],"annotations":[],"description":"The capability of receiving a synchronous installation callback during integration installation."},{"name":"oauth2Provider","type":"hipchat_oauth2_provider","required":false,"attributes":[],"annotations":[],"description":"The capability of providing and accepting OAuth 2 tokens for authentication."}],"attributes":[],"interfaces":[]},{"name":"hipchat_capabilities_descriptor","plural":"hipchat_capabilities_descriptors","fields":[{"name":"name","type":"string","required":true,"attributes":[],"annotations":[],"description":"The display name of this application."},{"name":"description","type":"string","required":true,"attributes":[],"annotations":[],"description":"A short description of this application."},{"name":"key","type":"string","required":true,"attributes":[],"annotations":[],"description":"The marketplace integration key that uniquely identifies the application, if registered."},{"name":"apiVersion","type":"string","required":false,"attributes":[],"annotations":[],"description":"The HipChat Connect API version used by this integration. Defaults to 1:1."},{"name":"capabilities","type":"hipchat_capabilities","required":false,"attributes":[],"annotations":[],"description":"The set of capabilities this application supports."},{"name":"links","type":"hipchat_links","required":true,"attributes":[],"annotations":[],"description":"URLs to retrieve this and related integration information."},{"name":"vendor","type":"hipchat_vendor","required":false,"attributes":[],"annotations":[],"description":"The vendor that maintains this application."}],"attributes":[],"interfaces":[]},{"name":"hipchat_configuration_page","plural":"hipchat_configuration_pages","fields":[{"name":"allowAccessToRoomAdmins","type":"string","required":false,"attributes":[],"annotations":[],"description":"If the add-on is installed globally, this property can allow the configuration page to be accessed in the room administration pages making it possible to have room specific configuration for the global add-on. This is only valid for globally installed add-ons."},{"name":"url","type":"string","required":true,"attributes":[],"annotations":[],"description":"The URL to embed into a configure dialog via an iframe."}],"attributes":[],"interfaces":[]},{"name":"hipchat_install_data","plural":"hipchat_install_data","fields":[{"name":"capabilitiesUrl","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"oauthId","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"oauthSecret","type":"string","required":true,"attributes":[],"annotations":[]},{"name":"groupId","type":"long","required":true,"attributes":[],"annotations":[]},{"name":"roomId","type":"string","required":false,"attributes":[],"annotations":[]}],"attributes":[],"interfaces":[]},{"name":"hipchat_installable","plural":"hipchat_installables","fields":[{"name":"callbackUrl","type":"string","required":false,"attributes":[],"annotations":[],"description":"The URL to receive a confirmation of an integration installation."},{"name":"installedUrl","type":"string","required":false,"attributes":[],"annotations":[],"description":"The URL HipChat will redirect to post-installation."},{"name":"allowGlobal","type":"boolean","required":false,"attributes":[],"annotations":[],"description":"Whether the integration can be installed globally or not."},{"name":"allowRoom","type":"boolean","required":false,"attributes":[],"annotations":[],"description":"Whether the integration can be installed in a room or not."}],"attributes":[],"interfaces":[]},{"name":"hipchat_links","plural":"hipchat_linkses","fields":[{"name":"homepage","type":"string","required":false,"attributes":[],"annotations":[],"description":"The URL to human-viewable home page of this integration."},{"name":"api","type":"string","required":false,"attributes":[],"annotations":[],"description":"The URL to the REST API root."},{"name":"self","type":"string","required":true,"attributes":[],"annotations":[],"description":"The URL to this descriptor."}],"attributes":[],"interfaces":[]},{"name":"hipchat_oauth2_provider","plural":"hipchat_oauth2_providers","fields":[{"name":"tokenUrl","type":"string","required":false,"attributes":[],"annotations":[],"description":"The OAuth 2 token endpoint for retrieving an access token."},{"name":"authorizationUrl","type":"string","required":false,"attributes":[],"annotations":[],"description":"The OAuth 2 endpoint to direct browsers to in order to receive an authorization code that can be later exchanged using the token URL for an access token."}],"attributes":[],"interfaces":[]},{"name":"hipchat_vendor","plural":"hipchat_vendors","fields":[{"name":"name","type":"string","required":true,"attributes":[],"annotations":[],"description":"The vendor display name."},{"name":"url","type":"string","required":true,"attributes":[],"annotations":[],"description":"The vendor's home page URL."}],"attributes":[],"interfaces":[]},{"name":"service_info","plural":"service_info","fields":[{"name":"name","type":"string","required":true,"attributes":[],"annotations":[],"description":"Name of this service."},{"name":"version","type":"string","required":true,"attributes":[],"annotations":[],"description":"Version of this service."},{"name":"scala_version","type":"string","required":true,"attributes":[],"annotations":[],"description":"Version of Scala this service is using."},{"name":"sbt_version","type":"string","required":true,"attributes":[],"annotations":[],"description":"Version of SBT used to build this service."},{"name":"build_time","type":"date-time-iso8601","required":true,"attributes":[],"annotations":[],"description":"Time the service was built at."}],"attributes":[],"interfaces":[]},{"name":"sns_notification","plural":"sns_notifications","fields":[{"name":"Type","type":"string","required":true,"attributes":[],"annotations":[],"description":"The type of message. For a unsubscribe confirmation, the type is UnsubscribeConfirmation."},{"name":"MessageId","type":"string","required":true,"attributes":[],"annotations":[],"description":"A Universally Unique Identifier, unique for each message published. For a message that Amazon SNS resends during a retry, the message ID of the original message is used."},{"name":"TopicArn","type":"string","required":true,"attributes":[],"annotations":[],"description":"The Amazon Resource Name (ARN) for the topic that this endpoint has been unsubscribed from."},{"name":"Message","type":"string","required":true,"attributes":[],"annotations":[],"description":"A string that describes the message."},{"name":"Timestamp","type":"string","required":true,"attributes":[],"annotations":[],"description":"The time (GMT) when the unsubscribe confirmation was sent."},{"name":"SignatureVersion","type":"string","required":true,"attributes":[],"annotations":[],"description":"Version of the Amazon SNS signature used."},{"name":"Signature","type":"string","required":true,"attributes":[],"annotations":[],"description":"Base64-encoded 'SHA1withRSA' signature of the Message, MessageId, Type, Timestamp, and TopicArn values."},{"name":"SigningCertURL","type":"string","required":true,"attributes":[],"annotations":[],"description":"The URL to the certificate that was used to sign the message."},{"name":"Token","type":"string","required":false,"attributes":[],"annotations":[],"description":"A value you can use with the ConfirmSubscription action to re-confirm the subscription. Alternatively, you can simply visit the SubscribeURL."},{"name":"Subject","type":"string","required":false,"attributes":[],"annotations":[],"description":"The Subject parameter specified when the notification was published to the topic. Note that this is an optional parameter. If no Subject was specified, then this name/value pair does not appear in this JSON document."},{"name":"SubscribeURL","type":"string","required":false,"attributes":[],"annotations":[],"description":"The URL that you must visit in order to re-confirm the subscription. Alternatively, you can instead use the Token with the ConfirmSubscription action to re-confirm the subscription."},{"name":"UnsubscribeURL","type":"string","required":false,"attributes":[],"annotations":[],"description":"A URL that you can use to unsubscribe the endpoint from this topic. If you visit this URL, Amazon SNS unsubscribes the endpoint and stops sending notifications to this endpoint."}],"attributes":[],"interfaces":[]}],"resources":[{"type":"hipchat_capabilities_descriptor","plural":"hipchat_capabilities_descriptors","operations":[{"method":"GET","path":"/hipchat/capabilities","parameters":[{"name":"redirect_to_hipchat_install","type":"boolean","location":"Query","required":true,"description":"Whether to redirect to Hipchat install with Base64 encoded data.","default":"false"}],"responses":[{"code":{"integer":{"value":200}},"type":"hipchat_capabilities_descriptor","attributes":[]}],"attributes":[]}],"attributes":[],"path":"/hipchat/capabilities"},{"type":"hipchat_install_data","plural":"hipchat_install_data","operations":[{"method":"GET","path":"/hipchat/installable","parameters":[{"name":"installable_url","type":"string","location":"Query","required":true},{"name":"redirect_url","type":"string","location":"Query","required":true}],"responses":[{"code":{"integer":{"value":200}},"type":"hipchat_capabilities_descriptor","attributes":[]}],"attributes":[]},{"method":"POST","path":"/hipchat/installable","parameters":[],"responses":[{"code":{"integer":{"value":200}},"type":"unit","attributes":[]}],"attributes":[],"body":{"type":"hipchat_install_data","attributes":[]}},{"method":"DELETE","path":"/hipchat/installable/:oauthId","parameters":[{"name":"oauthId","type":"string","location":"Path","required":true}],"responses":[{"code":{"integer":{"value":200}},"type":"unit","attributes":[]}],"attributes":[]}],"attributes":[],"path":"/hipchat/installable"},{"type":"service_info","plural":"service_info","operations":[{"method":"GET","path":"/info","parameters":[],"responses":[{"code":{"integer":{"value":200}},"type":"service_info","attributes":[]}],"attributes":[]}],"attributes":[],"path":"/info"},{"type":"sns_notification","plural":"sns_notifications","operations":[{"method":"POST","path":"/hipchat/room/:roomId/notification","parameters":[{"name":"roomId","type":"string","location":"Path","required":true}],"responses":[{"code":{"integer":{"value":200}},"type":"string","attributes":[]}],"attributes":[],"body":{"type":"sns_notification","attributes":[]}}],"attributes":[],"path":"/hipchat/room/:roomId/notification"}],"attributes":[],"annotations":[],"apidoc":{"version":"1.0.0"},"base_url":"http://hipchat-sns-bridge.common.giltaws.com","description":"Hipchat to Amazon SNS bridge."}