@appwrite.io/console 0.0.1 → 0.0.2-preview-0.0

package/types/services/projects.d.ts

@@ -0,0 +1,400 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Projects extends Service {
+    constructor(client: Client);
+    /**
+     * List Projects
+     *
+     *
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    list(queries?: string[], search?: string): Promise<Models.ProjectList>;
+    /**
+     * Create Project
+     *
+     *
+     * @param {string} projectId
+     * @param {string} name
+     * @param {string} teamId
+     * @param {string} region
+     * @param {string} description
+     * @param {string} logo
+     * @param {string} url
+     * @param {string} legalName
+     * @param {string} legalCountry
+     * @param {string} legalState
+     * @param {string} legalCity
+     * @param {string} legalAddress
+     * @param {string} legalTaxId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    create(projectId: string, name: string, teamId: string, region?: string, description?: string, logo?: string, url?: string, legalName?: string, legalCountry?: string, legalState?: string, legalCity?: string, legalAddress?: string, legalTaxId?: string): Promise<Models.Project>;
+    /**
+     * Get Project
+     *
+     *
+     * @param {string} projectId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    get(projectId: string): Promise<Models.Project>;
+    /**
+     * Update Project
+     *
+     *
+     * @param {string} projectId
+     * @param {string} name
+     * @param {string} description
+     * @param {string} logo
+     * @param {string} url
+     * @param {string} legalName
+     * @param {string} legalCountry
+     * @param {string} legalState
+     * @param {string} legalCity
+     * @param {string} legalAddress
+     * @param {string} legalTaxId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    update(projectId: string, name: string, description?: string, logo?: string, url?: string, legalName?: string, legalCountry?: string, legalState?: string, legalCity?: string, legalAddress?: string, legalTaxId?: string): Promise<Models.Project>;
+    /**
+     * Delete Project
+     *
+     *
+     * @param {string} projectId
+     * @param {string} password
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    delete(projectId: string, password: string): Promise<{}>;
+    /**
+     * Update Project Authentication Duration
+     *
+     *
+     * @param {string} projectId
+     * @param {number} duration
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateAuthDuration(projectId: string, duration: number): Promise<Models.Project>;
+    /**
+     * Update Project users limit
+     *
+     *
+     * @param {string} projectId
+     * @param {number} limit
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateAuthLimit(projectId: string, limit: number): Promise<Models.Project>;
+    /**
+     * Update Project user sessions limit
+     *
+     *
+     * @param {string} projectId
+     * @param {number} limit
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateAuthSessionsLimit(projectId: string, limit: number): Promise<Models.Project>;
+    /**
+     * Update authentication password disctionary status. Use this endpoint to enable or disable the dicitonary check for user password
+     *
+     *
+     * @param {string} projectId
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateAuthPasswordDictionary(projectId: string, enabled: boolean): Promise<Models.Project>;
+    /**
+     * Update authentication password history. Use this endpoint to set the number of password history to save and 0 to disable password history.
+     *
+     *
+     * @param {string} projectId
+     * @param {number} limit
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateAuthPasswordHistory(projectId: string, limit: number): Promise<Models.Project>;
+    /**
+     * Update Project auth method status. Use this endpoint to enable or disable a given auth method for this project.
+     *
+     *
+     * @param {string} projectId
+     * @param {string} method
+     * @param {boolean} status
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateAuthStatus(projectId: string, method: string, status: boolean): Promise<Models.Project>;
+    /**
+     * List Domains
+     *
+     *
+     * @param {string} projectId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listDomains(projectId: string): Promise<Models.DomainList>;
+    /**
+     * Create Domain
+     *
+     *
+     * @param {string} projectId
+     * @param {string} domain
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createDomain(projectId: string, domain: string): Promise<Models.Domain>;
+    /**
+     * Get Domain
+     *
+     *
+     * @param {string} projectId
+     * @param {string} domainId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getDomain(projectId: string, domainId: string): Promise<Models.Domain>;
+    /**
+     * Delete Domain
+     *
+     *
+     * @param {string} projectId
+     * @param {string} domainId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    deleteDomain(projectId: string, domainId: string): Promise<{}>;
+    /**
+     * Update Domain Verification Status
+     *
+     *
+     * @param {string} projectId
+     * @param {string} domainId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateDomainVerification(projectId: string, domainId: string): Promise<Models.Domain>;
+    /**
+     * List Keys
+     *
+     *
+     * @param {string} projectId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listKeys(projectId: string): Promise<Models.KeyList>;
+    /**
+     * Create Key
+     *
+     *
+     * @param {string} projectId
+     * @param {string} name
+     * @param {string[]} scopes
+     * @param {string} expire
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createKey(projectId: string, name: string, scopes: string[], expire?: string): Promise<Models.Key>;
+    /**
+     * Get Key
+     *
+     *
+     * @param {string} projectId
+     * @param {string} keyId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getKey(projectId: string, keyId: string): Promise<Models.Key>;
+    /**
+     * Update Key
+     *
+     *
+     * @param {string} projectId
+     * @param {string} keyId
+     * @param {string} name
+     * @param {string[]} scopes
+     * @param {string} expire
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateKey(projectId: string, keyId: string, name: string, scopes: string[], expire?: string): Promise<Models.Key>;
+    /**
+     * Delete Key
+     *
+     *
+     * @param {string} projectId
+     * @param {string} keyId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    deleteKey(projectId: string, keyId: string): Promise<{}>;
+    /**
+     * Update Project OAuth2
+     *
+     *
+     * @param {string} projectId
+     * @param {string} provider
+     * @param {string} appId
+     * @param {string} secret
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateOAuth2(projectId: string, provider: string, appId?: string, secret?: string, enabled?: boolean): Promise<Models.Project>;
+    /**
+     * List Platforms
+     *
+     *
+     * @param {string} projectId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listPlatforms(projectId: string): Promise<Models.PlatformList>;
+    /**
+     * Create Platform
+     *
+     *
+     * @param {string} projectId
+     * @param {string} type
+     * @param {string} name
+     * @param {string} key
+     * @param {string} store
+     * @param {string} hostname
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createPlatform(projectId: string, type: string, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
+    /**
+     * Get Platform
+     *
+     *
+     * @param {string} projectId
+     * @param {string} platformId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getPlatform(projectId: string, platformId: string): Promise<Models.Platform>;
+    /**
+     * Update Platform
+     *
+     *
+     * @param {string} projectId
+     * @param {string} platformId
+     * @param {string} name
+     * @param {string} key
+     * @param {string} store
+     * @param {string} hostname
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updatePlatform(projectId: string, platformId: string, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
+    /**
+     * Delete Platform
+     *
+     *
+     * @param {string} projectId
+     * @param {string} platformId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    deletePlatform(projectId: string, platformId: string): Promise<{}>;
+    /**
+     * Update service status
+     *
+     *
+     * @param {string} projectId
+     * @param {string} service
+     * @param {boolean} status
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateServiceStatus(projectId: string, service: string, status: boolean): Promise<Models.Project>;
+    /**
+     * Get usage stats for a project
+     *
+     *
+     * @param {string} projectId
+     * @param {string} range
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getUsage(projectId: string, range?: string): Promise<Models.UsageProject>;
+    /**
+     * List Webhooks
+     *
+     *
+     * @param {string} projectId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listWebhooks(projectId: string): Promise<Models.WebhookList>;
+    /**
+     * Create Webhook
+     *
+     *
+     * @param {string} projectId
+     * @param {string} name
+     * @param {string[]} events
+     * @param {string} url
+     * @param {boolean} security
+     * @param {string} httpUser
+     * @param {string} httpPass
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createWebhook(projectId: string, name: string, events: string[], url: string, security: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
+    /**
+     * Get Webhook
+     *
+     *
+     * @param {string} projectId
+     * @param {string} webhookId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getWebhook(projectId: string, webhookId: string): Promise<Models.Webhook>;
+    /**
+     * Update Webhook
+     *
+     *
+     * @param {string} projectId
+     * @param {string} webhookId
+     * @param {string} name
+     * @param {string[]} events
+     * @param {string} url
+     * @param {boolean} security
+     * @param {string} httpUser
+     * @param {string} httpPass
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateWebhook(projectId: string, webhookId: string, name: string, events: string[], url: string, security: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
+    /**
+     * Delete Webhook
+     *
+     *
+     * @param {string} projectId
+     * @param {string} webhookId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    deleteWebhook(projectId: string, webhookId: string): Promise<{}>;
+    /**
+     * Update Webhook Signature Key
+     *
+     *
+     * @param {string} projectId
+     * @param {string} webhookId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateWebhookSignature(projectId: string, webhookId: string): Promise<Models.Webhook>;
+}

package/types/services/storage.d.ts

@@ -0,0 +1,229 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+import type { UploadProgress } from '../client';
+export declare class Storage extends Service {
+    constructor(client: Client);
+    /**
+     * List buckets
+     *
+     * Get a list of all the storage buckets. You can use the query params to
+     * filter your results.
+     *
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listBuckets(queries?: string[], search?: string): Promise<Models.BucketList>;
+    /**
+     * Create bucket
+     *
+     * Create a new storage bucket.
+     *
+     * @param {string} bucketId
+     * @param {string} name
+     * @param {string[]} permissions
+     * @param {boolean} fileSecurity
+     * @param {boolean} enabled
+     * @param {number} maximumFileSize
+     * @param {string[]} allowedFileExtensions
+     * @param {string} compression
+     * @param {boolean} encryption
+     * @param {boolean} antivirus
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: string, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
+    /**
+     * Get Bucket
+     *
+     * Get a storage bucket by its unique ID. This endpoint response returns a
+     * JSON object with the storage bucket metadata.
+     *
+     * @param {string} bucketId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getBucket(bucketId: string): Promise<Models.Bucket>;
+    /**
+     * Update Bucket
+     *
+     * Update a storage bucket by its unique ID.
+     *
+     * @param {string} bucketId
+     * @param {string} name
+     * @param {string[]} permissions
+     * @param {boolean} fileSecurity
+     * @param {boolean} enabled
+     * @param {number} maximumFileSize
+     * @param {string[]} allowedFileExtensions
+     * @param {string} compression
+     * @param {boolean} encryption
+     * @param {boolean} antivirus
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: string, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
+    /**
+     * Delete Bucket
+     *
+     * Delete a storage bucket by its unique ID.
+     *
+     * @param {string} bucketId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    deleteBucket(bucketId: string): Promise<{}>;
+    /**
+     * List Files
+     *
+     * Get a list of all the user files. You can use the query params to filter
+     * your results.
+     *
+     * @param {string} bucketId
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listFiles(bucketId: string, queries?: string[], search?: string): Promise<Models.FileList>;
+    /**
+     * Create File
+     *
+     * Create a new file. Before using this route, you should create a new bucket
+     * resource using either a [server
+     * integration](/docs/server/storage#storageCreateBucket) API or directly from
+     * your Appwrite console.
+     *
+     * Larger files should be uploaded using multiple requests with the
+     * [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range)
+     * header to send a partial request with a maximum supported chunk of `5MB`.
+     * The `content-range` header values should always be in bytes.
+     *
+     * When the first request is sent, the server will return the **File** object,
+     * and the subsequent part request must include the file's **id** in
+     * `x-appwrite-id` header to allow the server to know that the partial upload
+     * is for the existing file and not for a new one.
+     *
+     * If you're creating a new file using one of the Appwrite SDKs, all the
+     * chunking logic will be managed by the SDK internally.
+     *
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @param {File} file
+     * @param {string[]} permissions
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createFile(bucketId: string, fileId: string, file: File, permissions?: string[], onProgress?: (progress: UploadProgress) => void): Promise<Models.File>;
+    /**
+     * Get File
+     *
+     * Get a file by its unique ID. This endpoint response returns a JSON object
+     * with the file metadata.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getFile(bucketId: string, fileId: string): Promise<Models.File>;
+    /**
+     * Update File
+     *
+     * Update a file by its unique ID. Only users with write permissions have
+     * access to update this resource.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @param {string[]} permissions
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateFile(bucketId: string, fileId: string, permissions?: string[]): Promise<Models.File>;
+    /**
+     * Delete File
+     *
+     * Delete a file by its unique ID. Only users with write permissions have
+     * access to delete this resource.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    deleteFile(bucketId: string, fileId: string): Promise<{}>;
+    /**
+     * Get File for Download
+     *
+     * Get a file content by its unique ID. The endpoint response return with a
+     * 'Content-Disposition: attachment' header that tells the browser to start
+     * downloading the file to user downloads directory.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @throws {AppwriteException}
+     * @returns {URL}
+     */
+    getFileDownload(bucketId: string, fileId: string): URL;
+    /**
+     * Get File Preview
+     *
+     * Get a file preview image. Currently, this method supports preview for image
+     * files (jpg, png, and gif), other supported formats, like pdf, docs, slides,
+     * and spreadsheets, will return the file icon image. You can also pass query
+     * string arguments for cutting and resizing your preview image. Preview is
+     * supported only for image files smaller than 10MB.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @param {number} width
+     * @param {number} height
+     * @param {string} gravity
+     * @param {number} quality
+     * @param {number} borderWidth
+     * @param {string} borderColor
+     * @param {number} borderRadius
+     * @param {number} opacity
+     * @param {number} rotation
+     * @param {string} background
+     * @param {string} output
+     * @throws {AppwriteException}
+     * @returns {URL}
+     */
+    getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: string, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: string): URL;
+    /**
+     * Get File for View
+     *
+     * Get a file content by its unique ID. This endpoint is similar to the
+     * download method but returns with no  'Content-Disposition: attachment'
+     * header.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @throws {AppwriteException}
+     * @returns {URL}
+     */
+    getFileView(bucketId: string, fileId: string): URL;
+    /**
+     * Get usage stats for storage
+     *
+     *
+     * @param {string} range
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getUsage(range?: string): Promise<Models.UsageStorage>;
+    /**
+     * Get usage stats for a storage bucket
+     *
+     *
+     * @param {string} bucketId
+     * @param {string} range
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getBucketUsage(bucketId: string, range?: string): Promise<Models.UsageBuckets>;
+}