twilio-ruby 6.8.0 → 7.10.7

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

@@ -0,0 +1,327 @@
+##
+#    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 RolePermissionList < ListResource
+                
+                    ##
+                    # Initialize the RolePermissionList
+                    # @param [Version] version Version that contains the resource
+                    # @return [RolePermissionList] RolePermissionList
+                    def initialize(version, role_sid: nil)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = { role_sid: role_sid }
+                        @uri = "/Roles/#{@solution[:role_sid]}/Permissions"
+                        
+                    end
+                
+                    ##
+                    # Lists RolePermissionInstance 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], )
+
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists RolePermissionPageMetadata records from the API as a list.
+                    # @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_with_metadata(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        RolePermissionPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields RolePermissionInstance 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], )
+
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
+                    end
+
+                    ##
+                    # Retrieve a single page of RolePermissionInstance 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 RolePermissionInstance
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
+                        params = Twilio::Values.of({
+                            'PageToken' => page_token,
+                            'Page' => page_number,
+                            'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        RolePermissionPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of RolePermissionInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of RolePermissionInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    RolePermissionPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Iam.V1.RolePermissionList>'
+                    end
+                end
+
+                class RolePermissionPage < Page
+                    ##
+                    # Initialize the RolePermissionPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [RolePermissionPage] RolePermissionPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of RolePermissionInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [RolePermissionInstance] RolePermissionInstance
+                    def get_instance(payload)
+                        RolePermissionInstance.new(@version, payload, role_sid: @solution[:role_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Iam.V1.RolePermissionPage>'
+                    end
+                end
+
+                class RolePermissionPageMetadata < PageMetadata
+                    attr_reader :role_permission_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @role_permission_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @role_permission_page << RolePermissionListResponse.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
+                        @role_permission_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Iam::V1PageMetadata>';
+                    end
+                end
+                class RolePermissionListResponse < InstanceListResource
+
+                    # @param [Array<RolePermissionInstance>] 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
+                      @role_permission = data_list.map do |data|
+                        RolePermissionInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def role_permission
+                        @role_permission
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class RolePermissionInstance < InstanceResource
+                    ##
+                    # Initialize the RolePermissionInstance
+                    # @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 RolePermission
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [RolePermissionInstance] RolePermissionInstance
+                    def initialize(version, payload , role_sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'namespace' => payload['namespace'],
+                            'product' => payload['product'],
+                            'resource' => payload['resource'],
+                            'action' => payload['action'],
+                            'external_description' => payload['external_description'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] The unique string that identifies the Permission resource.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] The namespace of the permission (e.g., twilio).
+                    def namespace
+                        @properties['namespace']
+                    end
+                    
+                    ##
+                    # @return [String] The product the permission belongs to (e.g., iam).
+                    def product
+                        @properties['product']
+                    end
+                    
+                    ##
+                    # @return [String] The resource the permission applies to (e.g., roles).
+                    def resource
+                        @properties['resource']
+                    end
+                    
+                    ##
+                    # @return [String] The action granted by the permission (e.g., read).
+                    def action
+                        @properties['action']
+                    end
+                    
+                    ##
+                    # @return [String] The external description of the permission.
+                    def external_description
+                        @properties['external_description']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Iam.V1.RolePermissionInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Iam.V1.RolePermissionInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,301 @@
+##
+#    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 TokenList < ListResource
+                
+                    ##
+                    # Initialize the TokenList
+                    # @param [Version] version Version that contains the resource
+                    # @return [TokenList] TokenList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/token"
+                        
+                    end
+                    ##
+                    # Create the TokenInstance
+                    # @param [String] grant_type Grant type is a credential representing resource owner's authorization which can be used by client to obtain access token.
+                    # @param [String] client_id A 34 character string that uniquely identifies this OAuth App.
+                    # @param [String] client_secret The credential for confidential OAuth App.
+                    # @param [String] code JWT token related to the authorization code grant type.
+                    # @param [String] redirect_uri The redirect uri
+                    # @param [String] audience The targeted audience uri
+                    # @param [String] refresh_token JWT token related to refresh access token.
+                    # @param [String] scope The scope of token
+                    # @return [TokenInstance] Created TokenInstance
+                    def create(
+                      grant_type: nil, 
+                      client_id: nil, 
+                      client_secret: :unset, 
+                      code: :unset, 
+                      redirect_uri: :unset, 
+                      audience: :unset, 
+                      refresh_token: :unset, 
+                      scope: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'grant_type' => grant_type,
+                            'client_id' => client_id,
+                            'client_secret' => client_secret,
+                            'code' => code,
+                            'redirect_uri' => redirect_uri,
+                            'audience' => audience,
+                            'refresh_token' => refresh_token,
+                            'scope' => scope,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
+                        TokenInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the TokenInstanceMetadata
+                    # @param [String] grant_type Grant type is a credential representing resource owner's authorization which can be used by client to obtain access token.
+                    # @param [String] client_id A 34 character string that uniquely identifies this OAuth App.
+                    # @param [String] client_secret The credential for confidential OAuth App.
+                    # @param [String] code JWT token related to the authorization code grant type.
+                    # @param [String] redirect_uri The redirect uri
+                    # @param [String] audience The targeted audience uri
+                    # @param [String] refresh_token JWT token related to refresh access token.
+                    # @param [String] scope The scope of token
+                    # @return [TokenInstance] Created TokenInstance
+                    def create_with_metadata(
+                      grant_type: nil, 
+                      client_id: nil, 
+                      client_secret: :unset, 
+                      code: :unset, 
+                      redirect_uri: :unset, 
+                      audience: :unset, 
+                      refresh_token: :unset, 
+                      scope: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'grant_type' => grant_type,
+                            'client_id' => client_id,
+                            'client_secret' => client_secret,
+                            'code' => code,
+                            'redirect_uri' => redirect_uri,
+                            'audience' => audience,
+                            'refresh_token' => refresh_token,
+                            'scope' => scope,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        token_instance = TokenInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        TokenInstanceMetadata.new(
+                            @version,
+                            token_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Iam.V1.TokenList>'
+                    end
+                end
+
+                class TokenPage < Page
+                    ##
+                    # Initialize the TokenPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [TokenPage] TokenPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of TokenInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [TokenInstance] TokenInstance
+                    def get_instance(payload)
+                        TokenInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Iam.V1.TokenPage>'
+                    end
+                end
+
+                class TokenPageMetadata < PageMetadata
+                    attr_reader :token_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @token_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @token_page << TokenListResponse.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
+                        @token_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Iam::V1PageMetadata>';
+                    end
+                end
+                class TokenListResponse < InstanceListResource
+
+                    # @param [Array<TokenInstance>] 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
+                      @token = data_list.map do |data|
+                        TokenInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def token
+                        @token
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class TokenInstance < InstanceResource
+                    ##
+                    # Initialize the TokenInstance
+                    # @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 Token
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [TokenInstance] TokenInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'access_token' => payload['access_token'],
+                            'refresh_token' => payload['refresh_token'],
+                            'id_token' => payload['id_token'],
+                            'token_type' => payload['token_type'],
+                            'expires_in' => payload['expires_in'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] Token which carries the necessary information to access a Twilio resource directly.
+                    def access_token
+                        @properties['access_token']
+                    end
+                    
+                    ##
+                    # @return [String] Token which carries the information necessary to get a new access token.
+                    def refresh_token
+                        @properties['refresh_token']
+                    end
+                    
+                    ##
+                    # @return [String] Token which carries the information necessary of user profile.
+                    def id_token
+                        @properties['id_token']
+                    end
+                    
+                    ##
+                    # @return [String] Token type
+                    def token_type
+                        @properties['token_type']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def expires_in
+                        @properties['expires_in']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Iam.V1.TokenInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Iam.V1.TokenInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end