twilio-ruby 7.9.1 → 7.10.0

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

@@ -25,6 +25,7 @@ module Twilio
                     # @return [UsageRecordList] UsageRecordList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/UsageRecords"
@@ -101,6 +102,44 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists UsageRecordPageMetadata records from the API as a list.
+                      # @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 [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 [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 (exclusive), 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_with_metadata(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)
+                        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),
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        UsageRecordPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields UsageRecordInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -130,7 +169,7 @@ module Twilio
                     # @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)
+                    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,
@@ -183,6 +222,7 @@ module Twilio
                     # @return [UsageRecordPage] UsageRecordPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -202,6 +242,66 @@ module Twilio
                         '<Twilio.Supersim.V1.UsageRecordPage>'
                     end
                 end
+
+                class UsageRecordPageMetadata < PageMetadata
+                    attr_reader :usage_record_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @usage_record_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @usage_record_page << UsageRecordListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @usage_record_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Supersim::V1PageMetadata>';
+                    end
+                end
+                class UsageRecordListResponse < InstanceListResource
+
+                    # @param [Array<UsageRecordInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @usage_record = data_list.map do |data|
+                        UsageRecordInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def usage_record
+                        @usage_record
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class UsageRecordInstance < InstanceResource
                     ##
                     # Initialize the UsageRecordInstance
@@ -215,6 +315,7 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],

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

@@ -28,6 +28,7 @@ module Twilio
                     # @return [DocumentPermissionList] DocumentPermissionList
                     def initialize(version, service_sid: nil, document_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid, document_sid: document_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/Documents/#{@solution[:document_sid]}/Permissions"
@@ -72,6 +73,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists DocumentPermissionPageMetadata records from the API as a list.
+                    # @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_with_metadata(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        DocumentPermissionPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields DocumentPermissionInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -93,7 +116,7 @@ module Twilio
                     # @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 DocumentPermissionInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'PageToken' => page_token,
                             'Page' => page_number,
@@ -140,6 +163,7 @@ module Twilio
                     # @return [DocumentPermissionContext] DocumentPermissionContext
                     def initialize(version, service_sid, document_sid, identity)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { service_sid: service_sid, document_sid: document_sid, identity: identity,  }
@@ -156,9 +180,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the DocumentPermissionInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          documentPermission_instance = DocumentPermissionInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          DocumentPermissionInstanceMetadata.new(@version, documentPermission_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the DocumentPermissionInstance
                     # @return [DocumentPermissionInstance] Fetched DocumentPermissionInstance
@@ -180,6 +224,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the DocumentPermissionInstanceMetadata
+                    # @return [DocumentPermissionInstance] Fetched DocumentPermissionInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        document_permission_instance = DocumentPermissionInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            document_sid: @solution[:document_sid],
+                            identity: @solution[:identity],
+                        )
+                        DocumentPermissionInstanceMetadata.new(
+                            @version,
+                            document_permission_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the DocumentPermissionInstance
                     # @param [Boolean] read Whether the identity can read the Sync Document. Default value is `false`.
@@ -214,6 +285,46 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the DocumentPermissionInstanceMetadata
+                    # @param [Boolean] read Whether the identity can read the Sync Document. Default value is `false`.
+                    # @param [Boolean] write Whether the identity can update the Sync Document. Default value is `false`.
+                    # @param [Boolean] manage Whether the identity can delete the Sync Document. Default value is `false`.
+                    # @return [DocumentPermissionInstance] Updated DocumentPermissionInstance
+                    def update_with_metadata(
+                      read: nil, 
+                      write: nil, 
+                      manage: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Read' => read,
+                            'Write' => write,
+                            'Manage' => manage,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        document_permission_instance = DocumentPermissionInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            document_sid: @solution[:document_sid],
+                            identity: @solution[:identity],
+                        )
+                        DocumentPermissionInstanceMetadata.new(
+                            @version,
+                            document_permission_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -230,6 +341,53 @@ module Twilio
                     end
                 end
 
+                class DocumentPermissionInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new DocumentPermissionInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}DocumentPermissionInstance] document_permission_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [DocumentPermissionInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, document_permission_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @document_permission_instance = document_permission_instance
+                    end
+
+                    def document_permission
+                        @document_permission_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.DocumentPermissionInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class DocumentPermissionListResponse < InstanceListResource
+                    # @param [Array<DocumentPermissionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @document_permission_instance = payload.body[key].map do |data|
+                        DocumentPermissionInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def document_permission_instance
+                          @instance
+                      end
+                  end
+
                 class DocumentPermissionPage < Page
                     ##
                     # Initialize the DocumentPermissionPage
@@ -239,6 +397,7 @@ module Twilio
                     # @return [DocumentPermissionPage] DocumentPermissionPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -258,6 +417,66 @@ module Twilio
                         '<Twilio.Sync.V1.DocumentPermissionPage>'
                     end
                 end
+
+                class DocumentPermissionPageMetadata < PageMetadata
+                    attr_reader :document_permission_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @document_permission_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @document_permission_page << DocumentPermissionListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @document_permission_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Sync::V1PageMetadata>';
+                    end
+                end
+                class DocumentPermissionListResponse < InstanceListResource
+
+                    # @param [Array<DocumentPermissionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @document_permission = data_list.map do |data|
+                        DocumentPermissionInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def document_permission
+                        @document_permission
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class DocumentPermissionInstance < InstanceResource
                     ##
                     # Initialize the DocumentPermissionInstance
@@ -271,6 +490,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, document_sid: nil, identity: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],