twilio-ruby 6.12.0 → 6.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48762986794b273b7af2af37ea08f77c99c93049
-  data.tar.gz: 530db27d0d445c24427e75f5a311c2df08d06450
+  metadata.gz: 4ee4da7ce236e476901cca417a590ffbcc5dd90d
+  data.tar.gz: 7e0d20132c3cb96f03f2c6e3d42a9074ebf357fc
 SHA512:
-  metadata.gz: 755b266ac2babc4897404c111b3543c3e2a5ba1bba2bb8b23075c57a0ac516be358d934abf2a6b87e484c65559c3ccce767add26eb45feace176869d2ec1b8e5
-  data.tar.gz: 39b18ed0075bc5417d16cf2595d2e5e0e62caf2c520d1c72ce5d09231f767396134adbb6e320dbf288da2a92f72b0a67f7997fdf6b57b0b0d475473306aff8ff
+  metadata.gz: 4a7a0c2959b45c56f2ee701ecca64a21a6ec596e2a8b36c1761b32ce58e0669fecd3f2c61d0f749b5bcd8bea34c52e3e898231e3dad8eec421cd8b1637807575
+  data.tar.gz: 529e0dd106814e77a1b0b8588da5b7077dbe12a18ccfd69383e7caa7df23e75e41ba3bb7172c24c67bbd167a6aac101b19fc3f70785be0d31c09c231c3304627

data/CHANGES.md

@@ -1,6 +1,32 @@
 twilio-ruby changelog
 ===================== 
 
+[2024-03-12] Version 6.12.1
+---------------------------
+**Api**
+- Correct precedence documentation for application_sid vs status_callback in message creation
+- Mark MaxPrice as deprecated
+
+**Flex**
+- Making `plugins` visibility to public
+
+**Messaging**
+- Add new `errors` attribute to the Brand Registration resource.
+- Mark `brand_feedback` attribute as deprecated.
+- Mark `failure_reason` attribute as deprecated.
+- The new `errors` attribute is expected to provide additional information about Brand registration failures and feedback (if any has been provided by The Campaign Registry). Consumers should use this attribute instead of `brand_feedback` and `failure_reason`.
+
+**Numbers**
+- Correcting mount_name for porting port in fetch API
+
+**Trusthub**
+- Add new field in statusCallbackUrl in compliance_registration.
+- Add new field in isvRegisteringForSelfOrTenant in compliance_registration.
+
+**Twiml**
+- Expanded description of Action parameter for Message verb
+
+
 [2024-02-27] Version 6.12.0
 ---------------------------
 **Library - Chore**

data/README.md

