twilio-ruby 5.39.2 → 5.60.0

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

@@ -11,7 +11,7 @@ module Twilio
     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.
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class UsageRecordList < ListResource
           ##
           # Initialize the UsageRecordList
@@ -29,17 +29,28 @@ module Twilio
           # 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 of a Sim resource. Only show UsageRecords representing
-          #   usage incurred by this Super SIM.
+          # @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
+          #   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
+          #   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
@@ -48,9 +59,13 @@ module Twilio
           #    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, granularity: :unset, start_time: :unset, end_time: :unset, limit: nil, page_size: nil)
+          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,
@@ -63,17 +78,28 @@ module Twilio
           # 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 of a Sim resource. Only show UsageRecords representing
-          #   usage incurred by this Super SIM.
+          # @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
+          #   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
+          #   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.
@@ -82,11 +108,15 @@ module Twilio
           #    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, granularity: :unset, start_time: :unset, end_time: :unset, limit: nil, page_size: nil)
+          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,
@@ -113,25 +143,40 @@ module Twilio
           ##
           # Retrieve a single page of UsageRecordInstance records from the API.
           # Request is executed immediately.
-          # @param [String] sim SID of a Sim resource. Only show UsageRecords representing
-          #   usage incurred by this Super SIM.
+          # @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
+          #   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
+          #   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, granularity: :unset, start_time: :unset, end_time: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+          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),
@@ -166,7 +211,7 @@ module Twilio
         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.
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class UsageRecordPage < Page
           ##
           # Initialize the UsageRecordPage
@@ -197,7 +242,7 @@ module Twilio
         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.
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class UsageRecordInstance < InstanceResource
           ##
           # Initialize the UsageRecordInstance
@@ -211,6 +256,9 @@ module Twilio
             @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,
@@ -230,6 +278,24 @@ module Twilio
             @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

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

@@ -20,6 +20,7 @@ module Twilio
           @networks = nil
           @network_access_profiles = nil
           @sims = nil
+          @sms_commands = nil
           @usage_records = nil
         end
 
