## # This code was generated by # \ / _ _ _| _ _ # | (_)\/(_)(_|\/| |(/_ v1.0.0 # / / module Twilio module REST class Api < Domain class V2010 < Version class AccountContext < InstanceContext class ConnectAppList < ListResource ## # Initialize the ConnectAppList # @param [Version] version Version that contains the resource # @param [String] account_sid The unique id of the Account that created this # ConnectApp. # @return [ConnectAppList] ConnectAppList def initialize(version, account_sid: nil) super(version) # Path Solution @solution = { account_sid: account_sid } @uri = "/Accounts/#{@solution[:account_sid]}/ConnectApps.json" end ## # Lists ConnectAppInstance 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 ConnectAppInstance 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 ConnectAppInstance records from the API. # 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) 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 ConnectAppInstance 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 ConnectAppInstance def page(page_token: nil, page_number: nil, page_size: nil) params = { 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, } response = @version.page( 'GET', @uri, params ) return ConnectAppPage.new(@version, response, @solution) end ## # Provide a user friendly representation def to_s '#' end end class ConnectAppPage < Page ## # Initialize the ConnectAppPage # @param [Version] version Version that contains the resource # @param [Response] response Response from the API # @param [Hash] solution Path solution for the resource # @param [String] account_sid The unique id of the Account that created this # ConnectApp. # @return [ConnectAppPage] ConnectAppPage def initialize(version, response, solution) super(version, response) # Path Solution @solution = solution end ## # Build an instance of ConnectAppInstance # @param [Hash] payload Payload response from the API # @return [ConnectAppInstance] ConnectAppInstance def get_instance(payload) return ConnectAppInstance.new( @version, payload, account_sid: @solution[:account_sid], ) end ## # Provide a user friendly representation def to_s '' end end class ConnectAppContext < InstanceContext ## # Initialize the ConnectAppContext # @param [Version] version Version that contains the resource # @param [String] account_sid The account_sid # @param [String] sid The connect-app Sid that uniquely identifies this resource # @return [ConnectAppContext] ConnectAppContext def initialize(version, account_sid, sid) super(version) # Path Solution @solution = { account_sid: account_sid, sid: sid, } @uri = "/Accounts/#{@solution[:account_sid]}/ConnectApps/#{@solution[:sid]}.json" end ## # Fetch a ConnectAppInstance # @return [ConnectAppInstance] Fetched ConnectAppInstance def fetch params = {} payload = @version.fetch( 'GET', @uri, params, ) return ConnectAppInstance.new( @version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], ) end ## # Update the ConnectAppInstance # @param [String] authorize_redirect_url The URL the user's browser will redirect # to after Twilio authenticates the user and obtains authorization for this # Connect App. # @param [String] company_name The company name set for this Connect App. # @param [String] deauthorize_callback_method The HTTP method to be used when # making a request to the `DeauthorizeCallbackUrl`. # @param [String] deauthorize_callback_url The URL to which Twilio will send a # request when a user de-authorizes this Connect App. # @param [String] description A more detailed human readable description of the # Connect App. # @param [String] friendly_name A human readable name for the Connect App. # @param [String] homepage_url The public URL where users can obtain more # information about this Connect App. # @param [connect_app.Permission] permissions The set of permissions that your # ConnectApp requests. # @return [ConnectAppInstance] Updated ConnectAppInstance def update(authorize_redirect_url: nil, company_name: nil, deauthorize_callback_method: nil, deauthorize_callback_url: nil, description: nil, friendly_name: nil, homepage_url: nil, permissions: nil) data = { 'AuthorizeRedirectUrl' => authorize_redirect_url, 'CompanyName' => company_name, 'DeauthorizeCallbackMethod' => deauthorize_callback_method, 'DeauthorizeCallbackUrl' => deauthorize_callback_url, 'Description' => description, 'FriendlyName' => friendly_name, 'HomepageUrl' => homepage_url, 'Permissions' => permissions, } payload = @version.update( 'POST', @uri, data: data, ) return ConnectAppInstance.new( @version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], ) end ## # Provide a user friendly representation def to_s context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') "#" end end class ConnectAppInstance < InstanceResource ## # Initialize the ConnectAppInstance # @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 that created this # ConnectApp. # @param [String] sid The connect-app Sid that uniquely identifies this resource # @return [ConnectAppInstance] ConnectAppInstance def initialize(version, payload, account_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'authorize_redirect_url' => payload['authorize_redirect_url'], 'company_name' => payload['company_name'], 'deauthorize_callback_method' => payload['deauthorize_callback_method'], 'deauthorize_callback_url' => payload['deauthorize_callback_url'], 'description' => payload['description'], 'friendly_name' => payload['friendly_name'], 'homepage_url' => payload['homepage_url'], 'permissions' => payload['permissions'], 'sid' => payload['sid'], 'uri' => payload['uri'], } # Context @instance_context = nil @params = { 'account_sid' => account_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 # @param [Version] version Version that contains the resource # @return [ConnectAppContext] ConnectAppContext for this ConnectAppInstance def context unless @instance_context @instance_context = ConnectAppContext.new( @version, @params['account_sid'], @params['sid'], ) end @instance_context end def account_sid @properties['account_sid'] end def authorize_redirect_url @properties['authorize_redirect_url'] end def company_name @properties['company_name'] end def deauthorize_callback_method @properties['deauthorize_callback_method'] end def deauthorize_callback_url @properties['deauthorize_callback_url'] end def description @properties['description'] end def friendly_name @properties['friendly_name'] end def homepage_url @properties['homepage_url'] end def permissions @properties['permissions'] end def sid @properties['sid'] end def uri @properties['uri'] end ## # Fetch a ConnectAppInstance # @return [ConnectAppInstance] Fetched ConnectAppInstance def fetch context.fetch end ## # Update the ConnectAppInstance # @param [String] authorize_redirect_url The URL the user's browser will redirect # to after Twilio authenticates the user and obtains authorization for this # Connect App. # @param [String] company_name The company name set for this Connect App. # @param [String] deauthorize_callback_method The HTTP method to be used when # making a request to the `DeauthorizeCallbackUrl`. # @param [String] deauthorize_callback_url The URL to which Twilio will send a # request when a user de-authorizes this Connect App. # @param [String] description A more detailed human readable description of the # Connect App. # @param [String] friendly_name A human readable name for the Connect App. # @param [String] homepage_url The public URL where users can obtain more # information about this Connect App. # @param [connect_app.Permission] permissions The set of permissions that your # ConnectApp requests. # @return [ConnectAppInstance] Updated ConnectAppInstance def update(authorize_redirect_url: nil, company_name: nil, deauthorize_callback_method: nil, deauthorize_callback_url: nil, description: nil, friendly_name: nil, homepage_url: nil, permissions: nil) context.update( authorize_redirect_url: authorize_redirect_url, company_name: company_name, deauthorize_callback_method: deauthorize_callback_method, deauthorize_callback_url: deauthorize_callback_url, description: description, friendly_name: friendly_name, homepage_url: homepage_url, permissions: permissions, ) end ## # Provide a user friendly representation def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "" end end end end end end end