twilio-ruby 7.2.2 → 7.2.4

data/lib/twilio-ruby/rest/marketplace/v1/referral_conversion.rb

@@ -0,0 +1,199 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Marketplace
+#    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 Marketplace < MarketplaceBase
+            class V1 < Version
+                class ReferralConversionList < ListResource
+                
+                    class CreateReferralConversionRequest
+                            # @param [referral_account_sid]: [String] 
+                        attr_accessor :referral_account_sid
+                        def initialize(payload)
+                                @referral_account_sid = payload["referral_account_sid"]
+                        end
+                        def to_json(options = {})
+                        {
+                                referral_account_sid: @referral_account_sid,
+                        }.to_json(options)
+                        end
+                    end
+
+                    ##
+                    # Initialize the ReferralConversionList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ReferralConversionList] ReferralConversionList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Marketplace.V1.ReferralConversionList>'
+                    end
+                end
+
+
+                class ReferralConversionContext < InstanceContext
+                    ##
+                    # Initialize the ReferralConversionContext
+                    # @param [Version] version Version that contains the resource
+                    # @return [ReferralConversionContext] ReferralConversionContext
+                    def initialize(version)
+                        super(version)
+
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/ReferralConversion"
+
+                        
+                    end
+                    ##
+                    # Create the ReferralConversionInstance
+                    # @param [CreateReferralConversionRequest] create_referral_conversion_request 
+                    # @return [ReferralConversionInstance] Created ReferralConversionInstance
+                    def create(create_referral_conversion_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        payload = @version.create('POST', @uri, headers: headers, data: create_referral_conversion_request.to_json)
+                        ReferralConversionInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Marketplace.V1.ReferralConversionContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Marketplace.V1.ReferralConversionContext #{context}>"
+                    end
+                end
+
+                class ReferralConversionPage < Page
+                    ##
+                    # Initialize the ReferralConversionPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ReferralConversionPage] ReferralConversionPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ReferralConversionInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ReferralConversionInstance] ReferralConversionInstance
+                    def get_instance(payload)
+                        ReferralConversionInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Marketplace.V1.ReferralConversionPage>'
+                    end
+                end
+                class ReferralConversionInstance < InstanceResource
+                    ##
+                    # Initialize the ReferralConversionInstance
+                    # @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 ReferralConversion
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ReferralConversionInstance] ReferralConversionInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'converted_account_sid' => payload['converted_account_sid'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = {  }
+                    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 [ReferralConversionContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = ReferralConversionContext.new(@version )
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def converted_account_sid
+                        @properties['converted_account_sid']
+                    end
+                    
+                    ##
+                    # Create the ReferralConversionInstance
+                    # @param [CreateReferralConversionRequest] create_referral_conversion_request 
+                    # @return [ReferralConversionInstance] Created ReferralConversionInstance
+                    def create(create_referral_conversion_request: nil
+                    )
+
+                        context.create(
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Marketplace.V1.ReferralConversionInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Marketplace.V1.ReferralConversionInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end

data/lib/twilio-ruby/rest/marketplace/v1.rb

@@ -24,6 +24,7 @@ module Twilio
                     @available_add_ons = nil
                     @installed_add_ons = nil
                     @module_data_management = nil
+                    @referral_conversion = nil
                 end
 
                 ##
@@ -55,7 +56,7 @@ module Twilio
                     end
                 end
                 ##
-                # @param [String] sid 
+                # @param [String] sid The unique identifier of a Listing.
                 # @return [Twilio::REST::Marketplace::V1::ModuleDataManagementContext] if sid was passed.
                 # @return [Twilio::REST::Marketplace::V1::ModuleDataManagementList]
                 def module_data_management(sid=:unset)
@@ -69,6 +70,11 @@ module Twilio
                     end
                 end
                 ##
+                # @return [Twilio::REST::Marketplace::V1::referralConversionContext]
+                def referral_conversion
+                    @referral_conversion ||= ReferralConversionContext.new self
+                end
+                ##
                 # Provide a user friendly representation
                 def to_s
                     '<Twilio::REST::Marketplace::V1>';

data/lib/twilio-ruby/rest/messaging/v1/external_campaign.rb

@@ -34,15 +34,18 @@ module Twilio
                     # Create the ExternalCampaignInstance
                     # @param [String] campaign_id ID of the preregistered campaign.
                     # @param [String] messaging_service_sid The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with.
+                    # @param [Boolean] cnp_migration Customers should use this flag during the ERC registration process to indicate to Twilio that the campaign being registered is undergoing CNP migration. It is important for the user to first trigger the CNP migration process for said campaign in their CSP portal and have Twilio accept the sharing request, before making this api call.
                     # @return [ExternalCampaignInstance] Created ExternalCampaignInstance
                     def create(
                         campaign_id: nil, 
-                        messaging_service_sid: nil
+                        messaging_service_sid: nil, 
+                        cnp_migration: :unset
                     )
 
                         data = Twilio::Values.of({
                             'CampaignId' => campaign_id,
                             'MessagingServiceSid' => messaging_service_sid,
+                            'CnpMigration' => cnp_migration,
                         })
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })

data/lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb

@@ -32,6 +32,28 @@ module Twilio
                         @uri = "/Services/#{@solution[:messaging_service_sid]}/ChannelSenders"
                         
                     end
+                    ##
+                    # Create the ChannelSenderInstance
+                    # @param [String] sid The SID of the Channel Sender being added to the Service.
+                    # @return [ChannelSenderInstance] Created ChannelSenderInstance
+                    def create(
+                        sid: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Sid' => sid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
+                        ChannelSenderInstance.new(
+                            @version,
+                            payload,
+                            messaging_service_sid: @solution[:messaging_service_sid],
+                        )
+                    end
+
                 
                     ##
                     # Lists ChannelSenderInstance records from the API as a list.
@@ -142,6 +164,16 @@ module Twilio
 
                         
                     end
+                    ##
+                    # Delete the ChannelSenderInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        @version.delete('DELETE', @uri, headers: headers)
+                    end
+
                     ##
                     # Fetch the ChannelSenderInstance
                     # @return [ChannelSenderInstance] Fetched ChannelSenderInstance
@@ -298,6 +330,14 @@ module Twilio
                         @properties['url']
                     end
                     
+                    ##
+                    # Delete the ChannelSenderInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
                     ##
                     # Fetch the ChannelSenderInstance
                     # @return [ChannelSenderInstance] Fetched ChannelSenderInstance

data/lib/twilio-ruby/rest/numbers/v1/porting_port_in.rb

@@ -198,31 +198,31 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] The Account SID that the numbers will be added to after they are ported into Twilio.
+                    # @return [String] Account Sid or subaccount where the phone number(s) will be Ported
                     def account_sid
                         @properties['account_sid']
                     end
                     
                     ##
-                    # @return [Array<String>] List of emails for getting notifications about the LOA signing process. Allowed Max 10 emails.
+                    # @return [Array<String>] Additional emails to send a copy of the signed LOA to.
                     def notification_emails
                         @properties['notification_emails']
                     end
                     
                     ##
-                    # @return [Date] Minimum number of days in the future (at least 2 days) needs to be established with the Ops team for validation.
+                    # @return [Date] Target date to port the number. We cannot guarantee that this date will be honored by the other carriers, please work with Ops to get a confirmation of the firm order commitment (FOC) date. Expected format is ISO Local Date, example: ‘2011-12-03`. This date must be at least 7 days in the future for US ports and 10 days in the future for Japanese ports. (This value is only available for custom porting customers.)
                     def target_port_in_date
                         @properties['target_port_in_date']
                     end
                     
                     ##
-                    # @return [String] Minimum hour in the future needs to be established with the Ops team for validation.
+                    # @return [String] The earliest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00'. (This value is only available for custom porting customers.)
                     def target_port_in_time_range_start
                         @properties['target_port_in_time_range_start']
                     end
                     
                     ##
-                    # @return [String] Maximum hour in the future needs to be established with the Ops team for validation.
+                    # @return [String] The latest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00'.  (This value is only available for custom porting customers.)
                     def target_port_in_time_range_end
                         @properties['target_port_in_time_range_end']
                     end
@@ -234,19 +234,19 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Hash] The information for the losing carrier. 
+                    # @return [Hash] Details regarding the customer’s information with the losing carrier. These values will be used to generate the letter of authorization and should match the losing carrier’s data as closely as possible to ensure the port is accepted.
                     def losing_carrier_information
                         @properties['losing_carrier_information']
                     end
                     
                     ##
