twilio-ruby 7.4.4 → 7.10.4

data/lib/twilio-ruby/rest/iam/v1/o_auth_app.rb

@@ -0,0 +1,646 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Iam
+#    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 Iam < IamBase
+            class V1 < Version
+                class OAuthAppList < ListResource
+                
+                    class IamV1AccountVendorOauthAppCreateRequest
+                            # @param [type]: [String] 
+                            # @param [friendly_name]: [String] 
+                            # @param [owner_sid]: [String] 
+                            # @param [description]: [String] 
+                            # @param [client_sid]: [String] 
+                            # @param [policy]: [OAuthAppList.IamV1OrganizationVendoroauthappPolicy] 
+                            # @param [access_token_ttl]: [String] 
+                        attr_accessor :type, :friendly_name, :owner_sid, :description, :client_sid, :policy, :access_token_ttl
+                        def initialize(payload)
+                                @type = payload["type"]
+                                @friendly_name = payload["friendly_name"]
+                                @owner_sid = payload["owner_sid"]
+                                @description = payload["description"]
+                                @client_sid = payload["client_sid"]
+                                @policy = payload["policy"]
+                                @access_token_ttl = payload["access_token_ttl"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "type": @type,
+                                "friendly_name": @friendly_name,
+                                "owner_sid": @owner_sid,
+                                "description": @description,
+                                "client_sid": @client_sid,
+                                "policy": @policy,
+                                "access_token_ttl": @access_token_ttl,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class IamV1AccountVendorOauthAppUpdateRequest
+                            # @param [type]: [String] 
+                            # @param [friendly_name]: [String] 
+                            # @param [description]: [String] 
+                            # @param [policy]: [OAuthAppList.IamV1OrganizationVendorOauthAppUpdateRequestPolicy] 
+                            # @param [access_token_ttl]: [String] 
+                        attr_accessor :type, :friendly_name, :description, :policy, :access_token_ttl
+                        def initialize(payload)
+                                @type = payload["type"]
+                                @friendly_name = payload["friendly_name"]
+                                @description = payload["description"]
+                                @policy = payload["policy"]
+                                @access_token_ttl = payload["access_token_ttl"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "type": @type,
+                                "friendly_name": @friendly_name,
+                                "description": @description,
+                                "policy": @policy,
+                                "access_token_ttl": @access_token_ttl,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class IamV1OrganizationVendorOauthAppUpdateRequestPolicy
+                            # @param [allow]: [Array<String>] Set of permissions explicitly allowed
+                            # @param [deny]: [Array<String>] Set of permissions explicitly denied
+                        attr_accessor :allow, :deny
+                        def initialize(payload)
+                                @allow = payload["allow"]
+                                @deny = payload["deny"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "allow": @allow,
+                                "deny": @deny,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    class IamV1AccountVendorOauthAppCreateRequest
+                            # @param [type]: [String] 
+                            # @param [friendly_name]: [String] 
+                            # @param [owner_sid]: [String] 
+                            # @param [description]: [String] 
+                            # @param [client_sid]: [String] 
+                            # @param [policy]: [OAuthAppList.IamV1OrganizationVendoroauthappPolicy] 
+                            # @param [access_token_ttl]: [String] 
+                        attr_accessor :type, :friendly_name, :owner_sid, :description, :client_sid, :policy, :access_token_ttl
+                        def initialize(payload)
+                                @type = payload["type"]
+                                @friendly_name = payload["friendly_name"]
+                                @owner_sid = payload["owner_sid"]
+                                @description = payload["description"]
+                                @client_sid = payload["client_sid"]
+                                @policy = payload["policy"]
+                                @access_token_ttl = payload["access_token_ttl"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "type": @type,
+                                "friendly_name": @friendly_name,
+                                "owner_sid": @owner_sid,
+                                "description": @description,
+                                "client_sid": @client_sid,
+                                "policy": @policy,
+                                "access_token_ttl": @access_token_ttl,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class IamV1AccountVendorOauthAppUpdateRequest
+                            # @param [type]: [String] 
+                            # @param [friendly_name]: [String] 
+                            # @param [description]: [String] 
+                            # @param [policy]: [OAuthAppList.IamV1OrganizationVendorOauthAppUpdateRequestPolicy] 
+                            # @param [access_token_ttl]: [String] 
+                        attr_accessor :type, :friendly_name, :description, :policy, :access_token_ttl
+                        def initialize(payload)
+                                @type = payload["type"]
+                                @friendly_name = payload["friendly_name"]
+                                @description = payload["description"]
+                                @policy = payload["policy"]
+                                @access_token_ttl = payload["access_token_ttl"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "type": @type,
+                                "friendly_name": @friendly_name,
+                                "description": @description,
+                                "policy": @policy,
+                                "access_token_ttl": @access_token_ttl,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class IamV1OrganizationVendorOauthAppUpdateRequestPolicy
+                            # @param [allow]: [Array<String>] Set of permissions explicitly allowed
+                            # @param [deny]: [Array<String>] Set of permissions explicitly denied
+                        attr_accessor :allow, :deny
+                        def initialize(payload)
+                                @allow = payload["allow"]
+                                @deny = payload["deny"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "allow": @allow,
+                                "deny": @deny,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the OAuthAppList
+                    # @param [Version] version Version that contains the resource
+                    # @return [OAuthAppList] OAuthAppList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Account/OAuthApps"
+                        
+                    end
+                    ##
+                    # Create the OAuthAppInstance
+                    # @param [IamV1AccountVendorOauthAppCreateRequest] iam_v1_account_vendor_oauth_app_create_request 
+                    # @return [OAuthAppInstance] Created OAuthAppInstance
+                    def create(iam_v1_account_vendor_oauth_app_create_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: iam_v1_account_vendor_oauth_app_create_request.to_json)
+                        OAuthAppInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the OAuthAppInstanceMetadata
+                    # @param [IamV1AccountVendorOauthAppCreateRequest] iam_v1_account_vendor_oauth_app_create_request 
+                    # @return [OAuthAppInstance] Created OAuthAppInstance
+                    def create_with_metadata(iam_v1_account_vendor_oauth_app_create_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: iam_v1_account_vendor_oauth_app_create_request.to_json)
+                        o_auth_app_instance = OAuthAppInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        OAuthAppInstanceMetadata.new(
+                            @version,
+                            o_auth_app_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Iam.V1.OAuthAppList>'
+                    end
+                end
+
+
+                class OAuthAppContext < InstanceContext
+                    ##
+                    # Initialize the OAuthAppContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] sid Unique ID (sid) of the OAuth app
+                    # @return [OAuthAppContext] OAuthAppContext
+                    def initialize(version, sid)
+                        super(version)
+                        
+
+                        # Path Solution
+                        @solution = { sid: sid,  }
+                        @uri = "/Account/OAuthApps/#{@solution[:sid]}"
+
+                        
+                    end
+                    ##
+                    # Delete the OAuthAppInstance
+                    # @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
+
+                    ##
+                    # Delete the OAuthAppInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          oAuthApp_instance = OAuthAppInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          OAuthAppInstanceMetadata.new(@version, oAuthApp_instance, response.headers, response.status_code)
+                    end
+
+                    ##
+                    # Update the OAuthAppInstance
+                    # @param [IamV1AccountVendorOauthAppUpdateRequest] iam_v1_account_vendor_oauth_app_update_request 
+                    # @return [OAuthAppInstance] Updated OAuthAppInstance
+                    def update(iam_v1_account_vendor_oauth_app_update_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.update('PUT', @uri, headers: headers, data: iam_v1_account_vendor_oauth_app_update_request.to_json)
+                        OAuthAppInstance.new(
+                            @version,
+                            payload,
+                            sid: @solution[:sid],
+                        )
+                    end
+
+                    ##
+                    # Update the OAuthAppInstanceMetadata
+                    # @param [IamV1AccountVendorOauthAppUpdateRequest] iam_v1_account_vendor_oauth_app_update_request 
+                    # @return [OAuthAppInstance] Updated OAuthAppInstance
+                    def update_with_metadata(iam_v1_account_vendor_oauth_app_update_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('PUT', @uri, headers: headers, data: iam_v1_account_vendor_oauth_app_update_request.to_json)
+                        o_auth_app_instance = OAuthAppInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        OAuthAppInstanceMetadata.new(
+                            @version,
+                            o_auth_app_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Iam.V1.OAuthAppContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Iam.V1.OAuthAppContext #{context}>"
+                    end
+                end
+
+                class OAuthAppInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new OAuthAppInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}OAuthAppInstance] o_auth_app_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [OAuthAppInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, o_auth_app_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @o_auth_app_instance = o_auth_app_instance
+                    end
+
+                    def o_auth_app
+                        @o_auth_app_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.OAuthAppInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class OAuthAppListResponse < InstanceListResource
+                    # @param [Array<OAuthAppInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @o_auth_app_instance = payload.body[key].map do |data|
+                        OAuthAppInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def o_auth_app_instance
+                          @instance
+                      end
+                  end
+
+                class OAuthAppPage < Page
+                    ##
+                    # Initialize the OAuthAppPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [OAuthAppPage] OAuthAppPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of OAuthAppInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [OAuthAppInstance] OAuthAppInstance
+                    def get_instance(payload)
+                        OAuthAppInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Iam.V1.OAuthAppPage>'
+                    end
+                end
+
+                class OAuthAppPageMetadata < PageMetadata
+                    attr_reader :o_auth_app_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @o_auth_app_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @o_auth_app_page << OAuthAppListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @o_auth_app_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Iam::V1PageMetadata>';
+                    end
+                end
+                class OAuthAppListResponse < InstanceListResource
+
+                    # @param [Array<OAuthAppInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @o_auth_app = data_list.map do |data|
+                        OAuthAppInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def o_auth_app
+                        @o_auth_app
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class OAuthAppInstance < InstanceResource
+                    ##
+                    # Initialize the OAuthAppInstance
+                    # @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 OAuthApp
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [OAuthAppInstance] OAuthAppInstance
+                    def initialize(version, payload , sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'type' => payload['type'],
+                            'sid' => payload['sid'],
+                            'friendly_name' => payload['friendly_name'],
+                            'description' => payload['description'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'created_by' => payload['created_by'],
+                            'secret' => payload['secret'],
+                            'status' => payload['status'],
+                            'policy' => payload['policy'],
+                            'access_token_ttl' => payload['access_token_ttl'] == nil ? payload['access_token_ttl'] : payload['access_token_ttl'].to_i,
+                            'code' => payload['code'],
+                            'message' => payload['message'],
+                            'more_info' => payload['more_info'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { '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 [OAuthAppContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = OAuthAppContext.new(@version , @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def type
+                        @properties['type']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def friendly_name
+                        @properties['friendly_name']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def description
+                        @properties['description']
+                    end
+                    
+                    ##
+                    # @return [Time] 
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def created_by
+                        @properties['created_by']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def secret
+                        @properties['secret']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [IamV1OrganizationVendoroauthappPolicy] 
+                    def policy
+                        @properties['policy']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def access_token_ttl
+                        @properties['access_token_ttl']
+                    end
+                    
+                    ##
+                    # @return [String] Twilio-specific error code
+                    def code
+                        @properties['code']
+                    end
+                    
+                    ##
+                    # @return [String] Error message
+                    def message
+                        @properties['message']
+                    end
+                    
+                    ##
+                    # @return [String] Link to Error Code References
+                    def more_info
+                        @properties['more_info']
+                    end
+                    
+                    ##
+                    # Delete the OAuthAppInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Update the OAuthAppInstance
+                    # @param [IamV1AccountVendorOauthAppUpdateRequest] iam_v1_account_vendor_oauth_app_update_request 
+                    # @return [OAuthAppInstance] Updated OAuthAppInstance
+                    def update(iam_v1_account_vendor_oauth_app_update_request: nil
+                    )
+
+                        context.update(
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Iam.V1.OAuthAppInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Iam.V1.OAuthAppInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end