twilio-ruby 5.74.0 → 7.10.1

data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb

@@ -1,268 +1,412 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Numbers
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
 #
-# frozen_string_literal: true
 
-module Twilio
-  module REST
-    class Numbers < Domain
-      class V2 < Version
-        class RegulatoryComplianceList < ListResource
-          class BundleContext < InstanceContext
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-            class BundleCopyList < ListResource
-              ##
-              # Initialize the BundleCopyList
-              # @param [Version] version Version that contains the resource
-              # @param [String] bundle_sid The unique string that we created to identify the
-              #   Bundle resource.
-              # @return [BundleCopyList] BundleCopyList
-              def initialize(version, bundle_sid: nil)
-                super(version)
-
-                # Path Solution
-                @solution = {bundle_sid: bundle_sid}
-                @uri = "/RegulatoryCompliance/Bundles/#{@solution[:bundle_sid]}/Copies"
-              end
-
-              ##
-              # Create the BundleCopyInstance
-              # @param [String] friendly_name The string that you assigned to describe the
-              #   copied bundle.
-              # @return [BundleCopyInstance] Created BundleCopyInstance
-              def create(friendly_name: :unset)
-                data = Twilio::Values.of({'FriendlyName' => friendly_name, })
-
-                payload = @version.create('POST', @uri, data: data)
-
-                BundleCopyInstance.new(@version, payload, bundle_sid: @solution[:bundle_sid], )
-              end
-
-              ##
-              # Lists BundleCopyInstance records from the API as a list.
-              # Unlike stream(), this operation is eager and will load `limit` records into
-              # memory before returning.
-              # @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(limit: nil, page_size: nil)
-                self.stream(limit: limit, page_size: page_size).entries
-              end
-
-              ##
-              # Streams BundleCopyInstance records from the API as an Enumerable.
-              # This operation lazily loads records as efficiently as possible until the limit
-              # is reached.
-              # @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(limit: nil, page_size: nil)
-                limits = @version.read_limits(limit, page_size)
-
-                page = self.page(page_size: limits[:page_size], )
-
-                @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
-              end
-
-              ##
-              # When passed a block, yields BundleCopyInstance 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 BundleCopyInstance records from the API.
-              # Request is executed immediately.
-              # @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 BundleCopyInstance
-              def page(page_token: :unset, page_number: :unset, page_size: :unset)
-                params = Twilio::Values.of({
-                    'PageToken' => page_token,
-                    'Page' => page_number,
-                    'PageSize' => page_size,
-                })
-
-                response = @version.page('GET', @uri, params: params)
-
-                BundleCopyPage.new(@version, response, @solution)
-              end
-
-              ##
-              # Retrieve a single page of BundleCopyInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] target_url API-generated URL for the requested results page
-              # @return [Page] Page of BundleCopyInstance
-              def get_page(target_url)
-                response = @version.domain.request(
-                    'GET',
-                    target_url
-                )
-                BundleCopyPage.new(@version, response, @solution)
-              end
-
-              ##
-              # Provide a user friendly representation
-              def to_s
-                '#<Twilio.Numbers.V2.BundleCopyList>'
-              end
-            end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-            class BundleCopyPage < Page
-              ##
-              # Initialize the BundleCopyPage
-              # @param [Version] version Version that contains the resource
-              # @param [Response] response Response from the API
-              # @param [Hash] solution Path solution for the resource
-              # @return [BundleCopyPage] BundleCopyPage
-              def initialize(version, response, solution)
-                super(version, response)
-
-                # Path Solution
-                @solution = solution
-              end
-
-              ##
-              # Build an instance of BundleCopyInstance
-              # @param [Hash] payload Payload response from the API
-              # @return [BundleCopyInstance] BundleCopyInstance
-              def get_instance(payload)
-                BundleCopyInstance.new(@version, payload, bundle_sid: @solution[:bundle_sid], )
-              end
-
-              ##
-              # Provide a user friendly representation
-              def to_s
-                '<Twilio.Numbers.V2.BundleCopyPage>'
-              end
-            end
-
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-            class BundleCopyInstance < InstanceResource
-              ##
-              # Initialize the BundleCopyInstance
-              # @param [Version] version Version that contains the resource
-              # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] bundle_sid The unique string that we created to identify the
-              #   Bundle resource.
-              # @return [BundleCopyInstance] BundleCopyInstance
-              def initialize(version, payload, bundle_sid: nil)
-                super(version)
-
-                # Marshaled Properties
-                @properties = {
-                    'sid' => payload['sid'],
-                    'account_sid' => payload['account_sid'],
-                    'regulation_sid' => payload['regulation_sid'],
-                    'friendly_name' => payload['friendly_name'],
-                    'status' => payload['status'],
-                    'valid_until' => Twilio.deserialize_iso8601_datetime(payload['valid_until']),
-                    'email' => payload['email'],
-                    'status_callback' => payload['status_callback'],
-                    'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
-                    'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                }
-              end
-
-              ##
-              # @return [String] The unique string that identifies the resource
-              def sid
-                @properties['sid']
-              end
-
-              ##
-              # @return [String] The SID of the Account that created the resource
-              def account_sid
-                @properties['account_sid']
-              end
-
-              ##
-              # @return [String] The unique string of a regulation
-              def regulation_sid
-                @properties['regulation_sid']
-              end
-
-              ##
-              # @return [String] The string that you assigned to describe the resource
-              def friendly_name
-                @properties['friendly_name']
-              end
-
-              ##
-              # @return [bundle_copy.Status] The verification status of the Bundle resource
-              def status
-                @properties['status']
-              end
-
-              ##
-              # @return [Time] The ISO 8601 date and time in GMT when the resource will be valid until
-              def valid_until
-                @properties['valid_until']
-              end
-
-              ##
-              # @return [String] The email address
-              def email
-                @properties['email']
-              end
-
-              ##
-              # @return [String] The URL we call to inform your application of status changes
-              def status_callback
-                @properties['status_callback']
-              end
-
-              ##
-              # @return [Time] The ISO 8601 date and time in GMT when the resource was created
-              def date_created
-                @properties['date_created']
-              end
-
-              ##
-              # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
-              def date_updated
-                @properties['date_updated']
-              end
-
-              ##
-              # Provide a user friendly representation
-              def to_s
-                "<Twilio.Numbers.V2.BundleCopyInstance>"
-              end
-
-              ##
-              # Provide a detailed, user friendly representation
-              def inspect
-                "<Twilio.Numbers.V2.BundleCopyInstance>"
-              end
+module Twilio
+    module REST
+        class Numbers < NumbersBase
+            class V2 < Version
+                class RegulatoryComplianceList < ListResource
+                class BundleContext < InstanceContext
+
+                     class BundleCopyList < ListResource
+                
+                    ##
+                    # Initialize the BundleCopyList
+                    # @param [Version] version Version that contains the resource
+                    # @return [BundleCopyList] BundleCopyList
+                    def initialize(version, bundle_sid: nil)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = { bundle_sid: bundle_sid }
+                        @uri = "/RegulatoryCompliance/Bundles/#{@solution[:bundle_sid]}/Copies"
+                        
+                    end
+                    ##
+                    # Create the BundleCopyInstance
+                    # @param [String] friendly_name The string that you assigned to describe the copied bundle.
+                    # @return [BundleCopyInstance] Created BundleCopyInstance
+                    def create(
+                        friendly_name: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
+                        BundleCopyInstance.new(
+                            @version,
+                            payload,
+                            bundle_sid: @solution[:bundle_sid],
+                        )
+                    end
+
+                    ##
+                    # Create the BundleCopyInstanceMetadata
+                    # @param [String] friendly_name The string that you assigned to describe the copied bundle.
+                    # @return [BundleCopyInstance] Created BundleCopyInstance
+                    def create_with_metadata(
+                      friendly_name: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        bundle_copy_instance = BundleCopyInstance.new(
+                            @version,
+                            response.body,
+                            bundle_sid: @solution[:bundle_sid],
+                        )
+                        BundleCopyInstanceMetadata.new(
+                            @version,
+                            bundle_copy_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+                    ##
+                    # Lists BundleCopyInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @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(limit: nil, page_size: nil)
+                        self.stream(
+                            limit: limit,
+                            page_size: page_size
+                        ).entries
+                    end
+
+                    ##
+                    # Streams Instance records from the API as an Enumerable.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    # @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(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            page_size: limits[:page_size], )
+
+                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                    end
+
+                    ##
+                    # Lists BundleCopyPageMetadata 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)
+
+                        BundleCopyPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields BundleCopyInstance 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 BundleCopyInstance records from the API.
+                    # Request is executed immediately.
+                    # @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 BundleCopyInstance
+                    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, headers: headers)
+
+                        BundleCopyPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of BundleCopyInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of BundleCopyInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    BundleCopyPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Numbers.V2.BundleCopyList>'
+                    end
+                end
+
+                class BundleCopyPage < Page
+                    ##
+                    # Initialize the BundleCopyPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [BundleCopyPage] BundleCopyPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of BundleCopyInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [BundleCopyInstance] BundleCopyInstance
+                    def get_instance(payload)
+                        BundleCopyInstance.new(@version, payload, bundle_sid: @solution[:bundle_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Numbers.V2.BundleCopyPage>'
+                    end
+                end
+
+                class BundleCopyPageMetadata < PageMetadata
+                    attr_reader :bundle_copy_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @bundle_copy_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @bundle_copy_page << BundleCopyListResponse.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
+                        @bundle_copy_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V2PageMetadata>';
+                    end
+                end
+                class BundleCopyListResponse < InstanceListResource
+
+                    # @param [Array<BundleCopyInstance>] 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
+                      @bundle_copy = data_list.map do |data|
+                        BundleCopyInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def bundle_copy
+                        @bundle_copy
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class BundleCopyInstance < InstanceResource
+                    ##
+                    # Initialize the BundleCopyInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this BundleCopy
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [BundleCopyInstance] BundleCopyInstance
+                    def initialize(version, payload , bundle_sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'account_sid' => payload['account_sid'],
+                            'regulation_sid' => payload['regulation_sid'],
+                            'friendly_name' => payload['friendly_name'],
+                            'status' => payload['status'],
+                            'valid_until' => Twilio.deserialize_iso8601_datetime(payload['valid_until']),
+                            'email' => payload['email'],
+                            'status_callback' => payload['status_callback'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] The unique string that we created to identify the Bundle resource.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Bundle resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique string of a regulation that is associated to the Bundle resource.
+                    def regulation_sid
+                        @properties['regulation_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The string that you assigned to describe the resource.
+                    def friendly_name
+                        @properties['friendly_name']
+                    end
+                    
+                    ##
+                    # @return [Status] 
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until.
+                    def valid_until
+                        @properties['valid_until']
+                    end
+                    
+                    ##
+                    # @return [String] The email address that will receive updates when the Bundle resource changes status.
+                    def email
+                        @properties['email']
+                    end
+                    
+                    ##
+                    # @return [String] The URL we call to inform your application of status changes.
+                    def status_callback
+                        @properties['status_callback']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Numbers.V2.BundleCopyInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Numbers.V2.BundleCopyInstance>"
+                    end
+                end
+
+             end
+             end
             end
-          end
         end
-      end
     end
-  end
-end
+end
+
+