twilio-ruby 7.3.3 → 7.10.1

data/lib/twilio-ruby/rest/bulkexports/v1/export/day.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [DayList] DayList
                     def initialize(version, resource_type: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { resource_type: resource_type }
                         @uri = "/Exports/#{@solution[:resource_type]}/Days"
@@ -71,6 +72,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists DayPageMetadata 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)
+
+                        DayPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields DayInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -92,14 +115,17 @@ 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 DayInstance
-                    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,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         DayPage.new(@version, response, @solution)
                     end
@@ -135,6 +161,7 @@ module Twilio
                     # @return [DayContext] DayContext
                     def initialize(version, resource_type, day)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { resource_type: resource_type, day: day,  }
@@ -149,6 +176,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, headers: headers)
                         DayInstance.new(
                             @version,
@@ -158,6 +189,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the DayInstanceMetadata
+                    # @return [DayInstance] Fetched DayInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        day_instance = DayInstance.new(
+                            @version,
+                            response.body,
+                            resource_type: @solution[:resource_type],
+                            day: @solution[:day],
+                        )
+                        DayInstanceMetadata.new(
+                            @version,
+                            day_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -174,6 +231,53 @@ module Twilio
                     end
                 end
 
+                class DayInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new DayInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}DayInstance] day_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 [DayInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, day_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @day_instance = day_instance
+                    end
+
+                    def day
+                        @day_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.DayInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class DayListResponse < InstanceListResource
+                    # @param [Array<DayInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @day_instance = payload.body[key].map do |data|
+                        DayInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def day_instance
+                          @instance
+                      end
+                  end
+
                 class DayPage < Page
                     ##
                     # Initialize the DayPage
@@ -183,6 +287,7 @@ module Twilio
                     # @return [DayPage] DayPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -202,6 +307,66 @@ module Twilio
                         '<Twilio.Bulkexports.V1.DayPage>'
                     end
                 end
+
+                class DayPageMetadata < PageMetadata
+                    attr_reader :day_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @day_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @day_page << DayListResponse.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
+                        @day_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Bulkexports::V1PageMetadata>';
+                    end
+                end
+                class DayListResponse < InstanceListResource
+
+                    # @param [Array<DayInstance>] 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
+                      @day = data_list.map do |data|
+                        DayInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def day
+                        @day
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class DayInstance < InstanceResource
                     ##
                     # Initialize the DayInstance
@@ -215,6 +380,7 @@ module Twilio
                     def initialize(version, payload , resource_type: nil, day: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'redirect_to' => payload['redirect_to'],

data/lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [ExportCustomJobList] ExportCustomJobList
                     def initialize(version, resource_type: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { resource_type: resource_type }
                         @uri = "/Exports/#{@solution[:resource_type]}/Jobs"
@@ -61,6 +62,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.create('POST', @uri, data: data, headers: headers)
                         ExportCustomJobInstance.new(
                             @version,
@@ -69,6 +74,53 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the ExportCustomJobInstanceMetadata
+                    # @param [String] start_day The start day for the custom export specified as a string in the format of yyyy-mm-dd
+                    # @param [String] end_day The end day for the custom export specified as a string in the format of yyyy-mm-dd. End day is inclusive and must be 2 days earlier than the current UTC day.
+                    # @param [String] friendly_name The friendly name specified when creating the job
+                    # @param [String] webhook_url The optional webhook url called on completion of the job. If this is supplied, `WebhookMethod` must also be supplied. If you set neither webhook nor email, you will have to check your job's status manually.
+                    # @param [String] webhook_method This is the method used to call the webhook on completion of the job. If this is supplied, `WebhookUrl` must also be supplied.
+                    # @param [String] email The optional email to send the completion notification to. You can set both webhook, and email, or one or the other. If you set neither, the job will run but you will have to query to determine your job's status.
+                    # @return [ExportCustomJobInstance] Created ExportCustomJobInstance
+                    def create_with_metadata(
+                      start_day: nil, 
+                      end_day: nil, 
+                      friendly_name: nil, 
+                      webhook_url: :unset, 
+                      webhook_method: :unset, 
+                      email: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'StartDay' => start_day,
+                            'EndDay' => end_day,
+                            'FriendlyName' => friendly_name,
+                            'WebhookUrl' => webhook_url,
+                            'WebhookMethod' => webhook_method,
+                            'Email' => email,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        export_custom_job_instance = ExportCustomJobInstance.new(
+                            @version,
+                            response.body,
+                            resource_type: @solution[:resource_type],
+                        )
+                        ExportCustomJobInstanceMetadata.new(
+                            @version,
+                            export_custom_job_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists ExportCustomJobInstance records from the API as a list.
@@ -108,6 +160,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists ExportCustomJobPageMetadata 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)
+
+                        ExportCustomJobPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields ExportCustomJobInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -129,14 +203,17 @@ 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 ExportCustomJobInstance
-                    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,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         ExportCustomJobPage.new(@version, response, @solution)
                     end
@@ -171,6 +248,7 @@ module Twilio
                     # @return [ExportCustomJobPage] ExportCustomJobPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -190,6 +268,66 @@ module Twilio
                         '<Twilio.Bulkexports.V1.ExportCustomJobPage>'
                     end
                 end
+
+                class ExportCustomJobPageMetadata < PageMetadata
+                    attr_reader :export_custom_job_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @export_custom_job_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @export_custom_job_page << ExportCustomJobListResponse.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
+                        @export_custom_job_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Bulkexports::V1PageMetadata>';
+                    end
+                end
+                class ExportCustomJobListResponse < InstanceListResource
+
+                    # @param [Array<ExportCustomJobInstance>] 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
+                      @export_custom_job = data_list.map do |data|
+                        ExportCustomJobInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def export_custom_job
+                        @export_custom_job
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class ExportCustomJobInstance < InstanceResource
                     ##
                     # Initialize the ExportCustomJobInstance
@@ -203,6 +341,7 @@ module Twilio
                     def initialize(version, payload , resource_type: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'friendly_name' => payload['friendly_name'],
@@ -269,7 +408,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Hash] The details of a job which is an object that contains an array of status grouped by `status` state.  Each `status` object has a `status` string, a count which is the number of days in that `status`, and list of days in that `status`. The day strings are in the format yyyy-MM-dd. As an example, a currently running job may have a status object for COMPLETED and a `status` object for SUBMITTED each with its own count and list of days.
+                    # @return [Array<Hash>] The details of a job which is an object that contains an array of status grouped by `status` state.  Each `status` object has a `status` string, a count which is the number of days in that `status`, and list of days in that `status`. The day strings are in the format yyyy-MM-dd. As an example, a currently running job may have a status object for COMPLETED and a `status` object for SUBMITTED each with its own count and list of days.
                     def details
                         @properties['details']
                     end

data/lib/twilio-ruby/rest/bulkexports/v1/export/job.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [JobList] JobList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         
@@ -50,6 +51,7 @@ module Twilio
                     # @return [JobContext] JobContext
                     def initialize(version, job_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { job_sid: job_sid,  }
@@ -64,9 +66,31 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the JobInstanceMetadata
+                    # @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)
+                          job_instance = JobInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          JobInstanceMetadata.new(@version, job_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the JobInstance
                     # @return [JobInstance] Fetched JobInstance
@@ -74,6 +98,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, headers: headers)
                         JobInstance.new(
                             @version,
@@ -82,6 +110,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the JobInstanceMetadata
+                    # @return [JobInstance] Fetched JobInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        job_instance = JobInstance.new(
+                            @version,
+                            response.body,
+                            job_sid: @solution[:job_sid],
+                        )
+                        JobInstanceMetadata.new(
+                            @version,
+                            job_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -98,6 +151,53 @@ module Twilio
                     end
                 end
 
+                class JobInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new JobInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}JobInstance] job_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 [JobInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, job_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @job_instance = job_instance
+                    end
+
+                    def job
+                        @job_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.JobInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class JobListResponse < InstanceListResource
+                    # @param [Array<JobInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @job_instance = payload.body[key].map do |data|
+                        JobInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def job_instance
+                          @instance
+                      end
+                  end
+
                 class JobPage < Page
                     ##
                     # Initialize the JobPage
@@ -107,6 +207,7 @@ module Twilio
                     # @return [JobPage] JobPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -126,6 +227,66 @@ module Twilio
                         '<Twilio.Bulkexports.V1.JobPage>'
                     end
                 end
+
+                class JobPageMetadata < PageMetadata
+                    attr_reader :job_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @job_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @job_page << JobListResponse.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
+                        @job_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Bulkexports::V1PageMetadata>';
+                    end
+                end
+                class JobListResponse < InstanceListResource
+
+                    # @param [Array<JobInstance>] 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
+                      @job = data_list.map do |data|
+                        JobInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def job
+                        @job
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class JobInstance < InstanceResource
                     ##
                     # Initialize the JobInstance
@@ -139,6 +300,7 @@ module Twilio
                     def initialize(version, payload , job_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'resource_type' => payload['resource_type'],
@@ -184,7 +346,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Hash] The details of a job which is an object that contains an array of status grouped by `status` state.  Each `status` object has a `status` string, a count which is the number of days in that `status`, and list of days in that `status`. The day strings are in the format yyyy-MM-dd. As an example, a currently running job may have a status object for COMPLETED and a `status` object for SUBMITTED each with its own count and list of days.
+                    # @return [Array<Hash>] The details of a job which is an object that contains an array of status grouped by `status` state.  Each `status` object has a `status` string, a count which is the number of days in that `status`, and list of days in that `status`. The day strings are in the format yyyy-MM-dd. As an example, a currently running job may have a status object for COMPLETED and a `status` object for SUBMITTED each with its own count and list of days.
                     def details
                         @properties['details']
                     end