twilio-ruby 4.6.1 → 6.9.0

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

@@ -0,0 +1,346 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Api
+#    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 Api < ApiBase
+            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
+                    # @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
+                    ##
+                    # Create the AuthRegistrationsCredentialListMappingInstance
+                    # @param [String] credential_list_sid The SID of the CredentialList resource to map to the SIP domain.
+                    # @return [AuthRegistrationsCredentialListMappingInstance] 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 Instance 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: 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 AuthRegistrationsCredentialListMappingContext < InstanceContext
+                    ##
+                    # Initialize the AuthRegistrationsCredentialListMappingContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] account_sid The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resource to fetch.
+                    # @param [String] domain_sid The SID of the SIP domain that contains the resource to fetch.
+                    # @param [String] sid The Twilio-provided string that uniquely identifies the CredentialListMapping resource to fetch.
+                    # @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
+                    ##
+                    # Delete the AuthRegistrationsCredentialListMappingInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        @version.delete('DELETE', @uri)
+                    end
+
+                    ##
+                    # Fetch the AuthRegistrationsCredentialListMappingInstance
+                    # @return [AuthRegistrationsCredentialListMappingInstance] Fetched AuthRegistrationsCredentialListMappingInstance
+                    def fetch
+
+                        payload = @version.fetch('GET', @uri)
+                        AuthRegistrationsCredentialListMappingInstance.new(
+                            @version,
+                            payload,
+                            account_sid: @solution[:account_sid],
+                            domain_sid: @solution[:domain_sid],
+                            sid: @solution[:sid],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Api.V2010.AuthRegistrationsCredentialListMappingContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Api.V2010.AuthRegistrationsCredentialListMappingContext #{context}>"
+                    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 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 SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this AuthRegistrationsCredentialListMapping
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @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  || @properties['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] CallContext for this CallInstance
+                    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 SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # @return [String] The string that you assigned to describe the resource.
+                    def friendly_name
+                        @properties['friendly_name']
+                    end
+                    
+                    ##
+                    # @return [String] The unique string that that we created to identify the CredentialListMapping resource.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # Delete the AuthRegistrationsCredentialListMappingInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Fetch the AuthRegistrationsCredentialListMappingInstance
+                    # @return [AuthRegistrationsCredentialListMappingInstance] Fetched AuthRegistrationsCredentialListMappingInstance
+                    def fetch
+
+                        context.fetch
+                    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/api/v2010/account/sip/domain/auth_types/auth_type_registrations.rb

@@ -0,0 +1,126 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Api
+#    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 Api < ApiBase
+            class V2010 < Version
+                class AccountContext < InstanceContext
+                class SipList < ListResource
+                class DomainContext < InstanceContext
+                class AuthTypesList < ListResource
+
+                     class AuthTypeRegistrationsList < ListResource
+                    ##
+                    # Initialize the AuthTypeRegistrationsList
+                    # @param [Version] version Version that contains the resource
+                    # @return [AuthTypeRegistrationsList] AuthTypeRegistrationsList
+                    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.json"
+                        # Components
+                        @credential_list_mappings = nil
+                    end
+                
+
+                ##
+                # Access the credential_list_mappings
+                # @return [AuthRegistrationsCredentialListMappingList]
+                # @return [AuthRegistrationsCredentialListMappingContext] if sid was passed.
+                def credential_list_mappings(sid=:unset)
+                    raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+                    if sid != :unset
+                        return AuthRegistrationsCredentialListMappingContext.new(@version, @solution[:account_sid], @solution[:domain_sid],sid )
+                    end
+
+                    @credential_list_mappings ||= AuthRegistrationsCredentialListMappingList.new(@version, account_sid: @solution[:account_sid], domain_sid: @solution[:domain_sid] )
+                end
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Api.V2010.AuthTypeRegistrationsList>'
+                    end
+                end
+
+                class AuthTypeRegistrationsPage < Page
+                    ##
+                    # Initialize the AuthTypeRegistrationsPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [AuthTypeRegistrationsPage] AuthTypeRegistrationsPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of AuthTypeRegistrationsInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [AuthTypeRegistrationsInstance] AuthTypeRegistrationsInstance
+                    def get_instance(payload)
+                        AuthTypeRegistrationsInstance.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.AuthTypeRegistrationsPage>'
+                    end
+                end
+                class AuthTypeRegistrationsInstance < InstanceResource
+                    ##
+                    # Initialize the AuthTypeRegistrationsInstance
+                    # @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 AuthTypeRegistrations
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [AuthTypeRegistrationsInstance] AuthTypeRegistrationsInstance
+                    def initialize(version , account_sid: nil, domain_sid: nil)
+                        super(version)
+                        
+                    end
+
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Api.V2010.AuthTypeRegistrationsInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Api.V2010.AuthTypeRegistrationsInstance>"
+                    end
+                end
+
+             end
+             end
+             end
+             end
+            end
+        end
+    end
+end
+
+

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

@@ -0,0 +1,126 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Api
+#    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 Api < ApiBase
+            class V2010 < Version
+                class AccountContext < InstanceContext
+                class SipList < ListResource
+                class DomainContext < InstanceContext
+
+                     class AuthTypesList < ListResource
+                    ##
+                    # Initialize the AuthTypesList
+                    # @param [Version] version Version that contains the resource
+                    # @return [AuthTypesList] AuthTypesList
+                    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.json"
+                        # Components
+                        @calls = nil
+                        @registrations = nil
+                    end
+                
+
+                ##
+                # Access the calls
+                # @return [AuthTypeCallsList]
+                # @return [AuthTypeCallsContext]
+                def calls
+                    @calls ||= AuthTypeCallsList.new(@version, account_sid: @solution[:account_sid], domain_sid: @solution[:domain_sid] )
+                end
+                ##
+                # Access the registrations
+                # @return [AuthTypeRegistrationsList]
+                # @return [AuthTypeRegistrationsContext]
+                def registrations
+                    @registrations ||= AuthTypeRegistrationsList.new(@version, account_sid: @solution[:account_sid], domain_sid: @solution[:domain_sid] )
+                end
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Api.V2010.AuthTypesList>'
+                    end
+                end
+
+                class AuthTypesPage < Page
+                    ##
+                    # Initialize the AuthTypesPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [AuthTypesPage] AuthTypesPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of AuthTypesInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [AuthTypesInstance] AuthTypesInstance
+                    def get_instance(payload)
+                        AuthTypesInstance.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.AuthTypesPage>'
+                    end
+                end
+                class AuthTypesInstance < InstanceResource
+                    ##
+                    # Initialize the AuthTypesInstance
+                    # @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 AuthTypes
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [AuthTypesInstance] AuthTypesInstance
+                    def initialize(version , account_sid: nil, domain_sid: nil)
+                        super(version)
+                        
+                    end
+
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Api.V2010.AuthTypesInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Api.V2010.AuthTypesInstance>"
+                    end
+                end
+
+             end
+             end
+             end
+            end
+        end
+    end
+end
+
+