-                    # @return [Array<Hash>] The list of phone numbers to Port in. Phone numbers are in E.164 format (e.g. +16175551212).
+                    # @return [Array<Hash>] 
                     def phone_numbers
                         @properties['phone_numbers']
                     end
                     
                     ##
-                    # @return [Array<String>] The list of documents SID referencing a utility bills
+                    # @return [Array<String>] List of document SIDs for all phone numbers included in the port in request. At least one document SID referring to a document of the type Utility Bill is required.
                     def documents
                         @properties['documents']
                     end

data/lib/twilio-ruby/rest/numbers/v1/porting_port_in_phone_number.rb

@@ -158,6 +158,7 @@ module Twilio
                             'port_out_pin' => payload['port_out_pin'] == nil ? payload['port_out_pin'] : payload['port_out_pin'].to_i,
                             'rejection_reason' => payload['rejection_reason'],
                             'rejection_reason_code' => payload['rejection_reason_code'] == nil ? payload['rejection_reason_code'] : payload['rejection_reason_code'].to_i,
+                            'port_date' => Twilio.deserialize_iso8601_datetime(payload['port_date']),
                         }
 
                         # Context
@@ -177,107 +178,113 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] The SID of the Port In request. This is a unique identifier of the port in request.
+                    # @return [String] The unique identifier for the port in request that this phone number is associated with.
                     def port_in_request_sid
                         @properties['port_in_request_sid']
                     end
                     
                     ##
