twilio-ruby 4.13.0 → 5.40.0

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

@@ -0,0 +1,494 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Api < Domain
+      class V2010 < Version
+        class AccountContext < InstanceContext
+          class UsageList < ListResource
+            class TriggerList < ListResource
+              ##
+              # Initialize the TriggerList
+              # @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
+
+              ##
+              # Create the TriggerInstance
+              # @param [String] callback_url The URL we should call using `callback_method` when
+              #   the trigger fires.
+              # @param [String] trigger_value The usage value at which the trigger should fire.
+              #   For convenience, you can use an offset value such as `+30` to specify a
+              #   trigger_value that is 30 units more than the current usage value. Be sure to
+              #   urlencode a `+` as `%2B`.
+              # @param [trigger.UsageCategory] usage_category The usage category that the
+              #   trigger should watch.  Use one of the supported [usage
+              #   categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories)
+              #   for this value.
+              # @param [String] callback_method The HTTP method we should use to call
+              #   `callback_url`. Can be: `GET` or `POST` and the default is `POST`.
+              # @param [String] friendly_name A descriptive string that you create to describe
+              #   the resource. It can be up to 64 characters long.
+              # @param [trigger.Recurring] recurring The frequency of a recurring UsageTrigger.
+              #   Can be: `daily`, `monthly`, or `yearly` for recurring triggers or empty for
+              #   non-recurring triggers. A trigger will only fire once during each period.
+              #   Recurring times are in GMT.
+              # @param [trigger.TriggerField] trigger_by The field in the
+              #   [UsageRecord](https://www.twilio.com/docs/usage/api/usage-record) resource that
+              #   should fire the trigger.  Can be: `count`, `usage`, or `price` as described in
+              #   the [UsageRecords
+              #   documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price).  The default is `usage`.
+              # @return [TriggerInstance] 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({
+                    'CallbackUrl' => callback_url,
+                    'TriggerValue' => trigger_value,
+                    'UsageCategory' => usage_category,
+                    'CallbackMethod' => callback_method,
+                    'FriendlyName' => friendly_name,
+                    'Recurring' => recurring,
+                    'TriggerBy' => trigger_by,
+                })
+
+                payload = @version.create('POST', @uri, data: data)
+
+                TriggerInstance.new(@version, payload, 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
+              # memory before returning.
+              # @param [trigger.Recurring] recurring The frequency of recurring UsageTriggers to
+              #   read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers.
+              #   An empty value or a value of `alltime` reads non-recurring UsageTriggers.
+              # @param [trigger.TriggerField] trigger_by The trigger field of the UsageTriggers
+              #   to read.  Can be: `count`, `usage`, or `price` as described in the [UsageRecords
+              #   documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price).
+              # @param [trigger.UsageCategory] usage_category The usage category of the
+              #   UsageTriggers to read. Must be a supported [usage
+              #   categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories).
+              # @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)
+              # @return [Array] Array of up to limit results
+              def list(recurring: :unset, trigger_by: :unset, usage_category: :unset, limit: nil, page_size: nil)
+                self.stream(
+                    recurring: recurring,
+                    trigger_by: trigger_by,
+                    usage_category: usage_category,
+                    limit: limit,
+                    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
+              # is reached.
+              # @param [trigger.Recurring] recurring The frequency of recurring UsageTriggers to
+              #   read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers.
+              #   An empty value or a value of `alltime` reads non-recurring UsageTriggers.
+              # @param [trigger.TriggerField] trigger_by The trigger field of the UsageTriggers
+              #   to read.  Can be: `count`, `usage`, or `price` as described in the [UsageRecords
+              #   documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price).
+              # @param [trigger.UsageCategory] usage_category The usage category of the
+              #   UsageTriggers to read. Must be a supported [usage
+              #   categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories).
+              # @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)
+              # @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)
+                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],
+                )
+
+                @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.
+              def each
+                limits = @version.read_limits
+
+                page = self.page(page_size: limits[:page_size], )
+
+                @version.stream(page,
+                                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.
+              # @param [trigger.Recurring] recurring The frequency of recurring UsageTriggers to
+              #   read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers.
+              #   An empty value or a value of `alltime` reads non-recurring UsageTriggers.
+              # @param [trigger.TriggerField] trigger_by The trigger field of the UsageTriggers
+              #   to read.  Can be: `count`, `usage`, or `price` as described in the [UsageRecords
+              #   documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price).
+              # @param [trigger.UsageCategory] usage_category The usage category of the
+              #   UsageTriggers to read. Must be a supported [usage
+              #   categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories).
+              # @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({
+                    'Recurring' => recurring,
+                    'TriggerBy' => trigger_by,
+                    'UsageCategory' => usage_category,
+                    'PageToken' => page_token,
+                    'Page' => page_number,
+                    'PageSize' => page_size,
+                })
+
+                response = @version.page('GET', @uri, params: params)
+
+                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
+                )
+                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
+              # @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(@version, payload, 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 SID of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+              #   UsageTrigger resource to fetch.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   UsageTrigger resource to fetch.
+              # @return [TriggerContext] TriggerContext
+              def initialize(version, account_sid, sid)
+                super(version)
+
+                # Path Solution
+                @solution = {account_sid: account_sid, sid: sid, }
+                @uri = "/Accounts/#{@solution[:account_sid]}/Usage/Triggers/#{@solution[:sid]}.json"
+              end
+
+              ##
+              # Fetch the TriggerInstance
+              # @return [TriggerInstance] Fetched TriggerInstance
+              def fetch
+                payload = @version.fetch('GET', @uri)
+
+                TriggerInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
+              end
+
+              ##
+              # Update the TriggerInstance
+              # @param [String] callback_method The HTTP method we should use to call
+              #   `callback_url`. Can be: `GET` or `POST` and the default is `POST`.
+              # @param [String] callback_url The URL we should call using `callback_method` when
+              #   the trigger fires.
+              # @param [String] friendly_name A descriptive string that you create to describe
+              #   the resource. It can be up to 64 characters long.
+              # @return [TriggerInstance] Updated TriggerInstance
+              def update(callback_method: :unset, callback_url: :unset, friendly_name: :unset)
+                data = Twilio::Values.of({
+                    'CallbackMethod' => callback_method,
+                    'CallbackUrl' => callback_url,
+                    'FriendlyName' => friendly_name,
+                })
+
+                payload = @version.update('POST', @uri, data: data)
+
+                TriggerInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
+              end
+
+              ##
+              # Delete the TriggerInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
+              def delete
+                 @version.delete('DELETE', @uri)
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.TriggerContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.TriggerContext #{context}>"
+              end
+            end
+
+            class TriggerInstance < InstanceResource
+              ##
+              # Initialize the TriggerInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] account_sid A 34 character string that uniquely identifies this
+              #   resource.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   UsageTrigger resource to fetch.
+              # @return [TriggerInstance] TriggerInstance
+              def initialize(version, payload, account_sid: nil, sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'api_version' => payload['api_version'],
+                    'callback_method' => payload['callback_method'],
+                    'callback_url' => payload['callback_url'],
+                    'current_value' => payload['current_value'],
+                    'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
+                    'date_fired' => Twilio.deserialize_rfc2822(payload['date_fired']),
+                    'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                    'friendly_name' => payload['friendly_name'],
+                    'recurring' => payload['recurring'],
+                    'sid' => payload['sid'],
+                    'trigger_by' => payload['trigger_by'],
+                    'trigger_value' => payload['trigger_value'],
+                    'uri' => payload['uri'],
+                    'usage_category' => payload['usage_category'],
+                    'usage_record_uri' => payload['usage_record_uri'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'account_sid' => account_sid, '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
+              # @return [TriggerContext] TriggerContext for this TriggerInstance
+              def context
+                unless @instance_context
+                  @instance_context = TriggerContext.new(@version, @params['account_sid'], @params['sid'], )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The SID of the Account that this trigger monitors
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [String] The API version used to create the resource
+              def api_version
+                @properties['api_version']
+              end
+
+              ##
+              # @return [String] The HTTP method we use to call callback_url
+              def callback_method
+                @properties['callback_method']
+              end
+
+              ##
+              # @return [String] he URL we call 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 RFC 2822 date and time in GMT that the resource was created
+              def date_created
+                @properties['date_created']
+              end
+
+              ##
+              # @return [Time] The RFC 2822 date and time in GMT that the trigger was last fired
+              def date_fired
+                @properties['date_fired']
+              end
+
+              ##
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
+              def date_updated
+                @properties['date_updated']
+              end
+
+              ##
+              # @return [String] The string that you assigned to describe the trigger
+              def friendly_name
+                @properties['friendly_name']
+              end
+
+              ##
+              # @return [trigger.Recurring] The frequency of a recurring UsageTrigger
+              def recurring
+                @properties['recurring']
+              end
+
+              ##
+              # @return [String] The unique string that identifies the resource
+              def sid
+                @properties['sid']
+              end
+
+              ##
+              # @return [trigger.TriggerField] The field in the UsageRecord resource 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 of the resource, relative to `https://api.twilio.com`
+              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 resource this trigger watches
+              def usage_record_uri
+                @properties['usage_record_uri']
+              end
+
+              ##
+              # Fetch the TriggerInstance
+              # @return [TriggerInstance] Fetched TriggerInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Update the TriggerInstance
+              # @param [String] callback_method The HTTP method we should use to call
+              #   `callback_url`. Can be: `GET` or `POST` and the default is `POST`.
+              # @param [String] callback_url The URL we should call using `callback_method` when
+              #   the trigger fires.
+              # @param [String] friendly_name A descriptive string that you create to describe
+              #   the resource. It can be up to 64 characters long.
+              # @return [TriggerInstance] Updated TriggerInstance
+              def update(callback_method: :unset, callback_url: :unset, friendly_name: :unset)
+                context.update(
+                    callback_method: callback_method,
+                    callback_url: callback_url,
+                    friendly_name: friendly_name,
+                )
+              end
+
+              ##
+              # Delete the TriggerInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
+              def 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}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Api.V2010.TriggerInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,120 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Api < Domain
+      class V2010 < Version
+        class AccountContext < InstanceContext
+          class UsageList < ListResource
+            ##
+            # Initialize the UsageList
+            # @param [Version] version Version that contains the resource
+            # @param [String] account_sid A 34 character string that uniquely identifies this
+            #   resource.
+            # @return [UsageList] UsageList
+            def initialize(version, account_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {account_sid: account_sid}
+
+              # Components
+              @records = nil
+              @triggers = nil
+            end
+
+            ##
+            # Access the records
+            # @return [RecordList]
+            # @return [RecordContext]
+            def records
+              @records ||= RecordList.new(@version, account_sid: @solution[:account_sid], )
+            end
+
+            ##
+            # Access the triggers
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   UsageTrigger resource to fetch.
+            # @return [TriggerList]
+            # @return [TriggerContext] if sid was passed.
+            def triggers(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return TriggerContext.new(@version, @solution[:account_sid], sid, )
+              end
+
+                @triggers ||= TriggerList.new(@version, account_sid: @solution[:account_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Api.V2010.UsageList>'
+            end
+          end
+
+          class UsagePage < Page
+            ##
+            # Initialize the UsagePage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [UsagePage] UsagePage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of UsageInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [UsageInstance] UsageInstance
+            def get_instance(payload)
+              UsageInstance.new(@version, payload, account_sid: @solution[:account_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Api.V2010.UsagePage>'
+            end
+          end
+
+          class UsageInstance < InstanceResource
+            ##
+            # Initialize the UsageInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] account_sid A 34 character string that uniquely identifies this
+            #   resource.
+            # @return [UsageInstance] UsageInstance
+            def initialize(version, payload, account_sid: nil)
+              super(version)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Api.V2010.UsageInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Api.V2010.UsageInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end