twilio-ruby 5.47.0 → 5.48.0

data/lib/twilio-ruby/rest/{messaging/v1/campaign.rb → trusthub/v1/supporting_document.rb}

@@ -8,25 +8,43 @@
 
 module Twilio
   module REST
-    class Messaging < Domain
+    class Trusthub < Domain
       class V1 < Version
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-        class CampaignList < ListResource
+        class SupportingDocumentList < ListResource
           ##
-          # Initialize the CampaignList
+          # Initialize the SupportingDocumentList
           # @param [Version] version Version that contains the resource
-          # @return [CampaignList] CampaignList
+          # @return [SupportingDocumentList] SupportingDocumentList
           def initialize(version)
             super(version)
 
             # Path Solution
             @solution = {}
-            @uri = "/a2p/Campaigns"
+            @uri = "/SupportingDocuments"
           end
 
           ##
-          # Lists CampaignInstance records from the API as a list.
+          # Create the SupportingDocumentInstance
+          # @param [String] friendly_name The string that you assigned to describe the
+          #   resource.
+          # @param [String] type The type of the Supporting Document.
+          # @param [Hash] attributes The set of parameters that are the attributes of the
+          #   Supporting Documents resource which are derived Supporting Document Types.
+          # @return [SupportingDocumentInstance] Created SupportingDocumentInstance
+          def create(friendly_name: nil, type: nil, attributes: :unset)
+            data = Twilio::Values.of({
+                'FriendlyName' => friendly_name,
+                'Type' => type,
+                'Attributes' => Twilio.serialize_object(attributes),
+            })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            SupportingDocumentInstance.new(@version, payload, )
+          end
+
+          ##
+          # Lists SupportingDocumentInstance 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()
@@ -41,7 +59,7 @@ module Twilio
           end
 
           ##
-          # Streams CampaignInstance records from the API as an Enumerable.
+          # Streams SupportingDocumentInstance 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()
@@ -60,7 +78,7 @@ module Twilio
           end
 
           ##
-          # When passed a block, yields CampaignInstance records from the API.
+          # When passed a block, yields SupportingDocumentInstance records from the API.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
           def each