-                    # @return [String] The SID of the Port In request phone number. This is a unique identifier of the phone number.
+                    # @return [String] The unique identifier for this phone number associated with this port in request.
                     def phone_number_sid
                         @properties['phone_number_sid']
                     end
                     
                     ##
-                    # @return [String] 
+                    # @return [String] URL reference for this resource.
                     def url
                         @properties['url']
                     end
                     
                     ##
-                    # @return [String] The SID of the account that the phone number belongs to.
+                    # @return [String] Account Sid or subaccount where the phone number(s) will be Ported.
                     def account_sid
                         @properties['account_sid']
                     end
                     
                     ##
-                    # @return [String] The type of the phone number.
+                    # @return [String] The number type of the phone number. This can be: toll-free, local, mobile or unknown. This field may be null if the number is not portable or if the portability for a number has not yet been evaluated.
                     def phone_number_type
                         @properties['phone_number_type']
                     end
                     
                     ##
-                    # @return [Time] The date when the phone number was created.
+                    # @return [Time] The timestamp for when this port in phone number was created.
                     def date_created
                         @properties['date_created']
                     end
                     
                     ##
-                    # @return [String] The country of the phone number.
+                    # @return [String] The ISO country code that this number is associated with. This field may be null if the number is not portable or if the portability for a number has not yet been evaluated.
                     def country
                         @properties['country']
                     end
                     
                     ##
-                    # @return [Boolean] The phone number is missing required fields.
+                    # @return [Boolean] Indicates if the phone number is missing required fields such as a PIN or account number. This field may be null if the number is not portable or if the portability for a number has not yet been evaluated.
                     def missing_required_fields
                         @properties['missing_required_fields']
                     end
                     
                     ##
-                    # @return [Time] The timestamp when the status was last updated.
+                    # @return [Time] Timestamp indicating when the Port In Phone Number resource was last modified.
                     def last_updated
                         @properties['last_updated']
                     end
                     
                     ##
-                    # @return [String] The phone number.
+                    # @return [String] Phone number to be ported. This will be in the E164 Format.
                     def phone_number
                         @properties['phone_number']
                     end
                     
                     ##
-                    # @return [Boolean] The phone number is portable.
+                    # @return [Boolean] If the number is portable by Twilio or not. This field may be null if the number portability has not yet been evaluated. If a number is not portable reference the `not_portability_reason_code` and `not_portability_reason` fields for more details
                     def portable
                         @properties['portable']
                     end
                     
                     ##
-                    # @return [String] The reason why the phone number is not portable.
+                    # @return [String] The not portability reason code description. This field may be null if the number is portable or if the portability for a number has not yet been evaluated.
                     def not_portability_reason
                         @properties['not_portability_reason']
                     end
                     
                     ##
-                    # @return [String] The code of the reason why the phone number is not portable.
+                    # @return [String] The not portability reason code. This field may be null if the number is portable or if the portability for a number has not yet been evaluated.
                     def not_portability_reason_code
                         @properties['not_portability_reason_code']
                     end
                     
                     ##
-                    # @return [String] The status of the phone number in the port in request.
+                    # @return [String] The status of the port in phone number.
                     def port_in_phone_number_status
                         @properties['port_in_phone_number_status']
                     end
                     
                     ##
-                    # @return [String] The pin required for the losing carrier to port out the phone number.
+                    # @return [String] The pin required by the losing carrier to do the port out.
                     def port_out_pin
                         @properties['port_out_pin']
                     end
                     
                     ##
-                    # @return [String] The rejection reason returned by the vendor.
+                    # @return [String] The description of the rejection reason provided by the losing carrier. This field may be null if the number has not been rejected by the losing carrier.
                     def rejection_reason
                         @properties['rejection_reason']
                     end
                     
                     ##
-                    # @return [String] The rejection reason code returned by the vendor.
+                    # @return [String] The code for the rejection reason provided by the losing carrier. This field may be null if the number has not been rejected by the losing carrier.
                     def rejection_reason_code
                         @properties['rejection_reason_code']
                     end
                     
+                    ##
+                    # @return [Time] The timestamp the phone number will be ported. This will only be set once a port date has been confirmed. Not all carriers can guarantee a specific time on the port date. Twilio will try its best to get the port completed by this time on the port date. Please subscribe to webhooks for confirmation on when a port has actually been completed.
+                    def port_date
+                        @properties['port_date']
+                    end
+                    
                     ##
                     # Delete the PortingPortInPhoneNumberInstance
                     # @return [Boolean] True if delete succeeds, false otherwise

