Method: Appwrite::Databases#update_enum_attribute

Defined in:

lib/appwrite/services/databases.rb

#update_enum_attribute(database_id:, collection_id:, key:, elements:, required:, default:) ⇒ AttributeEnum

Update an enum attribute. Changing the ‘default` value will not update already existing documents.

Parameters:

• database_id (String) —

  Database ID.

• collection_id (String) —

  Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

• key (String) —

  Attribute Key.

• elements (Array) —

  Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.

• [] —

  required Is attribute required?

• default (String) —

  Default value for attribute when not provided. Cannot be set when attribute is required.

Returns:

• (AttributeEnum)

# File 'lib/appwrite/services/databases.rb', line 814

def update_enum_attribute(database_id:, collection_id:, key:, elements:, required:, default:)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if elements.nil?
      raise Appwrite::Exception.new('Missing required parameter: "elements"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        elements: elements,
        required: required,
        default: default,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeEnum
    )
end