@@ -29,11 +30,12 @@ module Twilio
         # @return [Twilio::REST::Supersim::V1::CommandList]
         def commands(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @commands ||= CommandList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @commands ||= CommandList.new self
           else
-            CommandContext.new(self, sid)
+              CommandContext.new(self, sid)
           end
         end
 
@@ -43,11 +45,12 @@ module Twilio
         # @return [Twilio::REST::Supersim::V1::FleetList]
         def fleets(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @fleets ||= FleetList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @fleets ||= FleetList.new self
           else
-            FleetContext.new(self, sid)
+              FleetContext.new(self, sid)
           end
         end
 
@@ -57,11 +60,12 @@ module Twilio
         # @return [Twilio::REST::Supersim::V1::NetworkList]
         def networks(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @networks ||= NetworkList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @networks ||= NetworkList.new self
           else
-            NetworkContext.new(self, sid)
+              NetworkContext.new(self, sid)
           end
         end
 
@@ -71,11 +75,12 @@ module Twilio
         # @return [Twilio::REST::Supersim::V1::NetworkAccessProfileList]
         def network_access_profiles(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @network_access_profiles ||= NetworkAccessProfileList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @network_access_profiles ||= NetworkAccessProfileList.new self
           else
-            NetworkAccessProfileContext.new(self, sid)
+              NetworkAccessProfileContext.new(self, sid)
           end
         end
 
@@ -85,11 +90,27 @@ module Twilio
         # @return [Twilio::REST::Supersim::V1::SimList]
         def sims(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @sims ||= SimList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @sims ||= SimList.new self
+          else
+              SimContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @param [String] sid The SID of the SMS Command resource to fetch.
+        # @return [Twilio::REST::Supersim::V1::SmsCommandContext] if sid was passed.
+        # @return [Twilio::REST::Supersim::V1::SmsCommandList]
+        def sms_commands(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @sms_commands ||= SmsCommandList.new self
           else
-            SimContext.new(self, sid)
+              SmsCommandContext.new(self, sid)
           end
         end
 

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

@@ -72,6 +72,15 @@ module Twilio
         self.v1.sims(sid)
       end
 
+      ##
+      # @param [String] sid The unique string that we created to identify the SMS
+      #   Command resource.
+      # @return [Twilio::REST::Supersim::V1::SmsCommandInstance] if sid was passed.
+      # @return [Twilio::REST::Supersim::V1::SmsCommandList]
+      def sms_commands(sid=:unset)
+        self.v1.sms_commands(sid)
+      end
+
       ##
       # @return [Twilio::REST::Supersim::V1::UsageRecordInstance]
       def usage_records

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

@@ -12,14 +12,12 @@ module Twilio
       class V1 < Version
         class ServiceContext < InstanceContext
           class DocumentContext < InstanceContext
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class DocumentPermissionList < ListResource
               ##
               # Initialize the DocumentPermissionList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The SID of the [Sync
-              #   Service](https://www.twilio.com/docs/sync/api/service) the resource is
+              # @param [String] service_sid The SID of the {Sync
+              #   Service}[https://www.twilio.com/docs/sync/api/service] the resource is
               #   associated with.
               # @param [String] document_sid The SID of the Sync Document to which the Document
               #   Permission applies.
@@ -119,8 +117,6 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class DocumentPermissionPage < Page
               ##
               # Initialize the DocumentPermissionPage
@@ -155,14 +151,12 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class DocumentPermissionContext < InstanceContext
               ##
               # Initialize the DocumentPermissionContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The SID of the [Sync
-              #   Service](https://www.twilio.com/docs/sync/api/service) with the Document
+              # @param [String] service_sid The SID of the {Sync
+              #   Service}[https://www.twilio.com/docs/sync/api/service] with the Document
               #   Permission resource to fetch.
               # @param [String] document_sid The SID of the Sync Document with the Document
               #   Permission resource to fetch. Can be the Document resource's `sid` or its
@@ -238,15 +232,13 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class DocumentPermissionInstance < InstanceResource
               ##
               # Initialize the DocumentPermissionInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] service_sid The SID of the [Sync
-              #   Service](https://www.twilio.com/docs/sync/api/service) the resource is
+              # @param [String] service_sid The SID of the {Sync
+              #   Service}[https://www.twilio.com/docs/sync/api/service] the resource is
               #   associated with.
               # @param [String] document_sid The SID of the Sync Document to which the Document
               #   Permission applies.

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

@@ -11,14 +11,12 @@ module Twilio
     class Sync < Domain
       class V1 < Version
         class ServiceContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class DocumentList < ListResource
             ##
             # Initialize the DocumentList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The SID of the [Sync
-            #   Service](https://www.twilio.com/docs/sync/api/service) the resource is
+            # @param [String] service_sid The SID of the {Sync
+            #   Service}[https://www.twilio.com/docs/sync/api/service] the resource is
             #   associated with.
             # @return [DocumentList] DocumentList
             def initialize(version, service_sid: nil)
@@ -34,13 +32,10 @@ module Twilio
             # @param [String] unique_name An application-defined string that uniquely
             #   identifies the Sync Document
             # @param [Hash] data A JSON string that represents an arbitrary, schema-less
-            #   object that the Sync Document stores. Can be up to 16KB in length.
-            # @param [String] ttl How long, in seconds, before the Sync Document expires and
-            #   is deleted (the Sync Document's time-to-live). Can be an integer from 0 to
-            #   31,536,000 (1 year). The default value is `0`, which means the Sync Document
-            #   does not expire. The Sync Document will be deleted automatically after it
-            #   expires, but there can be a delay between the expiration time and the
-            #   resources's deletion.
+            #   object that the Sync Document stores. Can be up to 16 KiB in length.
+            # @param [String] ttl How long, {in
+            #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+            #   the Sync Document expires and is deleted (the Sync Document's time-to-live).
             # @return [DocumentInstance] Created DocumentInstance
             def create(unique_name: :unset, data: :unset, ttl: :unset)
               data = Twilio::Values.of({
@@ -141,8 +136,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class DocumentPage < Page
             ##
             # Initialize the DocumentPage
@@ -172,16 +165,15 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class DocumentContext < InstanceContext
             ##
             # Initialize the DocumentContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The SID of the [Sync
-            #   Service](https://www.twilio.com/docs/sync/api/service) with the Document
+            # @param [String] service_sid The SID of the {Sync
+            #   Service}[https://www.twilio.com/docs/sync/api/service] with the Document
             #   resource to fetch.
-            # @param [String] sid The SID of the Document resource to fetch.
+            # @param [String] sid The SID of the Document resource to fetch. Can be the
+            #   Document resource's `sid` or its `unique_name`.
             # @return [DocumentContext] DocumentContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -205,23 +197,18 @@ module Twilio
 
             ##
             # Delete the DocumentInstance
-            # @param [String] if_match The If-Match HTTP request header
             # @return [Boolean] true if delete succeeds, false otherwise
-            def delete(if_match: :unset)
-              headers = Twilio::Values.of({'If-Match' => if_match, })
-
-               @version.delete('DELETE', @uri, headers: headers)
+            def delete
+               @version.delete('DELETE', @uri)
             end
 
             ##
             # Update the DocumentInstance
             # @param [Hash] data A JSON string that represents an arbitrary, schema-less
-            #   object that the Sync Document stores. Can be up to 16KB in length.
-            # @param [String] ttl How long, in seconds, before the Sync Document expires and
-            #   is deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The
-            #   default value is `0`, which means the Document resource does not expire. The
-            #   Document resource will be deleted automatically after it expires, but there can
-            #   be a delay between the expiration time and the resources's deletion.
+            #   object that the Sync Document stores. Can be up to 16 KiB in length.
+            # @param [String] ttl How long, {in
+            #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+            #   the Sync Document expires and is deleted (time-to-live).
             # @param [String] if_match The If-Match HTTP request header
             # @return [DocumentInstance] Updated DocumentInstance
             def update(data: :unset, ttl: :unset, if_match: :unset)
@@ -270,17 +257,16 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class DocumentInstance < InstanceResource
             ##
             # Initialize the DocumentInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The SID of the [Sync
-            #   Service](https://www.twilio.com/docs/sync/api/service) the resource is
+            # @param [String] service_sid The SID of the {Sync
+            #   Service}[https://www.twilio.com/docs/sync/api/service] the resource is
             #   associated with.
-            # @param [String] sid The SID of the Document resource to fetch.
+            # @param [String] sid The SID of the Document resource to fetch. Can be the
+            #   Document resource's `sid` or its `unique_name`.
             # @return [DocumentInstance] DocumentInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -398,21 +384,18 @@ module Twilio
 
             ##
             # Delete the DocumentInstance
-            # @param [String] if_match The If-Match HTTP request header
             # @return [Boolean] true if delete succeeds, false otherwise
-            def delete(if_match: :unset)
-              context.delete(if_match: if_match, )
+            def delete
+              context.delete
             end
 
             ##
             # Update the DocumentInstance
             # @param [Hash] data A JSON string that represents an arbitrary, schema-less
-            #   object that the Sync Document stores. Can be up to 16KB in length.
-            # @param [String] ttl How long, in seconds, before the Sync Document expires and
-            #   is deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The
-            #   default value is `0`, which means the Document resource does not expire. The
-            #   Document resource will be deleted automatically after it expires, but there can
-            #   be a delay between the expiration time and the resources's deletion.
+            #   object that the Sync Document stores. Can be up to 16 KiB in length.
+            # @param [String] ttl How long, {in
+            #   seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before
+            #   the Sync Document expires and is deleted (time-to-live).
             # @param [String] if_match The If-Match HTTP request header
             # @return [DocumentInstance] Updated DocumentInstance
             def update(data: :unset, ttl: :unset, if_match: :unset)