data/lib/twilio-ruby/rest/numbers/v1/porting_portability.rb

@@ -44,7 +44,7 @@ module Twilio
                     ##
                     # Initialize the PortingPortabilityContext
                     # @param [Version] version Version that contains the resource
-                    # @param [String] phone_number The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212).
+                    # @param [String] phone_number Phone number to check portability in e164 format.
                     # @return [PortingPortabilityContext] PortingPortabilityContext
                     def initialize(version, phone_number)
                         super(version)
@@ -57,7 +57,7 @@ module Twilio
                     end
                     ##
                     # Fetch the PortingPortabilityInstance
-                    # @param [String] target_account_sid The SID of the account where the phone number(s) will be ported.
+                    # @param [String] target_account_sid Account Sid to which the number will be ported. This can be used to determine if a sub account already has the number in its inventory or a different sub account. If this is not provided, the authenticated account will be assumed to be the target account.
                     # @return [PortingPortabilityInstance] Fetched PortingPortabilityInstance
                     def fetch(
                         target_account_sid: :unset
@@ -169,19 +169,19 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] The target account sid to which the number will be ported
+                    # @return [String] Account Sid that the phone number belongs to in Twilio. This is only returned for phone numbers that already exist in Twilio’s inventory and belong to your account or sub account.
                     def account_sid
                         @properties['account_sid']
                     end
                     
                     ##
-                    # @return [Boolean] Boolean flag specifying if phone number is portable or not.
+                    # @return [Boolean] Boolean flag indicates if the phone number can be ported into Twilio through the Porting API or not.
                     def portable
                         @properties['portable']
                     end
                     
                     ##
-                    # @return [Boolean] Boolean flag specifying if PIN and account number is required for the phone number.
+                    # @return [Boolean] Indicates if the port in process will require a personal identification number (PIN) and an account number for this phone number. If this is true you will be required to submit both a PIN and account number from the losing carrier for this number when opening a port in request. These fields will be required in order to complete the port in process to Twilio.
                     def pin_and_account_number_required
                         @properties['pin_and_account_number_required']
                     end
@@ -193,7 +193,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] The Portability Reason Code for the phone number if it cannot be ported into Twilio, `null` otherwise. One of `22131`, `22132`, `22130`, `22133`, `22102` or `22135`.
+                    # @return [String] The Portability Reason Code for the phone number if it cannot be ported into Twilio, `null` otherwise.
                     def not_portable_reason_code
                         @properties['not_portable_reason_code']
                     end
@@ -218,7 +218,7 @@ module Twilio
                     
                     ##
                     # Fetch the PortingPortabilityInstance
-                    # @param [String] target_account_sid The SID of the account where the phone number(s) will be ported.
+                    # @param [String] target_account_sid Account Sid to which the number will be ported. This can be used to determine if a sub account already has the number in its inventory or a different sub account. If this is not provided, the authenticated account will be assumed to be the target account.
                     # @return [PortingPortabilityInstance] Fetched PortingPortabilityInstance
                     def fetch(
                         target_account_sid: :unset

data/lib/twilio-ruby/rest/numbers/v1/porting_webhook_configuration.rb

@@ -113,19 +113,19 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] Webhook URL to send a request when a port in request or port in phone number event happens
+                    # @return [String] The complete webhook url that will be called when a notification event for port in request or port in phone number happens
                     def port_in_target_url
                         @properties['port_in_target_url']
                     end
                     
                     ##
-                    # @return [String] Webhook URL to send a request when a port out phone number event happens
+                    # @return [String] The complete webhook url that will be called when a notification event for a port out phone number happens.
                     def port_out_target_url
                         @properties['port_out_target_url']
                     end
                     
                     ##
-                    # @return [Array<String>] List of notification events to send a request to the webhook URL
+                    # @return [Array<String>] A list to filter what notification events to receive for this account and its sub accounts. If it is an empty list, then it means that there are no filters for the notifications events to send in each webhook and all events will get sent.
                     def notifications_of
                         @properties['notifications_of']
                     end

data/lib/twilio-ruby/rest/numbers/v1/porting_webhook_configuration_delete.rb

@@ -44,7 +44,7 @@ module Twilio
                     ##
                     # Initialize the PortingWebhookConfigurationDeleteContext
                     # @param [Version] version Version that contains the resource
-                    # @param [WebhookType] webhook_type The of the webhook type of the configuration to be deleted
+                    # @param [WebhookType] webhook_type The webhook type for the configuration to be delete. `PORT_IN`, `PORT_OUT`
                     # @return [PortingWebhookConfigurationDeleteContext] PortingWebhookConfigurationDeleteContext
                     def initialize(version, webhook_type)
                         super(version)