twilio-ruby 5.0.0.alpha1 → 5.0.0.rc2

data/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb

@@ -2,7 +2,7 @@
 # This code was generated by
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#       /       /       
 
 module Twilio
   module REST
@@ -16,17 +16,18 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [String] account_sid A 34 character string that uniquely identifies this
               #   resource.
+              
               # @return [TriggerList] TriggerList
               def initialize(version, account_sid: nil)
                 super(version)
-
+                
                 # Path Solution
                 @solution = {
                     account_sid: account_sid
                 }
                 @uri = "/Accounts/#{@solution[:account_sid]}/Usage/Triggers.json"
               end
-
+              
               ##
               # Retrieve a single page of TriggerInstance records from the API.
               # Request is executed immediately.
@@ -46,9 +47,10 @@ module Twilio
               #   Recurring periods are in GMT.
               # @param [trigger.TriggerField] trigger_by The field in the UsageRecord that fires
               #   the trigger. One of `count`, `usage`, or `price`
+              
               # @return [TriggerInstance] Newly created TriggerInstance
-              def create(callback_url: nil, trigger_value: nil, usage_category: nil, callback_method: :unset, friendly_name: :unset, recurring: :unset, trigger_by: :unset)
-                data = Twilio::Values.of({
+              def create(callback_url: nil, trigger_value: nil, usage_category: nil, callback_method: nil, friendly_name: nil, recurring: nil, trigger_by: nil)
+                data = {
                     'CallbackUrl' => callback_url,
                     'TriggerValue' => trigger_value,
                     'UsageCategory' => usage_category,
@@ -56,21 +58,21 @@ module Twilio
                     'FriendlyName' => friendly_name,
                     'Recurring' => recurring,
                     'TriggerBy' => trigger_by,
-                })
-
+                }
+                
                 payload = @version.create(
                     'POST',
                     @uri,
                     data: data
                 )