@@ -74,12 +92,12 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of CampaignInstance records from the API.
+          # Retrieve a single page of SupportingDocumentInstance 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 CampaignInstance
+          # @return [Page] Page of SupportingDocumentInstance
           def page(page_token: :unset, page_number: :unset, page_size: :unset)
             params = Twilio::Values.of({
                 'PageToken' => page_token,
@@ -89,71 +107,36 @@ module Twilio
 
             response = @version.page('GET', @uri, params: params)
 
-            CampaignPage.new(@version, response, @solution)
+            SupportingDocumentPage.new(@version, response, @solution)
           end
 
           ##
-          # Retrieve a single page of CampaignInstance records from the API.
+          # Retrieve a single page of SupportingDocumentInstance records from the API.
           # Request is executed immediately.
           # @param [String] target_url API-generated URL for the requested results page
-          # @return [Page] Page of CampaignInstance
+          # @return [Page] Page of SupportingDocumentInstance
           def get_page(target_url)
             response = @version.domain.request(
                 'GET',
                 target_url
             )
-            CampaignPage.new(@version, response, @solution)
-          end
-
-          ##
-          # Create the CampaignInstance
-          # @param [String] brand_registration_sid A2P BrandRegistration Sid
-          # @param [String] use_case A2P Campaign UseCase. One of [ 2FA, EMERGENCY,
-          #   MARKETING ]
-          # @param [String] description A short description of what this SMS campaign does.
-          # @param [Array[String]] message_samples Message samples, up to 5 sample messages,
-          #   <=255 chars each. Example: [ "EXPRESS: Denim Days Event is ON", "LAST CHANCE:
-          #   Book your next flight for just 1 (ONE) EUR" ]
-          # @param [Boolean] has_embedded_links Indicate that this SMS campaign will send
-          #   messages that contain links.
-          # @param [Boolean] has_embedded_phone Indicates that this SMS campaign will send
-          #   messages that contain phone numbers.
-          # @param [String] messaging_service_sid The SID of the
-          #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to read the
-          #   resources from.
-          # @return [CampaignInstance] Created CampaignInstance
-          def create(brand_registration_sid: nil, use_case: nil, description: nil, message_samples: nil, has_embedded_links: nil, has_embedded_phone: nil, messaging_service_sid: nil)
-            data = Twilio::Values.of({
-                'BrandRegistrationSid' => brand_registration_sid,
-                'UseCase' => use_case,
-                'Description' => description,
-                'MessageSamples' => Twilio.serialize_list(message_samples) { |e| e },
-                'HasEmbeddedLinks' => has_embedded_links,
-                'HasEmbeddedPhone' => has_embedded_phone,
-                'MessagingServiceSid' => messaging_service_sid,
-            })
-
-            payload = @version.create('POST', @uri, data: data)
-
-            CampaignInstance.new(@version, payload, )
+            SupportingDocumentPage.new(@version, response, @solution)
           end
 
           ##
           # Provide a user friendly representation
           def to_s
-            '#<Twilio.Messaging.V1.CampaignList>'
+            '#<Twilio.Trusthub.V1.SupportingDocumentList>'
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-        class CampaignPage < Page
+        class SupportingDocumentPage < Page
           ##
-          # Initialize the CampaignPage
+          # Initialize the SupportingDocumentPage
           # @param [Version] version Version that contains the resource
           # @param [Response] response Response from the API
           # @param [Hash] solution Path solution for the resource
-          # @return [CampaignPage] CampaignPage
+          # @return [SupportingDocumentPage] SupportingDocumentPage
           def initialize(version, response, solution)
             super(version, response)
 
@@ -162,47 +145,64 @@ module Twilio
           end
 
           ##
-          # Build an instance of CampaignInstance
+          # Build an instance of SupportingDocumentInstance
           # @param [Hash] payload Payload response from the API
-          # @return [CampaignInstance] CampaignInstance
+          # @return [SupportingDocumentInstance] SupportingDocumentInstance
           def get_instance(payload)
-            CampaignInstance.new(@version, payload, )
+            SupportingDocumentInstance.new(@version, payload, )
           end
 
           ##
           # Provide a user friendly representation
           def to_s
-            '<Twilio.Messaging.V1.CampaignPage>'
+            '<Twilio.Trusthub.V1.SupportingDocumentPage>'
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-        class CampaignContext < InstanceContext
+        class SupportingDocumentContext < InstanceContext
           ##
-          # Initialize the CampaignContext
+          # Initialize the SupportingDocumentContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The SID of the Campaign resource to fetch.
-          # @return [CampaignContext] CampaignContext
+          # @param [String] sid The unique string created by Twilio to identify the
+          #   Supporting Document resource.
+          # @return [SupportingDocumentContext] SupportingDocumentContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
             @solution = {sid: sid, }
-            @uri = "/a2p/Campaigns/#{@solution[:sid]}"
+            @uri = "/SupportingDocuments/#{@solution[:sid]}"
           end
 
           ##
-          # Fetch the CampaignInstance
-          # @return [CampaignInstance] Fetched CampaignInstance
+          # Fetch the SupportingDocumentInstance
+          # @return [SupportingDocumentInstance] Fetched SupportingDocumentInstance
           def fetch
             payload = @version.fetch('GET', @uri)
 
-            CampaignInstance.new(@version, payload, sid: @solution[:sid], )
+            SupportingDocumentInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Delete the CampaignInstance
+          # Update the SupportingDocumentInstance
+          # @param [String] friendly_name The string that you assigned to describe the
+          #   resource.
+          # @param [Hash] attributes The set of parameters that are the attributes of the
+          #   Supporting Document resource which are derived Supporting Document Types.
+          # @return [SupportingDocumentInstance] Updated SupportingDocumentInstance
+          def update(friendly_name: :unset, attributes: :unset)
+            data = Twilio::Values.of({
+                'FriendlyName' => friendly_name,
+                'Attributes' => Twilio.serialize_object(attributes),
+            })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            SupportingDocumentInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Delete the SupportingDocumentInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
              @version.delete('DELETE', @uri)
@@ -212,44 +212,39 @@ module Twilio
           # Provide a user friendly representation
           def to_s
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Messaging.V1.CampaignContext #{context}>"
+            "#<Twilio.Trusthub.V1.SupportingDocumentContext #{context}>"
           end
 
           ##
           # Provide a detailed, user friendly representation
           def inspect
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Messaging.V1.CampaignContext #{context}>"
+            "#<Twilio.Trusthub.V1.SupportingDocumentContext #{context}>"
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-        class CampaignInstance < InstanceResource
+        class SupportingDocumentInstance < InstanceResource
           ##
-          # Initialize the CampaignInstance
+          # Initialize the SupportingDocumentInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The SID of the Campaign resource to fetch.
-          # @return [CampaignInstance] CampaignInstance
+          # @param [String] sid The unique string created by Twilio to identify the
+          #   Supporting Document resource.
+          # @return [SupportingDocumentInstance] SupportingDocumentInstance
           def initialize(version, payload, sid: nil)
             super(version)
 
             # Marshaled Properties
             @properties = {
-                'account_sid' => payload['account_sid'],
-                'messaging_service_sid' => payload['messaging_service_sid'],
-                'brand_registration_sid' => payload['brand_registration_sid'],
                 'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'friendly_name' => payload['friendly_name'],
+                'mime_type' => payload['mime_type'],
+                'status' => payload['status'],
+                'type' => payload['type'],
+                'attributes' => payload['attributes'],
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                'description' => payload['description'],
-                'message_samples' => payload['message_samples'],
-                'status' => payload['status'],
-                'failure_reason' => payload['failure_reason'],
-                'use_case' => payload['use_case'],
-                'has_embedded_links' => payload['has_embedded_links'],
-                'has_embedded_phone' => payload['has_embedded_phone'],
                 'url' => payload['url'],
             }
 
@@ -261,107 +256,94 @@ module Twilio
           ##
           # Generate an instance context for the instance, the context is capable of
           # performing various actions.  All instance actions are proxied to the context
-          # @return [CampaignContext] CampaignContext for this CampaignInstance
+          # @return [SupportingDocumentContext] SupportingDocumentContext for this SupportingDocumentInstance
           def context
             unless @instance_context
-              @instance_context = CampaignContext.new(@version, @params['sid'], )
+              @instance_context = SupportingDocumentContext.new(@version, @params['sid'], )
             end
             @instance_context
           end
 
           ##
-          # @return [String] The SID of the Account that created the resource
-          def account_sid
-            @properties['account_sid']
-          end
-
-          ##
-          # @return [String] MessagingService SID
-          def messaging_service_sid
-            @properties['messaging_service_sid']
-          end
-
-          ##
-          # @return [String] A2P BrandRegistration Sid
-          def brand_registration_sid
-            @properties['brand_registration_sid']
-          end
-
-          ##
-          # @return [String] Campaign sid
+          # @return [String] The unique string that identifies the resource
           def sid
             @properties['sid']
           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']
+          # @return [String] The SID of the Account that created the resource
+          def account_sid
+            @properties['account_sid']
           end
 
           ##
-          # @return [String] A short description of what this SMS campaign does
-          def description
-            @properties['description']
+          # @return [String] The string that you assigned to describe the resource
+          def friendly_name
+            @properties['friendly_name']
           end
 
           ##
-          # @return [Array[String]] Message samples
-          def message_samples
-            @properties['message_samples']
+          # @return [String] The image type of the file
+          def mime_type
+            @properties['mime_type']
           end
 
           ##
-          # @return [campaign.Status] Campaign status
+          # @return [supporting_document.Status] The verification status of the Supporting Document resource
           def status
             @properties['status']
           end
 
           ##
-          # @return [String] A reason why campaign registration has failed
-          def failure_reason
-            @properties['failure_reason']
+          # @return [String] The type of the Supporting Document
+          def type
+            @properties['type']
           end
 
           ##
-          # @return [String] A2P Campaign UseCase.
-          def use_case
-            @properties['use_case']
+          # @return [Hash] The set of parameters that compose the Supporting Documents resource
+          def attributes
+            @properties['attributes']
           end
 
           ##
-          # @return [Boolean] Indicate that this SMS campaign will send messages that contain links
-          def has_embedded_links
-            @properties['has_embedded_links']
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+          def date_created
+            @properties['date_created']
           end
 
           ##
-          # @return [Boolean] Indicates that this SMS campaign will send messages that contain phone numbers
-          def has_embedded_phone
-            @properties['has_embedded_phone']
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
+          def date_updated
+            @properties['date_updated']
           end
 
           ##
-          # @return [String] The absolute URL of the Campaign resource
+          # @return [String] The absolute URL of the Supporting Document resource
           def url
             @properties['url']
           end
 
           ##
-          # Fetch the CampaignInstance
-          # @return [CampaignInstance] Fetched CampaignInstance
+          # Fetch the SupportingDocumentInstance
+          # @return [SupportingDocumentInstance] Fetched SupportingDocumentInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Delete the CampaignInstance
+          # Update the SupportingDocumentInstance
+          # @param [String] friendly_name The string that you assigned to describe the
+          #   resource.
+          # @param [Hash] attributes The set of parameters that are the attributes of the
+          #   Supporting Document resource which are derived Supporting Document Types.
+          # @return [SupportingDocumentInstance] Updated SupportingDocumentInstance
+          def update(friendly_name: :unset, attributes: :unset)
+            context.update(friendly_name: friendly_name, attributes: attributes, )
+          end
+
+          ##
+          # Delete the SupportingDocumentInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
@@ -371,14 +353,14 @@ module Twilio
           # Provide a user friendly representation
           def to_s
             values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Messaging.V1.CampaignInstance #{values}>"
+            "<Twilio.Trusthub.V1.SupportingDocumentInstance #{values}>"
           end
 
           ##
           # Provide a detailed, user friendly representation
           def inspect
             values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Messaging.V1.CampaignInstance #{values}>"
+            "<Twilio.Trusthub.V1.SupportingDocumentInstance #{values}>"
           end
         end
       end