twilio-ruby 5.31.0 → 5.46.0

data/lib/twilio-ruby/rest/supersim/v1/usage_record.rb

@@ -0,0 +1,338 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Supersim < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class UsageRecordList < ListResource
+          ##
+          # Initialize the UsageRecordList
+          # @param [Version] version Version that contains the resource
+          # @return [UsageRecordList] UsageRecordList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/UsageRecords"
+          end
+
+          ##
+          # Lists UsageRecordInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [String] sim SID or unique name of a Sim resource. Only show UsageRecords
+          #   representing usage incurred by this Super SIM.
+          # @param [String] fleet SID or unique name of a Fleet resource. Only show
+          #   UsageRecords representing usage for Super SIMs belonging to this Fleet resource
+          #   at the time the usage occurred.
+          # @param [String] network SID of a Network resource. Only show UsageRecords
+          #   representing usage on this network.
+          # @param [String] iso_country Alpha-2 ISO Country Code. Only show UsageRecords
+          #   representing usage in this country.
+          # @param [usage_record.Group] group Dimension over which to aggregate usage
+          #   records. Can be: `sim`, `fleet`, `network`, `isoCountry`. Default is to not
+          #   aggregate across any of these dimensions, UsageRecords will be aggregated into
+          #   the time buckets described by the `Granularity` parameter.
+          # @param [usage_record.Granularity] granularity Time-based grouping that
+          #   UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default
+          #   is `all`. `all` returns one UsageRecord that describes the usage for the entire
+          #   period.
+          # @param [Time] start_time Only include usage that occurred at or after this time,
+          #   specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default
+          #   is one month before the `end_time`.
+          # @param [Time] end_time Only include usage that occurred before this time,
+          #   specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default
+          #   is the current time.
+          # @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(sim: :unset, fleet: :unset, network: :unset, iso_country: :unset, group: :unset, granularity: :unset, start_time: :unset, end_time: :unset, limit: nil, page_size: nil)
+            self.stream(
+                sim: sim,
+                fleet: fleet,
+                network: network,
+                iso_country: iso_country,
+                group: group,
+                granularity: granularity,
+                start_time: start_time,
+                end_time: end_time,
+                limit: limit,
+                page_size: page_size
+            ).entries
+          end
+
+          ##
+          # Streams UsageRecordInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [String] sim SID or unique name of a Sim resource. Only show UsageRecords
+          #   representing usage incurred by this Super SIM.
+          # @param [String] fleet SID or unique name of a Fleet resource. Only show
+          #   UsageRecords representing usage for Super SIMs belonging to this Fleet resource
+          #   at the time the usage occurred.
+          # @param [String] network SID of a Network resource. Only show UsageRecords
+          #   representing usage on this network.
+          # @param [String] iso_country Alpha-2 ISO Country Code. Only show UsageRecords
+          #   representing usage in this country.
+          # @param [usage_record.Group] group Dimension over which to aggregate usage
+          #   records. Can be: `sim`, `fleet`, `network`, `isoCountry`. Default is to not
+          #   aggregate across any of these dimensions, UsageRecords will be aggregated into
+          #   the time buckets described by the `Granularity` parameter.
+          # @param [usage_record.Granularity] granularity Time-based grouping that
+          #   UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default
+          #   is `all`. `all` returns one UsageRecord that describes the usage for the entire
+          #   period.
+          # @param [Time] start_time Only include usage that occurred at or after this time,
+          #   specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default
+          #   is one month before the `end_time`.
+          # @param [Time] end_time Only include usage that occurred before this time,
+          #   specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default
+          #   is the current time.
+          # @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(sim: :unset, fleet: :unset, network: :unset, iso_country: :unset, group: :unset, granularity: :unset, start_time: :unset, end_time: :unset, limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(
+                sim: sim,
+                fleet: fleet,
+                network: network,
+                iso_country: iso_country,
+                group: group,
+                granularity: granularity,
+                start_time: start_time,
+                end_time: end_time,
+                page_size: limits[:page_size],
+            )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields UsageRecordInstance 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 UsageRecordInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] sim SID or unique name of a Sim resource. Only show UsageRecords
+          #   representing usage incurred by this Super SIM.
+          # @param [String] fleet SID or unique name of a Fleet resource. Only show
+          #   UsageRecords representing usage for Super SIMs belonging to this Fleet resource
+          #   at the time the usage occurred.
+          # @param [String] network SID of a Network resource. Only show UsageRecords
+          #   representing usage on this network.
+          # @param [String] iso_country Alpha-2 ISO Country Code. Only show UsageRecords
+          #   representing usage in this country.
+          # @param [usage_record.Group] group Dimension over which to aggregate usage
+          #   records. Can be: `sim`, `fleet`, `network`, `isoCountry`. Default is to not
+          #   aggregate across any of these dimensions, UsageRecords will be aggregated into
+          #   the time buckets described by the `Granularity` parameter.
+          # @param [usage_record.Granularity] granularity Time-based grouping that
+          #   UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default
+          #   is `all`. `all` returns one UsageRecord that describes the usage for the entire
+          #   period.
+          # @param [Time] start_time Only include usage that occurred at or after this time,
+          #   specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default
+          #   is one month before the `end_time`.
+          # @param [Time] end_time Only include usage that occurred before this time,
+          #   specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format. Default
+          #   is the current time.
+          # @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 UsageRecordInstance
+          def page(sim: :unset, fleet: :unset, network: :unset, iso_country: :unset, group: :unset, granularity: :unset, start_time: :unset, end_time: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'Sim' => sim,
+                'Fleet' => fleet,
+                'Network' => network,
+                'IsoCountry' => iso_country,
+                'Group' => group,
+                'Granularity' => granularity,
+                'StartTime' => Twilio.serialize_iso8601_datetime(start_time),
+                'EndTime' => Twilio.serialize_iso8601_datetime(end_time),
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            UsageRecordPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of UsageRecordInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of UsageRecordInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            UsageRecordPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Supersim.V1.UsageRecordList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class UsageRecordPage < Page
+          ##
+          # Initialize the UsageRecordPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [UsageRecordPage] UsageRecordPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of UsageRecordInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [UsageRecordInstance] UsageRecordInstance
+          def get_instance(payload)
+            UsageRecordInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Supersim.V1.UsageRecordPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class UsageRecordInstance < InstanceResource
+          ##
+          # Initialize the UsageRecordInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [UsageRecordInstance] UsageRecordInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'sim_sid' => payload['sim_sid'],
+                'network_sid' => payload['network_sid'],
+                'fleet_sid' => payload['fleet_sid'],
+                'iso_country' => payload['iso_country'],
+                'period' => payload['period'],
+                'data_upload' => payload['data_upload'].to_i,
+                'data_download' => payload['data_download'].to_i,
+                'data_total' => payload['data_total'].to_i,
+            }
+          end
+
+          ##
+          # @return [String] The SID of the Account that incurred the usage.
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] SID of a Sim resource to which the UsageRecord belongs.
+          def sim_sid
+            @properties['sim_sid']
+          end
+
+          ##
+          # @return [String] SID of the Network resource on which the usage occurred.
+          def network_sid
+            @properties['network_sid']
+          end
+
+          ##
+          # @return [String] SID of the Fleet resource on which the usage occurred.
+          def fleet_sid
+            @properties['fleet_sid']
+          end
+
+          ##
+          # @return [String] Alpha-2 ISO Country Code of the country the usage occurred in.
+          def iso_country
+            @properties['iso_country']
+          end
+
+          ##
+          # @return [Hash] The time period for which the usage is reported.
+          def period
+            @properties['period']
+          end
+
+          ##
+          # @return [String] Total data uploaded in bytes, aggregated by the query parameters.
+          def data_upload
+            @properties['data_upload']
+          end
+
+          ##
+          # @return [String] Total data downloaded in bytes, aggregated by the query parameters.
+          def data_download
+            @properties['data_download']
+          end
+
+          ##
+          # @return [String] Total of data_upload and data_download.
+          def data_total
+            @properties['data_total']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Supersim.V1.UsageRecordInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Supersim.V1.UsageRecordInstance>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/sync/v1/service.rb

