twilio-ruby 7.4.4 → 7.10.4

data/lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb

@@ -21,6 +21,135 @@ module Twilio
 
                      class UserList < ListResource
                 
+                    class ScimPatchOperation
+                            # @param [op]: [String] The operation to perform
+                            # @param [path]: [String] 
+                            # @param [value]: [Hash] 
+                        attr_accessor :op, :path, :value
+                        def initialize(payload)
+                                @op = payload["op"]
+                                @path = payload["path"]
+                                @value = payload["value"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "op": @op,
+                                "path": @path,
+                                "value": @value,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ScimPatchRequest
+                            # @param [schemas]: [Array<String>] 
+                            # @param [operations]: [Array<UserList.ScimPatchOperation>] 
+                        attr_accessor :schemas, :operations
+                        def initialize(payload)
+                                @schemas = payload["schemas"]
+                                @operations = payload["operations"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "schemas": @schemas,
+                                "Operations": @operations,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ScimUser
+                            # @param [id]: [String] Unique Twilio user sid
+                            # @param [external_id]: [String] External unique resource id defined by provisioning client
+                            # @param [user_name]: [String] Unique username, MUST be same as primary email address
+                            # @param [display_name]: [String] User friendly display name
+                            # @param [name]: [UserList.ScimName] 
+                            # @param [emails]: [Array<UserList.ScimEmailAddress>] Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.
+                            # @param [active]: [Boolean] Indicates whether the user is active
+                            # @param [locale]: [String] User's locale
+                            # @param [timezone]: [String] User's time zone
+                            # @param [schemas]: [Array<String>] An array of URIs that indicate the schemas supported for this user resource
+                            # @param [meta]: [UserList.ScimMeta] 
+                            # @param [detail]: [String] A human-readable description of the error
+                            # @param [scim_type]: [String] A scimType error code as defined in RFC7644
+                            # @param [status]: [String] Http status code
+                            # @param [code]: [String] Twilio-specific error code
+                            # @param [more_info]: [String] Link to Error Code References
+                        attr_accessor :id, :external_id, :user_name, :display_name, :name, :emails, :active, :locale, :timezone, :schemas, :meta, :detail, :scim_type, :status, :code, :more_info
+                        def initialize(payload)
+                                @id = payload["id"]
+                                @external_id = payload["external_id"]
+                                @user_name = payload["user_name"]
+                                @display_name = payload["display_name"]
+                                @name = payload["name"]
+                                @emails = payload["emails"]
+                                @active = payload["active"]
+                                @locale = payload["locale"]
+                                @timezone = payload["timezone"]
+                                @schemas = payload["schemas"]
+                                @meta = payload["meta"]
+                                @detail = payload["detail"]
+                                @scim_type = payload["scim_type"]
+                                @status = payload["status"]
+                                @code = payload["code"]
+                                @more_info = payload["more_info"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "id": @id,
+                                "externalId": @external_id,
+                                "userName": @user_name,
+                                "displayName": @display_name,
+                                "name": @name,
+                                "emails": @emails,
+                                "active": @active,
+                                "locale": @locale,
+                                "timezone": @timezone,
+                                "schemas": @schemas,
+                                "meta": @meta,
+                                "detail": @detail,
+                                "scimType": @scim_type,
+                                "status": @status,
+                                "code": @code,
+                                "moreInfo": @more_info,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    class ScimPatchOperation
+                            # @param [op]: [String] The operation to perform
+                            # @param [path]: [String] 
+                            # @param [value]: [Hash] 
+                        attr_accessor :op, :path, :value
+                        def initialize(payload)
+                                @op = payload["op"]
+                                @path = payload["path"]
+                                @value = payload["value"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "op": @op,
+                                "path": @path,
+                                "value": @value,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ScimPatchRequest
+                            # @param [schemas]: [Array<String>] 
+                            # @param [operations]: [Array<UserList.ScimPatchOperation>] 
+                        attr_accessor :schemas, :operations
+                        def initialize(payload)
+                                @schemas = payload["schemas"]
+                                @operations = payload["operations"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "schemas": @schemas,
+                                "Operations": @operations,
+                        }.to_json(options)
+                        end
+                    end
+
                     class ScimUser
                             # @param [id]: [String] Unique Twilio user sid
                             # @param [external_id]: [String] External unique resource id defined by provisioning client
@@ -86,6 +215,7 @@ module Twilio
                     # @return [UserList] UserList
                     def initialize(version, organization_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { organization_sid: organization_sid }
                         @uri = "/#{@solution[:organization_sid]}/scim/Users"
@@ -112,6 +242,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the UserInstanceMetadata
+                    # @param [ScimUser] scim_user 
+                    # @return [UserInstance] Created UserInstance
+                    def create_with_metadata(scim_user: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        headers['Content-Type'] = 'application/scim+json'
+                        
+                        headers['Accept'] = 'application/scim+json'
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: scim_user.to_json)
+                        user_instance = UserInstance.new(
+                            @version,
+                            response.body,
+                            organization_sid: @solution[:organization_sid],
+                        )
+                        UserInstanceMetadata.new(
+                            @version,
+                            user_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists UserInstance records from the API as a list.
@@ -155,6 +312,30 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists UserPageMetadata records from the API as a list.
+                      # @param [String] filter 
+                    # @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(filter: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'filter' => filter,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        UserPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields UserInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -177,7 +358,7 @@ module Twilio
                     # @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 UserInstance
-                    def page(filter: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(filter: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'filter' => filter,
                             'PageToken' => page_token,
@@ -224,6 +405,7 @@ module Twilio
                     # @return [UserContext] UserContext
                     def initialize(version, organization_sid, id)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { organization_sid: organization_sid, id: id,  }
@@ -240,9 +422,29 @@ module Twilio
                         
                         
                         headers['Accept'] = '*/*'
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the UserInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        headers['Accept'] = '*/*'
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          user_instance = UserInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          UserInstanceMetadata.new(@version, user_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the UserInstance
                     # @return [UserInstance] Fetched UserInstance
@@ -263,6 +465,86 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the UserInstanceMetadata
+                    # @return [UserInstance] Fetched UserInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        headers['Accept'] = 'application/scim+json'
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        user_instance = UserInstance.new(
+                            @version,
+                            response.body,
+                            organization_sid: @solution[:organization_sid],
+                            id: @solution[:id],
+                        )
+                        UserInstanceMetadata.new(
+                            @version,
+                            user_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Patch the UserInstance
+                    # @param [String] if_match 
+                    # @param [ScimPatchRequest] scim_patch_request 
+                    # @return [UserInstance] Patched UserInstance
+                    def patch(
+                        if_match: :unset,scim_patch_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
+                        
+                        headers['Content-Type'] = 'application/scim+json'
+                        
+                        headers['Accept'] = 'application/scim+json'
+                        
+                        payload = @version.patch('PATCH', @uri, headers: headers, data: scim_patch_request.to_json)
+                        UserInstance.new(
+                            @version,
+                            payload,
+                            organization_sid: @solution[:organization_sid],
+                            id: @solution[:id],
+                        )
+                    end
+
+                    ##
+                    # Patch the UserInstanceMetadata
+                    # @param [String] if_match 
+                    # @param [ScimPatchRequest] scim_patch_request 
+                    # @return [UserInstance] Patchd UserInstance
+                    def patch_with_metadata(
+                      if_match: :unset,scim_patch_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
+                        
+                        headers['Content-Type'] = 'application/scim+json'
+                        
+                        headers['Accept'] = 'application/scim+json'
+                        
+                        response = @version.patch_with_metadata('PATCH', @uri, headers: headers, data: scim_patch_request.to_json)
+                        user_instance = UserInstance.new(
+                            @version,
+                            response.body,
+                            organization_sid: @solution[:organization_sid],
+                            id: @solution[:id],
+                        )
+                        UserInstanceMetadata.new(
+                            @version,
+                            user_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the UserInstance
                     # @param [String] if_match 
@@ -287,6 +569,36 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the UserInstanceMetadata
+                    # @param [String] if_match 
+                    # @param [ScimUser] scim_user 
+                    # @return [UserInstance] Updated UserInstance
+                    def update_with_metadata(
+                      if_match: :unset,scim_user: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
+                        
+                        headers['Content-Type'] = 'application/scim+json'
+                        
+                        headers['Accept'] = 'application/scim+json'
+                        
+                        response = @version.update_with_metadata('PUT', @uri, headers: headers, data: scim_user.to_json)
+                        user_instance = UserInstance.new(
+                            @version,
+                            response.body,
+                            organization_sid: @solution[:organization_sid],
+                            id: @solution[:id],
+                        )
+                        UserInstanceMetadata.new(
+                            @version,
+                            user_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -303,6 +615,53 @@ module Twilio
                     end
                 end
 
+                class UserInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new UserInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}UserInstance] user_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 [UserInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, user_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @user_instance = user_instance
+                    end
+
+                    def user
+                        @user_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.UserInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class UserListResponse < InstanceListResource
+                    # @param [Array<UserInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @user_instance = payload.body[key].map do |data|
+                        UserInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def user_instance
+                          @instance
+                      end
+                  end
+
                 class UserPage < Page
                     ##
                     # Initialize the UserPage
@@ -312,6 +671,7 @@ module Twilio
                     # @return [UserPage] UserPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -331,6 +691,66 @@ module Twilio
                         '<Twilio.PreviewIam.Versionless.UserPage>'
                     end
                 end
+
+                class UserPageMetadata < PageMetadata
+                    attr_reader :user_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @user_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @user_page << UserListResponse.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
+                        @user_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::PreviewIam::VersionlessPageMetadata>';
+                    end
+                end
+                class UserListResponse < InstanceListResource
+
+                    # @param [Array<UserInstance>] 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
+                      @user = data_list.map do |data|
+                        UserInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def user
+                        @user
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class UserInstance < InstanceResource
                     ##
                     # Initialize the UserInstance
@@ -344,6 +764,7 @@ module Twilio
                     def initialize(version, payload , organization_sid: nil, id: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'id' => payload['id'],
@@ -492,6 +913,20 @@ module Twilio
                         context.fetch
                     end
 
+                    ##
+                    # Patch the UserInstance
+                    # @param [String] if_match 
+                    # @param [ScimPatchRequest] scim_patch_request 
+                    # @return [UserInstance] Patched UserInstance
+                    def patch(
+                        if_match: :unset,scim_patch_request: nil
+                    )
+
+                        context.patch(
+                            if_match: if_match, 
+                        )
+                    end
+
                     ##
                     # Update the UserInstance
                     # @param [String] if_match