twilio-ruby 5.11.1 → 5.11.2

data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/auth_types/auth_registrations_mapping/auth_registrations_credential_list_mapping.rb

@@ -0,0 +1,349 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Api < Domain
+      class V2010 < Version
+        class AccountContext < InstanceContext
+          class SipList < ListResource
+            class DomainContext < InstanceContext
+              class AuthTypesList < ListResource
+                class AuthTypeRegistrationsList < ListResource
+                  class AuthRegistrationsCredentialListMappingList < ListResource
+                    ##
+                    # Initialize the AuthRegistrationsCredentialListMappingList
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] account_sid The unique id of the
+                    #   [Account](https://www.twilio.com/docs/api/rest/account) that sent this message.
+                    # @param [String] domain_sid A 34 character string that uniquely identifies the
+                    #   SIP domain in Twilio.
+                    # @return [AuthRegistrationsCredentialListMappingList] AuthRegistrationsCredentialListMappingList
+                    def initialize(version, account_sid: nil, domain_sid: nil)
+                      super(version)
+
+                      # Path Solution
+                      @solution = {account_sid: account_sid, domain_sid: domain_sid}
+                      @uri = "/Accounts/#{@solution[:account_sid]}/SIP/Domains/#{@solution[:domain_sid]}/Auth/Registrations/CredentialListMappings.json"
+                    end
+
+                    ##
+                    # Retrieve a single page of AuthRegistrationsCredentialListMappingInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] credential_list_sid A 34 character string that uniquely
+                    #   identifies this credential list resource
+                    # @return [AuthRegistrationsCredentialListMappingInstance] Newly created AuthRegistrationsCredentialListMappingInstance
+                    def create(credential_list_sid: nil)
+                      data = Twilio::Values.of({'CredentialListSid' => credential_list_sid, })
+
+                      payload = @version.create(
+                          'POST',
+                          @uri,
+                          data: data
+                      )
+
+                      AuthRegistrationsCredentialListMappingInstance.new(
+                          @version,
+                          payload,
+                          account_sid: @solution[:account_sid],
+                          domain_sid: @solution[:domain_sid],
+                      )
+                    end
+
+                    ##
+                    # Lists AuthRegistrationsCredentialListMappingInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list(limit: nil, page_size: nil)
+                      self.stream(limit: limit, page_size: page_size).entries
+                    end
+
+                    ##
+                    # Streams AuthRegistrationsCredentialListMappingInstance records from the API as an Enumerable.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit. Default is no limit.
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records. If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Enumerable] Enumerable that will yield up to limit results
+                    def stream(limit: nil, page_size: nil)
+                      limits = @version.read_limits(limit, page_size)
+
+                      page = self.page(page_size: limits[:page_size], )
+
+                      @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                    end
+
+                    ##
+                    # When passed a block, yields AuthRegistrationsCredentialListMappingInstance 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 AuthRegistrationsCredentialListMappingInstance 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 AuthRegistrationsCredentialListMappingInstance
+                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                      params = Twilio::Values.of({
+                          'PageToken' => page_token,
+                          'Page' => page_number,
+                          'PageSize' => page_size,
+                      })
+                      response = @version.page(
+                          'GET',
+                          @uri,
+                          params
+                      )
+                      AuthRegistrationsCredentialListMappingPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of AuthRegistrationsCredentialListMappingInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of AuthRegistrationsCredentialListMappingInstance
+                    def get_page(target_url)
+                      response = @version.domain.request(
+                          'GET',
+                          target_url
+                      )
+                      AuthRegistrationsCredentialListMappingPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                      '#<Twilio.Api.V2010.AuthRegistrationsCredentialListMappingList>'
+                    end
+                  end
+
+                  class AuthRegistrationsCredentialListMappingPage < Page
+                    ##
+                    # Initialize the AuthRegistrationsCredentialListMappingPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [AuthRegistrationsCredentialListMappingPage] AuthRegistrationsCredentialListMappingPage
+                    def initialize(version, response, solution)
+                      super(version, response)
+
+                      # Path Solution
+                      @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of AuthRegistrationsCredentialListMappingInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [AuthRegistrationsCredentialListMappingInstance] AuthRegistrationsCredentialListMappingInstance
+                    def get_instance(payload)
+                      AuthRegistrationsCredentialListMappingInstance.new(
+                          @version,
+                          payload,
+                          account_sid: @solution[:account_sid],
+                          domain_sid: @solution[:domain_sid],
+                      )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                      '<Twilio.Api.V2010.AuthRegistrationsCredentialListMappingPage>'
+                    end
+                  end
+
+                  class AuthRegistrationsCredentialListMappingContext < InstanceContext
+                    ##
+                    # Initialize the AuthRegistrationsCredentialListMappingContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] account_sid The account_sid
+                    # @param [String] domain_sid The domain_sid
+                    # @param [String] sid The credential list Sid that uniquely identifies this
+                    #   resource
+                    # @return [AuthRegistrationsCredentialListMappingContext] AuthRegistrationsCredentialListMappingContext
+                    def initialize(version, account_sid, domain_sid, sid)
+                      super(version)
+
+                      # Path Solution
+                      @solution = {account_sid: account_sid, domain_sid: domain_sid, sid: sid, }
+                      @uri = "/Accounts/#{@solution[:account_sid]}/SIP/Domains/#{@solution[:domain_sid]}/Auth/Registrations/CredentialListMappings/#{@solution[:sid]}.json"
+                    end
+
+                    ##
+                    # Fetch a AuthRegistrationsCredentialListMappingInstance
+                    # @return [AuthRegistrationsCredentialListMappingInstance] Fetched AuthRegistrationsCredentialListMappingInstance
+                    def fetch
+                      params = Twilio::Values.of({})
+
+                      payload = @version.fetch(
+                          'GET',
+                          @uri,
+                          params,
+                      )
+
+                      AuthRegistrationsCredentialListMappingInstance.new(
+                          @version,
+                          payload,
+                          account_sid: @solution[:account_sid],
+                          domain_sid: @solution[:domain_sid],
+                          sid: @solution[:sid],
+                      )
+                    end
+
+                    ##
+                    # Deletes the AuthRegistrationsCredentialListMappingInstance
+                    # @return [Boolean] true if delete succeeds, true otherwise
+                    def delete
+                      @version.delete('delete', @uri)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                      context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                      "#<Twilio.Api.V2010.AuthRegistrationsCredentialListMappingContext #{context}>"
+                    end
+                  end
+
+                  class AuthRegistrationsCredentialListMappingInstance < InstanceResource
+                    ##
+                    # Initialize the AuthRegistrationsCredentialListMappingInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The unique id of the
+                    #   [Account](https://www.twilio.com/docs/api/rest/account) that sent this message.
+                    # @param [String] domain_sid A 34 character string that uniquely identifies the
+                    #   SIP domain in Twilio.
+                    # @param [String] sid The credential list Sid that uniquely identifies this
+                    #   resource
+                    # @return [AuthRegistrationsCredentialListMappingInstance] AuthRegistrationsCredentialListMappingInstance
+                    def initialize(version, payload, account_sid: nil, domain_sid: nil, sid: nil)
+                      super(version)
+
+                      # Marshaled Properties
+                      @properties = {
+                          'account_sid' => payload['account_sid'],
+                          'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
+                          'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                          'friendly_name' => payload['friendly_name'],
+                          'sid' => payload['sid'],
+                      }
+
+                      # Context
+                      @instance_context = nil
+                      @params = {
+                          'account_sid' => account_sid,
+                          'domain_sid' => domain_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 [AuthRegistrationsCredentialListMappingContext] AuthRegistrationsCredentialListMappingContext for this AuthRegistrationsCredentialListMappingInstance
+                    def context
+                      unless @instance_context
+                        @instance_context = AuthRegistrationsCredentialListMappingContext.new(
+                            @version,
+                            @params['account_sid'],
+                            @params['domain_sid'],
+                            @params['sid'],
+                        )
+                      end
+                      @instance_context
+                    end
+
+                    ##
+                    # @return [String] The unique sid that identifies this account
+                    def account_sid
+                      @properties['account_sid']
+                    end
+
+                    ##
+                    # @return [Time] The date this resource was created
+                    def date_created
+                      @properties['date_created']
+                    end
+
+                    ##
+                    # @return [Time] The date this resource was last updated
+                    def date_updated
+                      @properties['date_updated']
+                    end
+
+                    ##
+                    # @return [String] A human readable description of this resource
+                    def friendly_name
+                      @properties['friendly_name']
+                    end
+
+                    ##
+                    # @return [String] A string that uniquely identifies this resource
+                    def sid
+                      @properties['sid']
+                    end
+
+                    ##
+                    # Fetch a AuthRegistrationsCredentialListMappingInstance
+                    # @return [AuthRegistrationsCredentialListMappingInstance] Fetched AuthRegistrationsCredentialListMappingInstance
+                    def fetch
+                      context.fetch
+                    end
+
+                    ##
+                    # Deletes the AuthRegistrationsCredentialListMappingInstance
+                    # @return [Boolean] true if delete succeeds, true otherwise
+                    def delete
+                      context.delete
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                      values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                      "<Twilio.Api.V2010.AuthRegistrationsCredentialListMappingInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                      values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                      "<Twilio.Api.V2010.AuthRegistrationsCredentialListMappingInstance #{values}>"
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/preview.rb

@@ -134,6 +134,14 @@ module Twilio
         self.hosted_numbers.hosted_number_orders(sid)
       end
 
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this Add-on.
+      # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
+      def available_add_ons(sid=:unset)
+        self.marketplace.available_add_ons(sid)
+      end
+
       ##
       # @param [String] sid 34 character string that uniquely identifies the Add-on.
       #   This Sid can also be found in the Console on that specific Add-ons page as the
@@ -144,14 +152,6 @@ module Twilio
         self.marketplace.installed_add_ons(sid)
       end
 
-      ##
-      # @param [String] sid A 34 character string that uniquely identifies this Add-on.
-      # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnInstance] if sid was passed.
-      # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
-      def available_add_ons(sid=:unset)
-        self.marketplace.available_add_ons(sid)
-      end
-
       ##
       # @param [String] sid The sid
       # @return [Twilio::REST::Preview::Sync::ServiceInstance] if sid was passed.

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

@@ -15,37 +15,37 @@ module Twilio
         def initialize(domain)
           super
           @version = 'marketplace'
-          @installed_add_ons = nil
           @available_add_ons = nil
+          @installed_add_ons = nil
         end
 
         ##
-        # @param [String] sid The Installed Add-on Sid that uniquely identifies this
+        # @param [String] sid The Available Add-on Sid that uniquely identifies this
         #   resource
-        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnContext] if sid was passed.
-        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnList]
-        def installed_add_ons(sid=:unset)
+        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnContext] if sid was passed.
+        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
+        def available_add_ons(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
           elsif sid == :unset
-            @installed_add_ons ||= InstalledAddOnList.new self
+            @available_add_ons ||= AvailableAddOnList.new self
           else
-            InstalledAddOnContext.new(self, sid)
+            AvailableAddOnContext.new(self, sid)
           end
         end
 
         ##
-        # @param [String] sid The Available Add-on Sid that uniquely identifies this
+        # @param [String] sid The Installed Add-on Sid that uniquely identifies this
         #   resource
-        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnContext] if sid was passed.
-        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
-        def available_add_ons(sid=:unset)
+        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnContext] if sid was passed.
+        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnList]
+        def installed_add_ons(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
           elsif sid == :unset
-            @available_add_ons ||= AvailableAddOnList.new self
+            @installed_add_ons ||= InstalledAddOnList.new self
           else
-            AvailableAddOnContext.new(self, sid)
+            InstalledAddOnContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/preview/understand/assistant.rb

@@ -116,7 +116,6 @@ module Twilio
           #   logged for 30 days further training. If false, no queries will be stored, if
           #   true, queries will be stored for 30 days and deleted thereafter. Defaults to
           #   true if no value is provided.
-          # @param [String] ttl The ttl
           # @param [String] unique_name A user-provided string that uniquely identifies this
           #   resource as an alternative to the sid. Unique up to 64 characters long.
           # @param [String] response_url The webhook URL called to fetch the response to an
@@ -124,11 +123,10 @@ module Twilio
           # @param [String] callback_url The callback_url
           # @param [String] callback_events The callback_events
           # @return [AssistantInstance] Newly created AssistantInstance
-          def create(friendly_name: :unset, log_queries: :unset, ttl: :unset, unique_name: :unset, response_url: :unset, callback_url: :unset, callback_events: :unset)
+          def create(friendly_name: :unset, log_queries: :unset, unique_name: :unset, response_url: :unset, callback_url: :unset, callback_events: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'LogQueries' => log_queries,
-                'Ttl' => ttl,
                 'UniqueName' => unique_name,
                 'ResponseUrl' => response_url,
                 'CallbackUrl' => callback_url,
@@ -227,7 +225,6 @@ module Twilio
           #   logged for 30 days further training. If false, no queries will be stored, if
           #   true, queries will be stored for 30 days and deleted thereafter. Defaults to
           #   true if no value is provided.
-          # @param [String] ttl The ttl
           # @param [String] unique_name A user-provided string that uniquely identifies this
           #   resource as an alternative to the sid. Unique up to 64 characters long.
           # @param [String] response_url The webhook URL called to fetch the response to an
@@ -235,11 +232,10 @@ module Twilio
           # @param [String] callback_url The callback_url
           # @param [String] callback_events The callback_events
           # @return [AssistantInstance] Updated AssistantInstance
-          def update(friendly_name: :unset, log_queries: :unset, ttl: :unset, unique_name: :unset, response_url: :unset, callback_url: :unset, callback_events: :unset)
+          def update(friendly_name: :unset, log_queries: :unset, unique_name: :unset, response_url: :unset, callback_url: :unset, callback_events: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'LogQueries' => log_queries,
-                'Ttl' => ttl,
                 'UniqueName' => unique_name,
                 'ResponseUrl' => response_url,
                 'CallbackUrl' => callback_url,
@@ -364,7 +360,6 @@ module Twilio
                 'links' => payload['links'],
                 'log_queries' => payload['log_queries'],
                 'sid' => payload['sid'],
-                'ttl' => payload['ttl'].to_i,
                 'unique_name' => payload['unique_name'],
                 'url' => payload['url'],
                 'response_url' => payload['response_url'],
@@ -436,12 +431,6 @@ module Twilio
             @properties['sid']
           end
 
-          ##
-          # @return [String] The ttl
-          def ttl
-            @properties['ttl']
-          end
-
           ##
           # @return [String] A user-provided string that uniquely identifies this resource as an alternative to the sid. You can use the unique name in the URL path. Unique up to 64 characters long.
           def unique_name
@@ -487,7 +476,6 @@ module Twilio
           #   logged for 30 days further training. If false, no queries will be stored, if
           #   true, queries will be stored for 30 days and deleted thereafter. Defaults to
           #   true if no value is provided.
-          # @param [String] ttl The ttl
           # @param [String] unique_name A user-provided string that uniquely identifies this
           #   resource as an alternative to the sid. Unique up to 64 characters long.
           # @param [String] response_url The webhook URL called to fetch the response to an
@@ -495,11 +483,10 @@ module Twilio
           # @param [String] callback_url The callback_url
           # @param [String] callback_events The callback_events
           # @return [AssistantInstance] Updated AssistantInstance
-          def update(friendly_name: :unset, log_queries: :unset, ttl: :unset, unique_name: :unset, response_url: :unset, callback_url: :unset, callback_events: :unset)
+          def update(friendly_name: :unset, log_queries: :unset, unique_name: :unset, response_url: :unset, callback_url: :unset, callback_events: :unset)
             context.update(
                 friendly_name: friendly_name,
                 log_queries: log_queries,
-                ttl: ttl,
                 unique_name: unique_name,
                 response_url: response_url,
                 callback_url: callback_url,