aws-sdk-sns 1.0.0.rc1 → 1.0.0.rc2

data/lib/aws-sdk-sns/resource.rb

@@ -1,185 +1,183 @@
 # WARNING ABOUT GENERATED CODE
 #
-# This file is generated. See the contributing for info on making contributions:
+# This file is generated. See the contributing guide for more information:
 # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
-module Aws
-  module SNS
-    class Resource
+module Aws::SNS
+  class Resource
 
-      # @param options ({})
-      # @option options [Client] :client
-      def initialize(options = {})
-        @client = options[:client] || Client.new(options)
-      end
+    # @param options ({})
+    # @option options [Client] :client
+    def initialize(options = {})
+      @client = options[:client] || Client.new(options)
+    end
 
-      # @return [Client]
-      def client
-        @client
-      end
+    # @return [Client]
+    def client
+      @client
+    end
 
-      # @!group Actions
+    # @!group Actions
 
-      # @example Request syntax with placeholder values
-      #
-      #   platformapplication = sns.create_platform_application({
-      #     name: "String", # required
-      #     platform: "String", # required
-      #     attributes: { # required
-      #       "String" => "String",
-      #     },
-      #   })
-      # @param [Hash] options ({})
-      # @option options [required, String] :name
-      #   Application names must be made up of only uppercase and lowercase
-      #   ASCII letters, numbers, underscores, hyphens, and periods, and must be
-      #   between 1 and 256 characters long.
-      # @option options [required, String] :platform
-      #   The following platforms are supported: ADM (Amazon Device Messaging),
-      #   APNS (Apple Push Notification Service), APNS\_SANDBOX, and GCM (Google
-      #   Cloud Messaging).
-      # @option options [required, Hash<String,String>] :attributes
-      #   For a list of attributes, see [SetPlatformApplicationAttributes][1]
-      #
-      #
-      #
-      #   [1]: http://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html
-      # @return [PlatformApplication]
-      def create_platform_application(options = {})
-        resp = @client.create_platform_application(options)
-        PlatformApplication.new(
-          arn: resp.data.platform_application_arn,
-          client: @client
-        )
-      end
+    # @example Request syntax with placeholder values
+    #
+    #   platformapplication = sns.create_platform_application({
+    #     name: "String", # required
+    #     platform: "String", # required
+    #     attributes: { # required
+    #       "String" => "String",
+    #     },
+    #   })
+    # @param [Hash] options ({})
+    # @option options [required, String] :name
+    #   Application names must be made up of only uppercase and lowercase
+    #   ASCII letters, numbers, underscores, hyphens, and periods, and must be
+    #   between 1 and 256 characters long.
+    # @option options [required, String] :platform
+    #   The following platforms are supported: ADM (Amazon Device Messaging),
+    #   APNS (Apple Push Notification Service), APNS\_SANDBOX, and GCM (Google
+    #   Cloud Messaging).
+    # @option options [required, Hash<String,String>] :attributes
+    #   For a list of attributes, see [SetPlatformApplicationAttributes][1]
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html
+    # @return [PlatformApplication]
+    def create_platform_application(options = {})
+      resp = @client.create_platform_application(options)
+      PlatformApplication.new(
+        arn: resp.data.platform_application_arn,
+        client: @client
+      )
+    end
 
-      # @example Request syntax with placeholder values
-      #
-      #   topic = sns.create_topic({
-      #     name: "topicName", # required
-      #   })
-      # @param [Hash] options ({})
-      # @option options [required, String] :name
-      #   The name of the topic you want to create.
-      #
-      #   Constraints: Topic names must be made up of only uppercase and
-      #   lowercase ASCII letters, numbers, underscores, and hyphens, and must
-      #   be between 1 and 256 characters long.
-      # @return [Topic]
-      def create_topic(options = {})
-        resp = @client.create_topic(options)
-        Topic.new(
-          arn: resp.data.topic_arn,
-          client: @client
-        )
-      end
+    # @example Request syntax with placeholder values
+    #
+    #   topic = sns.create_topic({
+    #     name: "topicName", # required
+    #   })
+    # @param [Hash] options ({})
+    # @option options [required, String] :name
+    #   The name of the topic you want to create.
+    #
+    #   Constraints: Topic names must be made up of only uppercase and
+    #   lowercase ASCII letters, numbers, underscores, and hyphens, and must
+    #   be between 1 and 256 characters long.
+    # @return [Topic]
+    def create_topic(options = {})
+      resp = @client.create_topic(options)
+      Topic.new(
+        arn: resp.data.topic_arn,
+        client: @client
+      )
+    end
 