@@ -39,13 +39,13 @@ This library supports the following Ruby implementations:
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 6.12.0'
+gem 'twilio-ruby', '~> 6.12.1'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 6.12.0
+gem install twilio-ruby -v 6.12.1
 ```
 
 To build and install the development branch yourself from the latest source:

data/lib/twilio-ruby/rest/api/v2010/account/message.rb

@@ -36,8 +36,8 @@ module Twilio
                     # Create the MessageInstance
                     # @param [String] to The recipient's phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (for SMS/MMS) or [channel address](https://www.twilio.com/docs/messaging/channels), e.g. `whatsapp:+15552229999`.
                     # @param [String] status_callback The URL of the endpoint to which Twilio sends [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url). URL must contain a valid hostname and underscores are not allowed. If you include this parameter with the `messaging_service_sid`, Twilio uses this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource). 
-                    # @param [String] application_sid The SID of the associated [TwiML Application](https://www.twilio.com/docs/usage/api/applications). If this parameter is provided, the `status_callback` parameter of this request is ignored; [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url) are sent to the TwiML App's `message_status_callback` URL.
-                    # @param [Float] max_price The maximum price in US dollars that you are willing to pay for this Message's delivery. The value can have up to four decimal places. When the `max_price` parameter is provided, the cost of a message is checked before it is sent. If the cost exceeds `max_price`, the message is not sent and the Message `status` is `failed`.
+                    # @param [String] application_sid The SID of the associated [TwiML Application](https://www.twilio.com/docs/usage/api/applications). [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url) are sent to the TwiML App's `message_status_callback` URL. Note that the `status_callback` parameter of a request takes priority over the `application_sid` parameter; if both are included `application_sid` is ignored.
+                    # @param [Float] max_price [DEPRECATED] This parameter will no longer have any effect as of 2024-06-03.
                     # @param [Boolean] provide_feedback Boolean indicating whether or not you intend to provide delivery confirmation feedback to Twilio (used in conjunction with the [Message Feedback subresource](https://www.twilio.com/docs/sms/api/message-feedback-resource)). Default value is `false`.
                     # @param [String] attempt Total number of attempts made (including this request) to send the message regardless of the provider used
                     # @param [String] validity_period The maximum length in seconds that the Message can remain in Twilio's outgoing message queue. If a queued Message exceeds the `validity_period`, the Message is not sent. Accepted values are integers from `1` to `14400`. Default value is `14400`. A `validity_period` greater than `5` is recommended. [Learn more about the validity period](https://www.twilio.com/blog/take-more-control-of-outbound-messages-using-validity-period-html)

data/lib/twilio-ruby/rest/flex_api/v1/plugin/plugin_versions.rb

@@ -0,0 +1,384 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Flex
+#    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 FlexApi < FlexApiBase
+            class V1 < Version
+                class PluginContext < InstanceContext
+
+                     class PluginVersionsList < ListResource
+                
+                    ##
+                    # Initialize the PluginVersionsList
+                    # @param [Version] version Version that contains the resource
+                    # @return [PluginVersionsList] PluginVersionsList
+                    def initialize(version, plugin_sid: nil)
+                        super(version)
+                        # Path Solution
+                        @solution = { plugin_sid: plugin_sid }
+                        @uri = "/PluginService/Plugins/#{@solution[:plugin_sid]}/Versions"
+                        
+                    end
+                    ##
+                    # Create the PluginVersionsInstance
+                    # @param [String] version The Flex Plugin Version's version.
+                    # @param [String] plugin_url The URL of the Flex Plugin Version bundle
+                    # @param [String] changelog The changelog of the Flex Plugin Version.
+                    # @param [Boolean] private Whether this Flex Plugin Version requires authorization.
+                    # @param [String] flex_metadata The Flex-Metadata HTTP request header
+                    # @return [PluginVersionsInstance] Created PluginVersionsInstance
+                    def create(
+                        version: nil, 
+                        plugin_url: nil, 
+                        changelog: :unset, 
+                        private: :unset, 
+                        flex_metadata: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Version' => version,
+                            'PluginUrl' => plugin_url,
+                            'Changelog' => changelog,
+                            'Private' => private,
+                        })
+
+                        
+                        headers = Twilio::Values.of({ 'Flex-Metadata' => flex_metadata, })
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
+                        PluginVersionsInstance.new(
+                            @version,
+                            payload,
+                            plugin_sid: @solution[:plugin_sid],
+                        )
+                    end
+
+                
+                    ##
+                    # Lists PluginVersionsInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [String] flex_metadata The Flex-Metadata HTTP request header
+                    # @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(flex_metadata: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            flex_metadata: flex_metadata,
+                            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 [String] flex_metadata The Flex-Metadata HTTP request header
+                    # @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(flex_metadata: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            flex_metadata: flex_metadata,
+                            page_size: limits[:page_size], )
+
+                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                    end
+
+                    ##
+                    # When passed a block, yields PluginVersionsInstance 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 PluginVersionsInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] flex_metadata The Flex-Metadata HTTP request header
+                    # @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 PluginVersionsInstance
+                    def page(flex_metadata: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            'Flex-Metadata' => flex_metadata,
+                            'PageToken' => page_token,
+                            'Page' => page_number,
+                            'PageSize' => page_size,
+                        })
+
+                        response = @version.page('GET', @uri, params: params)
+
+                        PluginVersionsPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of PluginVersionsInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of PluginVersionsInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    PluginVersionsPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.FlexApi.V1.PluginVersionsList>'
+                    end
+                end
+
+
+                class PluginVersionsContext < InstanceContext
+                    ##
+                    # Initialize the PluginVersionsContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] plugin_sid The SID of the Flex Plugin the resource to belongs to.
+                    # @param [String] sid The SID of the Flex Plugin Version resource to fetch.
+                    # @return [PluginVersionsContext] PluginVersionsContext
+                    def initialize(version, plugin_sid, sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { plugin_sid: plugin_sid, sid: sid,  }
+                        @uri = "/PluginService/Plugins/#{@solution[:plugin_sid]}/Versions/#{@solution[:sid]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the PluginVersionsInstance
+                    # @param [String] flex_metadata The Flex-Metadata HTTP request header
+                    # @return [PluginVersionsInstance] Fetched PluginVersionsInstance
+                    def fetch(
+                        flex_metadata: :unset
+                    )
+
+                        
+                        headers = Twilio::Values.of({ 'Flex-Metadata' => flex_metadata, })
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        PluginVersionsInstance.new(
+                            @version,
+                            payload,
+                            plugin_sid: @solution[:plugin_sid],
+                            sid: @solution[:sid],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.FlexApi.V1.PluginVersionsContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.FlexApi.V1.PluginVersionsContext #{context}>"
+                    end
+                end
+
+                class PluginVersionsPage < Page
+                    ##
+                    # Initialize the PluginVersionsPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [PluginVersionsPage] PluginVersionsPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of PluginVersionsInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [PluginVersionsInstance] PluginVersionsInstance
+                    def get_instance(payload)
+                        PluginVersionsInstance.new(@version, payload, plugin_sid: @solution[:plugin_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.FlexApi.V1.PluginVersionsPage>'
+                    end
+                end
+                class PluginVersionsInstance < InstanceResource
+                    ##
+                    # Initialize the PluginVersionsInstance
+                    # @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 PluginVersions
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [PluginVersionsInstance] PluginVersionsInstance
+                    def initialize(version, payload , plugin_sid: nil, sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'plugin_sid' => payload['plugin_sid'],
+                            'account_sid' => payload['account_sid'],
+                            'version' => payload['version'],
+                            'plugin_url' => payload['plugin_url'],
+                            'changelog' => payload['changelog'],
+                            'private' => payload['private'],
+                            'archived' => payload['archived'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'plugin_sid' => plugin_sid  || @properties['plugin_sid']  ,'sid' => sid  || @properties['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 [PluginVersionsContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = PluginVersionsContext.new(@version , @params['plugin_sid'], @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique string that we created to identify the Flex Plugin Version resource.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the Flex Plugin resource this Flex Plugin Version belongs to.
+                    def plugin_sid
+                        @properties['plugin_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin Version resource and owns this resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique version of this Flex Plugin Version.
+                    def version
+                        @properties['version']
+                    end
+                    
+                    ##
+                    # @return [String] The URL of where the Flex Plugin Version JavaScript bundle is hosted on.
+                    def plugin_url
+                        @properties['plugin_url']
+                    end
+                    
+                    ##
+                    # @return [String] A changelog that describes the changes this Flex Plugin Version brings.
+                    def changelog
+                        @properties['changelog']
+                    end
+                    
+                    ##
+                    # @return [Boolean] Whether to inject credentials while accessing this Plugin Version. The default value is false.
+                    def private
+                        @properties['private']
+                    end
+                    
+                    ##
+                    # @return [Boolean] Whether the Flex Plugin Version is archived. The default value is false.
+                    def archived
+                        @properties['archived']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT when the Flex Plugin Version was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute URL of the Flex Plugin Version resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the PluginVersionsInstance
+                    # @param [String] flex_metadata The Flex-Metadata HTTP request header
+                    # @return [PluginVersionsInstance] Fetched PluginVersionsInstance
+                    def fetch(
+                        flex_metadata: :unset
+                    )
+
+                        context.fetch(
+                            flex_metadata: flex_metadata, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.FlexApi.V1.PluginVersionsInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.FlexApi.V1.PluginVersionsInstance #{values}>"
+                    end
+                end
+
+             end
+            end
+        end
+    end
+end
+
+