-
-                TriggerInstance.new(
+                
+                return TriggerInstance.new(
                     @version,
                     payload,
-                    account_sid: @solution[:account_sid],
+                    account_sid: @solution['account_sid'],
                 )
               end
-
+              
               ##
               # Lists TriggerInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
@@ -87,8 +89,9 @@ module Twilio
               #  the default value of 50 records.  If no page_size is                      defined
               #  but a limit is defined, stream() will attempt to read                      the
               #  limit with the most efficient page size,                      i.e. min(limit, 1000)
+              
               # @return [Array] Array of up to limit results
-              def list(recurring: :unset, trigger_by: :unset, usage_category: :unset, limit: nil, page_size: nil)
+              def list(recurring: nil, trigger_by: nil, usage_category: nil, limit: nil, page_size: nil)
                 self.stream(
                     recurring: recurring,
                     trigger_by: trigger_by,
@@ -97,7 +100,7 @@ module Twilio
                     page_size: page_size
                 ).entries
               end
-
+              
               ##
               # Streams TriggerInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
@@ -114,36 +117,49 @@ module Twilio
               #  the default value of 50 records.                      If no page_size is defined
               #                       but a limit is defined, stream() will attempt to                      read the
               #  limit with the most efficient page size,                       i.e. min(limit, 1000)
+              
               # @return [Enumerable] Enumerable that will yield up to limit results
-              def stream(recurring: :unset, trigger_by: :unset, usage_category: :unset, limit: nil, page_size: nil)
+              def stream(recurring: nil, trigger_by: nil, usage_category: nil, limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
-
+                
                 page = self.page(
                     recurring: recurring,
                     trigger_by: trigger_by,
                     usage_category: usage_category,
-                    page_size: limits[:page_size],
+                    page_size: limits['page_size'],
                 )
-
-                @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                
+                @version.stream(page, limit: limits['limit'], page_limit: limits['page_limit'])
               end
-
+              
               ##
               # When passed a block, yields TriggerInstance records from the API.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
+              # @param [trigger.Recurring] recurring Only show UsageTriggers that count over
+              #   this interval. One of daily, monthly, or yearly
+              # @param [trigger.TriggerField] trigger_by Only show UsageTriggers that trigger by
+              #   this field in the UsagRecord
+              # @param [trigger.UsageCategory] usage_category Only show UsageTriggers that watch
+              #   this usage category
+              # @param [Integer] limit Upper limit for the number of records to return.                  stream()
+              #  guarantees to never return more than limit.                  Default is no limit
+              # @param [Integer] page_size Number of records to fetch per request, when                       not set will use
+              #  the default value of 50 records.                      If no page_size is defined
+              #                       but a limit is defined, stream() will attempt to read the
+              #                       limit with the most efficient page size, i.e. min(limit, 1000)
               def each
                 limits = @version.read_limits
-
+                
                 page = self.page(
-                    page_size: limits[:page_size],
+                    page_size: limits['page_size'],
                 )
-
+                
                 @version.stream(page,
-                                limit: limits[:limit],
-                                page_limit: limits[:page_limit]).each {|x| yield x}
+                                limit: limits['limit'],
+                                page_limit: limits['page_limit']).each {|x| yield x}
               end
-
+              
               ##
               # Retrieve a single page of TriggerInstance records from the API.
               # Request is executed immediately.
@@ -156,87 +172,93 @@ module Twilio
               # @param [String] page_token PageToken provided by the API
               # @param [Integer] page_number Page Number, this value is simply for client state
               # @param [Integer] page_size Number of records to return, defaults to 50
+              
               # @return [Page] Page of TriggerInstance
-              def page(recurring: :unset, trigger_by: :unset, usage_category: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
-                params = Twilio::Values.of({
+              def page(recurring: nil, trigger_by: nil, usage_category: nil, page_token: nil, page_number: nil, page_size: nil)
+                params = {
                     'Recurring' => recurring,
                     'TriggerBy' => trigger_by,
                     'UsageCategory' => usage_category,
                     'PageToken' => page_token,
                     'Page' => page_number,
                     'PageSize' => page_size,
-                })
+                }
                 response = @version.page(
                     'GET',
                     @uri,
                     params
                 )
-                TriggerPage.new(@version, response, @solution)
+                return TriggerPage.new(@version, response, @solution)
               end
-
+              
               ##
-              # Retrieve a single page of TriggerInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] target_url API-generated URL for the requested results page
-              # @return [Page] Page of TriggerInstance
-              def get_page(target_url)
-                response = @version.domain.request(
-                    'GET',
-                    target_url
+              # Constructs a TriggerContext
+              # @param [String] sid The usage-trigger Sid that uniquely identifies this resource
+              
+              # @return [TriggerContext] TriggerContext
+              def get(sid)
+                TriggerContext.new(
+                    @version,
+                    account_sid: @solution[:account_sid],
+                    sid: sid,
                 )
-                TriggerPage.new(@version, response, @solution)
               end
-
+              
               ##
               # Provide a user friendly representation
               def to_s
                 '#<Twilio.Api.V2010.TriggerList>'
               end
             end
-
+          
             class TriggerPage < Page
               ##
               # Initialize the TriggerPage
               # @param [Version] version Version that contains the resource
               # @param [Response] response Response from the API
               # @param [Hash] solution Path solution for the resource
+              # @param [String] account_sid A 34 character string that uniquely identifies this
+              #   resource.
+              
               # @return [TriggerPage] TriggerPage
               def initialize(version, response, solution)
                 super(version, response)
-
+                
                 # Path Solution
                 @solution = solution
               end
-
+              
               ##
               # Build an instance of TriggerInstance
               # @param [Hash] payload Payload response from the API
+              
               # @return [TriggerInstance] TriggerInstance
               def get_instance(payload)
-                TriggerInstance.new(
+                return TriggerInstance.new(
                     @version,
                     payload,
-                    account_sid: @solution[:account_sid],
+                    account_sid: @solution['account_sid'],
                 )
               end
-
+              
               ##
               # Provide a user friendly representation
               def to_s
                 '<Twilio.Api.V2010.TriggerPage>'
               end
             end
-
+          
             class TriggerContext < InstanceContext
               ##
               # Initialize the TriggerContext
               # @param [Version] version Version that contains the resource
               # @param [String] account_sid The account_sid
               # @param [String] sid The usage-trigger Sid that uniquely identifies this resource
+              
               # @return [TriggerContext] TriggerContext
               def initialize(version, account_sid, sid)
                 super(version)
-
+                
                 # Path Solution
                 @solution = {
                     account_sid: account_sid,
@@ -244,27 +266,27 @@ module Twilio
                 }
                 @uri = "/Accounts/#{@solution[:account_sid]}/Usage/Triggers/#{@solution[:sid]}.json"
               end
-
+              
               ##
               # Fetch a TriggerInstance
               # @return [TriggerInstance] Fetched TriggerInstance
               def fetch
-                params = Twilio::Values.of({})
-
+                params = {}
+                
                 payload = @version.fetch(
                     'GET',
                     @uri,
                     params,
                 )
-
-                TriggerInstance.new(
+                
+                return TriggerInstance.new(
                     @version,
                     payload,
-                    account_sid: @solution[:account_sid],
-                    sid: @solution[:sid],
+                    account_sid: @solution['account_sid'],
+                    sid: @solution['sid'],
                 )
               end
-
+              
               ##
               # Update the TriggerInstance
               # @param [String] callback_method The HTTP method Twilio will use when making a
@@ -273,35 +295,36 @@ module Twilio
               #   trigger fires.
               # @param [String] friendly_name A user-specified, human-readable name for the
               #   trigger.
+              
               # @return [TriggerInstance] Updated TriggerInstance
-              def update(callback_method: :unset, callback_url: :unset, friendly_name: :unset)
-                data = Twilio::Values.of({
+              def update(callback_method: nil, callback_url: nil, friendly_name: nil)
+                data = {
                     'CallbackMethod' => callback_method,
                     'CallbackUrl' => callback_url,
                     'FriendlyName' => friendly_name,
-                })
-
+                }
+                
                 payload = @version.update(
                     'POST',
                     @uri,
                     data: data,
                 )
-
-                TriggerInstance.new(
+                
+                return TriggerInstance.new(
                     @version,
                     payload,
-                    account_sid: @solution[:account_sid],
-                    sid: @solution[:sid],
+                    account_sid: @solution['account_sid'],
+                    sid: @solution['sid'],
                 )
               end
-
+              
               ##
               # Deletes the TriggerInstance
               # @return [Boolean] true if delete succeeds, true otherwise
               def delete
-                @version.delete('delete', @uri)
+                return @version.delete('delete', @uri)
               end
-
+              
               ##
               # Provide a user friendly representation
               def to_s
@@ -309,7 +332,7 @@ module Twilio
                 "#<Twilio.Api.V2010.TriggerContext #{context}>"
               end
             end
-
+          
             class TriggerInstance < InstanceResource
               ##
               # Initialize the TriggerInstance
@@ -318,10 +341,11 @@ module Twilio
               # @param [String] account_sid A 34 character string that uniquely identifies this
               #   resource.
               # @param [String] sid The usage-trigger Sid that uniquely identifies this resource
+              
               # @return [TriggerInstance] TriggerInstance
               def initialize(version, payload, account_sid: nil, sid: nil)
                 super(version)
-
+                
                 # Marshaled Properties
                 @properties = {
                     'account_sid' => payload['account_sid'],
@@ -341,7 +365,7 @@ module Twilio
                     'usage_category' => payload['usage_category'],
                     'usage_record_uri' => payload['usage_record_uri'],
                 }
-
+                
                 # Context
                 @instance_context = nil
                 @params = {
@@ -349,10 +373,12 @@ module Twilio
                     'sid' => sid || @properties['sid'],
                 }
               end
-
+              
               ##
               # Generate an instance context for the instance, the context is capable of
               # performing various actions.  All instance actions are proxied to the context
+              # @param [Version] version Version that contains the resource
+              
               # @return [TriggerContext] TriggerContext for this TriggerInstance
               def context
                 unless @instance_context
@@ -364,110 +390,78 @@ module Twilio
                 end
                 @instance_context
               end
-
-              ##
-              # @return [String] The account this trigger monitors.
+              
               def account_sid
                 @properties['account_sid']
               end
-
-              ##
-              # @return [String] The api_version
+              
               def api_version
                 @properties['api_version']
               end
-
-              ##
-              # @return [String] HTTP method to use with callback_url
+              
               def callback_method
                 @properties['callback_method']
               end
-
-              ##
-              # @return [String] URL Twilio will request when the trigger fires
+              
               def callback_url
                 @properties['callback_url']
               end
-
-              ##
-              # @return [String] The current value of the field the trigger is watching.
+              
               def current_value
                 @properties['current_value']
               end
-
-              ##
-              # @return [Time] The date this resource was created
+              
               def date_created
                 @properties['date_created']
               end
-
-              ##
-              # @return [Time] The date the trigger was last fired
+              
               def date_fired
                 @properties['date_fired']
               end
-
-              ##
-              # @return [Time] The date this resource was last updated
+              
               def date_updated
                 @properties['date_updated']
               end
-
-              ##
-              # @return [String] A user-specified, human-readable name for the trigger.
+              
               def friendly_name
                 @properties['friendly_name']
               end
-
-              ##
-              # @return [trigger.Recurring] How this trigger recurs
+              
               def recurring
                 @properties['recurring']
               end
-
-              ##
-              # @return [String] The trigger's unique Sid
+              
               def sid
                 @properties['sid']
               end
-
-              ##
-              # @return [trigger.TriggerField] The field in the UsageRecord that fires the trigger
+              
               def trigger_by
                 @properties['trigger_by']
               end
-
-              ##
-              # @return [String] the value at which the trigger will fire
+              
               def trigger_value
                 @properties['trigger_value']
               end
-
-              ##
-              # @return [String] The URI for this resource
+              
               def uri
                 @properties['uri']
               end
-
-              ##
-              # @return [trigger.UsageCategory] The usage category the trigger watches
+              
               def usage_category
                 @properties['usage_category']
               end
-
-              ##
-              # @return [String] The URI of the UsageRecord this trigger is watching
+              
               def usage_record_uri
                 @properties['usage_record_uri']
               end
-
+              
               ##
               # Fetch a TriggerInstance
               # @return [TriggerInstance] Fetched TriggerInstance
               def fetch
-                context.fetch
+                @context.fetch()
               end
-
+              
               ##
               # Update the TriggerInstance
               # @param [String] callback_method The HTTP method Twilio will use when making a
@@ -476,27 +470,27 @@ module Twilio
               #   trigger fires.
               # @param [String] friendly_name A user-specified, human-readable name for the
               #   trigger.
+              
               # @return [TriggerInstance] Updated TriggerInstance
-              def update(callback_method: :unset, callback_url: :unset, friendly_name: :unset)
-                context.update(
-                    callback_method: callback_method,
+              def update(callback_method: nil, callback_url: nil, friendly_name: nil)
+                @context.update(
                     callback_url: callback_url,
                     friendly_name: friendly_name,
                 )
               end
-
+              
               ##
               # Deletes the TriggerInstance
               # @return [Boolean] true if delete succeeds, true otherwise
               def delete
-                context.delete
+                @context.delete()
               end
-
+              
               ##
               # Provide a user friendly representation
               def to_s
-                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Api.V2010.TriggerInstance #{values}>"
+                context = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Api.V2010.TriggerInstance #{context}>"
               end
             end
           end