-      # @!group Associations
+    # @!group Associations
 
-      # @param [String] arn
-      # @return [PlatformApplication]
-      def platform_application(arn)
-        PlatformApplication.new(
-          arn: arn,
-          client: @client
-        )
-      end
+    # @param [String] arn
+    # @return [PlatformApplication]
+    def platform_application(arn)
+      PlatformApplication.new(
+        arn: arn,
+        client: @client
+      )
+    end
 
-      # @example Request syntax with placeholder values
-      #
-      #   platformapplications = sns.platform_applications()
-      # @param [Hash] options ({})
-      # @return [PlatformApplication::Collection]
-      def platform_applications(options = {})
-        batches = Enumerator.new do |y|
-          resp = @client.list_platform_applications(options)
-          resp.each_page do |page|
-            batch = []
-            page.data.platform_applications.each do |p|
-              batch << PlatformApplication.new(
-                arn: p.platform_application_arn,
-                client: @client
-              )
-            end
-            y.yield(batch)
+    # @example Request syntax with placeholder values
+    #
+    #   sns.platform_applications()
+    # @param [Hash] options ({})
+    # @return [PlatformApplication::Collection]
+    def platform_applications(options = {})
+      batches = Enumerator.new do |y|
+        resp = @client.list_platform_applications(options)
+        resp.each_page do |page|
+          batch = []
+          page.data.platform_applications.each do |p|
+            batch << PlatformApplication.new(
+              arn: p.platform_application_arn,
+              client: @client
+            )
           end
+          y.yield(batch)
         end
-        PlatformApplication::Collection.new(batches)
       end
+      PlatformApplication::Collection.new(batches)
+    end
 
-      # @param [String] arn
-      # @return [PlatformEndpoint]
-      def platform_endpoint(arn)
-        PlatformEndpoint.new(
-          arn: arn,
-          client: @client
-        )
-      end
+    # @param [String] arn
+    # @return [PlatformEndpoint]
+    def platform_endpoint(arn)
+      PlatformEndpoint.new(
+        arn: arn,
+        client: @client
+      )
+    end
 
-      # @param [String] arn
-      # @return [Subscription]
-      def subscription(arn)
-        Subscription.new(
-          arn: arn,
-          client: @client
-        )
-      end
+    # @param [String] arn
+    # @return [Subscription]
+    def subscription(arn)
+      Subscription.new(
+        arn: arn,
+        client: @client
+      )
+    end
 
-      # @example Request syntax with placeholder values
-      #
-      #   subscriptions = sns.subscriptions()
-      # @param [Hash] options ({})
-      # @return [Subscription::Collection]
-      def subscriptions(options = {})
-        batches = Enumerator.new do |y|
-          resp = @client.list_subscriptions(options)
-          resp.each_page do |page|
-            batch = []
-            page.data.subscriptions.each do |s|
-              batch << Subscription.new(
-                arn: s.subscription_arn,
-                client: @client
-              )
-            end
-            y.yield(batch)
+    # @example Request syntax with placeholder values
+    #
+    #   sns.subscriptions()
+    # @param [Hash] options ({})
+    # @return [Subscription::Collection]
+    def subscriptions(options = {})
+      batches = Enumerator.new do |y|
+        resp = @client.list_subscriptions(options)
+        resp.each_page do |page|
+          batch = []
+          page.data.subscriptions.each do |s|
+            batch << Subscription.new(
+              arn: s.subscription_arn,
+              client: @client
+            )
           end
+          y.yield(batch)
         end
-        Subscription::Collection.new(batches)
       end
+      Subscription::Collection.new(batches)
+    end
 
-      # @param [String] arn
-      # @return [Topic]
-      def topic(arn)
-        Topic.new(
-          arn: arn,
-          client: @client
-        )
-      end
+    # @param [String] arn
+    # @return [Topic]
+    def topic(arn)
+      Topic.new(
+        arn: arn,
+        client: @client
+      )
+    end
 
-      # @example Request syntax with placeholder values
-      #
-      #   topics = sns.topics()
-      # @param [Hash] options ({})
-      # @return [Topic::Collection]
-      def topics(options = {})
-        batches = Enumerator.new do |y|
-          resp = @client.list_topics(options)
-          resp.each_page do |page|
-            batch = []
-            page.data.topics.each do |t|
-              batch << Topic.new(
-                arn: t.topic_arn,
-                client: @client
-              )
-            end
-            y.yield(batch)
+    # @example Request syntax with placeholder values
+    #
+    #   sns.topics()
+    # @param [Hash] options ({})
+    # @return [Topic::Collection]
+    def topics(options = {})
+      batches = Enumerator.new do |y|
+        resp = @client.list_topics(options)
+        resp.each_page do |page|
+          batch = []
+          page.data.topics.each do |t|
+            batch << Topic.new(
+              arn: t.topic_arn,
+              client: @client
+            )
           end
