twilio-ruby 5.74.0 → 7.10.1

data/lib/twilio-ruby/rest/numbers/v2/bundle_clone.rb

@@ -0,0 +1,430 @@
+##
+#    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.
+#
+
+
+module Twilio
+    module REST
+        class Numbers < NumbersBase
+            class V2 < Version
+                class BundleCloneList < ListResource
+                
+                    ##
+                    # Initialize the BundleCloneList
+                    # @param [Version] version Version that contains the resource
+                    # @return [BundleCloneList] BundleCloneList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Numbers.V2.BundleCloneList>'
+                    end
+                end
+
+
+                class BundleCloneContext < InstanceContext
+                    ##
+                    # Initialize the BundleCloneContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] bundle_sid The unique string that identifies the Bundle to be cloned.
+                    # @return [BundleCloneContext] BundleCloneContext
+                    def initialize(version, bundle_sid)
+                        super(version)
+                        
+
+                        # Path Solution
+                        @solution = { bundle_sid: bundle_sid,  }
+                        @uri = "/RegulatoryCompliance/Bundles/#{@solution[:bundle_sid]}/Clones"
+
+                        
+                    end
+                    ##
+                    # Create the BundleCloneInstance
+                    # @param [String] target_account_sid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) where the bundle needs to be cloned.
+                    # @param [Boolean] move_to_draft If set to true, the cloned bundle will be in the DRAFT state, else it will be twilio-approved
+                    # @param [String] friendly_name The string that you assigned to describe the cloned bundle.
+                    # @return [BundleCloneInstance] Created BundleCloneInstance
+                    def create(
+                        target_account_sid: nil, 
+                        move_to_draft: :unset, 
+                        friendly_name: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'TargetAccountSid' => target_account_sid,
+                            'MoveToDraft' => move_to_draft,
+                            'FriendlyName' => friendly_name,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
+                        BundleCloneInstance.new(
+                            @version,
+                            payload,
+                            bundle_sid: @solution[:bundle_sid],
+                        )
+                    end
+
+                    ##
+                    # Create the BundleCloneInstanceMetadata
+                    # @param [String] target_account_sid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) where the bundle needs to be cloned.
+                    # @param [Boolean] move_to_draft If set to true, the cloned bundle will be in the DRAFT state, else it will be twilio-approved
+                    # @param [String] friendly_name The string that you assigned to describe the cloned bundle.
+                    # @return [BundleCloneInstance] Created BundleCloneInstance
+                    def create_with_metadata(
+                      target_account_sid: nil, 
+                      move_to_draft: :unset, 
+                      friendly_name: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'TargetAccountSid' => target_account_sid,
+                            'MoveToDraft' => move_to_draft,
+                            '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_clone_instance = BundleCloneInstance.new(
+                            @version,
+                            response.body,
+                            bundle_sid: @solution[:bundle_sid],
+                        )
+                        BundleCloneInstanceMetadata.new(
+                            @version,
+                            bundle_clone_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Numbers.V2.BundleCloneContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Numbers.V2.BundleCloneContext #{context}>"
+                    end
+                end
+
+                class BundleCloneInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new BundleCloneInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}BundleCloneInstance] bundle_clone_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 [BundleCloneInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, bundle_clone_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @bundle_clone_instance = bundle_clone_instance
+                    end
+
+                    def bundle_clone
+                        @bundle_clone_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.BundleCloneInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class BundleCloneListResponse < InstanceListResource
+                    # @param [Array<BundleCloneInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @bundle_clone_instance = payload.body[key].map do |data|
+                        BundleCloneInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def bundle_clone_instance
+                          @instance
+                      end
+                  end
+
+                class BundleClonePage < Page
+                    ##
+                    # Initialize the BundleClonePage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [BundleClonePage] BundleClonePage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of BundleCloneInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [BundleCloneInstance] BundleCloneInstance
+                    def get_instance(payload)
+                        BundleCloneInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Numbers.V2.BundleClonePage>'
+                    end
+                end
+
+                class BundleClonePageMetadata < PageMetadata
+                    attr_reader :bundle_clone_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @bundle_clone_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @bundle_clone_page << BundleCloneListResponse.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_clone_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V2PageMetadata>';
+                    end
+                end
+                class BundleCloneListResponse < InstanceListResource
+
+                    # @param [Array<BundleCloneInstance>] 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_clone = data_list.map do |data|
+                        BundleCloneInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def bundle_clone
+                        @bundle_clone
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class BundleCloneInstance < InstanceResource
+                    ##
+                    # Initialize the BundleCloneInstance
+                    # @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 BundleClone
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [BundleCloneInstance] BundleCloneInstance
+                    def initialize(version, payload , bundle_sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'bundle_sid' => payload['bundle_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']),
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'bundle_sid' => bundle_sid  || @properties['bundle_sid']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [BundleCloneContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = BundleCloneContext.new(@version , @params['bundle_sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique string that we created to identify the Bundle resource.
+                    def bundle_sid
+                        @properties['bundle_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
+                    
+                    ##
+                    # @return [String] The URL of this resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Create the BundleCloneInstance
+                    # @param [String] target_account_sid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) where the bundle needs to be cloned.
+                    # @param [Boolean] move_to_draft If set to true, the cloned bundle will be in the DRAFT state, else it will be twilio-approved
+                    # @param [String] friendly_name The string that you assigned to describe the cloned bundle.
+                    # @return [BundleCloneInstance] Created BundleCloneInstance
+                    def create(
+                        target_account_sid: nil, 
+                        move_to_draft: :unset, 
+                        friendly_name: :unset
+                    )
+
+                        context.create(
+                            target_account_sid: target_account_sid, 
+                            move_to_draft: move_to_draft, 
+                            friendly_name: friendly_name, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Numbers.V2.BundleCloneInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Numbers.V2.BundleCloneInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end