@@ -26,8 +26,7 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of ServiceInstance records from the API.
-          # Request is executed immediately.
+          # Create the ServiceInstance
           # @param [String] friendly_name A string that you assign to describe the resource.
           # @param [String] webhook_url The URL we should call when Sync objects are
           #   manipulated.
@@ -36,7 +35,7 @@ module Twilio
           #   `false`.
           # @param [Boolean] acl_enabled Whether token identities in the Service must be
           #   granted access to Sync objects by using the
-          #   [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource.
+          #   {Permissions}[https://www.twilio.com/docs/sync/api/sync-permissions] resource.
           # @param [Boolean] reachability_debouncing_enabled Whether every
           #   `endpoint_disconnected` event should occur after a configurable delay. The
           #   default is `false`, where the `endpoint_disconnected` event occurs immediately
@@ -52,7 +51,7 @@ module Twilio
           # @param [Boolean] webhooks_from_rest_enabled Whether the Service instance should
           #   call `webhook_url` when the REST API is used to update Sync objects. The default
           #   is `false`.
-          # @return [ServiceInstance] Newly created ServiceInstance
+          # @return [ServiceInstance] Created ServiceInstance
           def create(friendly_name: :unset, webhook_url: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset, reachability_debouncing_enabled: :unset, reachability_debouncing_window: :unset, webhooks_from_rest_enabled: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
@@ -64,11 +63,7 @@ module Twilio
                 'WebhooksFromRestEnabled' => webhooks_from_rest_enabled,
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             ServiceInstance.new(@version, payload, )
           end
@@ -134,11 +129,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             ServicePage.new(@version, response, @solution)
           end
 
@@ -216,25 +209,19 @@ module Twilio
           end
 
           ##
-          # Fetch a ServiceInstance
+          # Fetch the ServiceInstance
           # @return [ServiceInstance] Fetched ServiceInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the ServiceInstance
+          # Delete the ServiceInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
@@ -247,7 +234,7 @@ module Twilio
           #   `false`.
           # @param [Boolean] acl_enabled Whether token identities in the Service must be
           #   granted access to Sync objects by using the
-          #   [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource.
+          #   {Permissions}[https://www.twilio.com/docs/sync/api/sync-permissions] resource.
           # @param [Boolean] reachability_debouncing_enabled Whether every
           #   `endpoint_disconnected` event should occur after a configurable delay. The
           #   default is `false`, where the `endpoint_disconnected` event occurs immediately
@@ -275,11 +262,7 @@ module Twilio
                 'WebhooksFromRestEnabled' => webhooks_from_rest_enabled,
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -502,14 +485,14 @@ module Twilio
           end
 
           ##
-          # Fetch a ServiceInstance
+          # Fetch the ServiceInstance
           # @return [ServiceInstance] Fetched ServiceInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Deletes the ServiceInstance
+          # Delete the ServiceInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
@@ -525,7 +508,7 @@ module Twilio
           #   `false`.
           # @param [Boolean] acl_enabled Whether token identities in the Service must be
           #   granted access to Sync objects by using the
-          #   [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource.
+          #   {Permissions}[https://www.twilio.com/docs/sync/api/sync-permissions] resource.
           # @param [Boolean] reachability_debouncing_enabled Whether every
           #   `endpoint_disconnected` event should occur after a configurable delay. The
           #   default is `false`, where the `endpoint_disconnected` event occurs immediately