+          y.yield(batch)
         end
-        Topic::Collection.new(batches)
       end
-
+      Topic::Collection.new(batches)
     end
+
   end
 end

data/lib/aws-sdk-sns/subscription.rb

@@ -1,149 +1,147 @@
 # WARNING ABOUT GENERATED CODE
 #
-# This file is generated. See the contributing for info on making contributions:
+# This file is generated. See the contributing guide for more information:
 # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
-module Aws
-  module SNS
-    class Subscription
-
-      extend Aws::Deprecations
-
-      # @overload def initialize(arn, options = {})
-      #   @param [String] arn
-      #   @option options [Client] :client
-      # @overload def initialize(options = {})
-      #   @option options [required, String] :arn
-      #   @option options [Client] :client
-      def initialize(*args)
-        options = Hash === args.last ? args.pop.dup : {}
-        @arn = extract_arn(args, options)
-        @data = options.delete(:data)
-        @client = options.delete(:client) || Client.new(options)
-      end
+module Aws::SNS
+  class Subscription
+
+    extend Aws::Deprecations
+
+    # @overload def initialize(arn, options = {})
+    #   @param [String] arn
+    #   @option options [Client] :client
+    # @overload def initialize(options = {})
+    #   @option options [required, String] :arn
+    #   @option options [Client] :client
+    def initialize(*args)
+      options = Hash === args.last ? args.pop.dup : {}
+      @arn = extract_arn(args, options)
+      @data = options.delete(:data)
+      @client = options.delete(:client) || Client.new(options)
+    end
 
-      # @!group Read-Only Attributes
+    # @!group Read-Only Attributes
 
-      # @return [String]
-      def arn
-        @arn
-      end
+    # @return [String]
+    def arn
+      @arn
+    end
 
-      # A map of the subscription's attributes. Attributes in this map
-      # include the following:
-      #
-      # * `SubscriptionArn` -- the subscription's ARN
-      #
-      # * `TopicArn` -- the topic ARN that the subscription is associated with
-      #
-      # * `Owner` -- the AWS account ID of the subscription's owner
-      #
-      # * `ConfirmationWasAuthenticated` -- true if the subscription
-      #   confirmation request was authenticated
-      #
-      # * `DeliveryPolicy` -- the JSON serialization of the subscription's
-      #   delivery policy
-      #
-      # * `EffectiveDeliveryPolicy` -- the JSON serialization of the effective
-      #   delivery policy that takes into account the topic delivery policy
-      #   and account system defaults
-      # @return [Hash<String,String>]
-      def attributes
-        data.attributes
-      end
+    # A map of the subscription's attributes. Attributes in this map
+    # include the following:
+    #
+    # * `SubscriptionArn` -- the subscription's ARN
+    #
+    # * `TopicArn` -- the topic ARN that the subscription is associated with
+    #
+    # * `Owner` -- the AWS account ID of the subscription's owner
+    #
+    # * `ConfirmationWasAuthenticated` -- true if the subscription
+    #   confirmation request was authenticated
+    #
+    # * `DeliveryPolicy` -- the JSON serialization of the subscription's
+    #   delivery policy
+    #
+    # * `EffectiveDeliveryPolicy` -- the JSON serialization of the effective
+    #   delivery policy that takes into account the topic delivery policy
+    #   and account system defaults
+    # @return [Hash<String,String>]
+    def attributes
+      data.attributes
+    end
 
-      # @!endgroup
+    # @!endgroup
 
-      # @return [Client]
-      def client
-        @client
-      end
+    # @return [Client]
+    def client
+      @client
+    end
 
-      # Loads, or reloads {#data} for the current {Subscription}.
-      # Returns `self` making it possible to chain methods.
-      #
-      #     subscription.reload.data
-      #
-      # @return [self]
-      def load
-        resp = @client.get_subscription_attributes(subscription_arn: @arn)
-        @data = resp.data
-        self
-      end
-      alias :reload :load
-
-      # @return [Types::GetSubscriptionAttributesResponse]
-      #   Returns the data for this {Subscription}. Calls
-      #   {Client#get_subscription_attributes} if {#data_loaded?} is `false`.
-      def data
-        load unless @data
-        @data
-      end
+    # Loads, or reloads {#data} for the current {Subscription}.
+    # Returns `self` making it possible to chain methods.
+    #
+    #     subscription.reload.data
+    #
+    # @return [self]
+    def load
+      resp = @client.get_subscription_attributes(subscription_arn: @arn)
+      @data = resp.data
+      self
+    end
+    alias :reload :load
+
+    # @return [Types::GetSubscriptionAttributesResponse]
+    #   Returns the data for this {Subscription}. Calls
+    #   {Client#get_subscription_attributes} if {#data_loaded?} is `false`.
+    def data
+      load unless @data
+      @data
+    end
 
-      # @return [Boolean]
-      #   Returns `true` if this resource is loaded.  Accessing attributes or
-      #   {#data} on an unloaded resource will trigger a call to {#load}.
-      def data_loaded?
-        !!@data
-      end
+    # @return [Boolean]
+    #   Returns `true` if this resource is loaded.  Accessing attributes or
+    #   {#data} on an unloaded resource will trigger a call to {#load}.
+    def data_loaded?
+      !!@data
+    end
 
-      # @!group Actions
-
-      # @example Request syntax with placeholder values
-      #
-      #   subscription.delete()
-      # @param [Hash] options ({})
-      # @return [EmptyStructure]
-      def delete(options = {})
-        options = options.merge(subscription_arn: @arn)
-        resp = @client.unsubscribe(options)
-        resp.data
-      end
+    # @!group Actions
+
+    # @example Request syntax with placeholder values
+    #
+    #   subscription.delete()
+    # @param [Hash] options ({})
+    # @return [EmptyStructure]
+    def delete(options = {})
+      options = options.merge(subscription_arn: @arn)
+      resp = @client.unsubscribe(options)
+      resp.data
+    end
 
-      # @example Request syntax with placeholder values
-      #
-      #   subscription.set_attributes({
-      #     attribute_name: "attributeName", # required
-      #     attribute_value: "attributeValue",
-      #   })
-      # @param [Hash] options ({})
-      # @option options [required, String] :attribute_name
-      #   The name of the attribute you want to set. Only a subset of the
-      #   subscriptions attributes are mutable.
-      #
-      #   Valid values: `DeliveryPolicy` \| `RawMessageDelivery`
-      # @option options [String] :attribute_value
-      #   The new value for the attribute in JSON format.
-      # @return [EmptyStructure]
-      def set_attributes(options = {})
-        options = options.merge(subscription_arn: @arn)
-        resp = @client.set_subscription_attributes(options)
-        resp.data
-      end
+    # @example Request syntax with placeholder values
+    #
+    #   subscription.set_attributes({
+    #     attribute_name: "attributeName", # required
+    #     attribute_value: "attributeValue",
+    #   })
+    # @param [Hash] options ({})
+    # @option options [required, String] :attribute_name
+    #   The name of the attribute you want to set. Only a subset of the
+    #   subscriptions attributes are mutable.
+    #
+    #   Valid values: `DeliveryPolicy` \| `RawMessageDelivery`
+    # @option options [String] :attribute_value
+    #   The new value for the attribute in JSON format.
+    # @return [EmptyStructure]
+    def set_attributes(options = {})
+      options = options.merge(subscription_arn: @arn)
+      resp = @client.set_subscription_attributes(options)
+      resp.data
+    end
 
-      # @deprecated
-      # @api private
-      def identifiers
-        { arn: @arn }
-      end
-      deprecated(:identifiers)
-
-      private
-
-      def extract_arn(args, options)
-        value = args[0] || options.delete(:arn)
-        case value
-        when String then value
-        when nil then raise ArgumentError, "missing required option :arn"
-        else
-          msg = "expected :arn to be a String, got #{value.class}"
-          raise ArgumentError, msg
-        end
+    # @deprecated
+    # @api private
+    def identifiers
+      { arn: @arn }
+    end
+    deprecated(:identifiers)
+
+    private
+
+    def extract_arn(args, options)
+      value = args[0] || options.delete(:arn)
+      case value
+      when String then value
+      when nil then raise ArgumentError, "missing required option :arn"
+      else
+        msg = "expected :arn to be a String, got #{value.class}"
+        raise ArgumentError, msg
       end
-
-      class Collection < Aws::Resources::Collection; end
     end
+
+    class Collection < Aws::Resources::Collection; end
   end
 end