@appwrite.io/console 5.0.0 → 7.0.0-rc.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -0
- package/README.md +2 -2
- package/dist/cjs/sdk.js +13663 -10879
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +13661 -10880
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +13268 -10484
- package/docs/examples/databases/create-index.md +2 -2
- package/docs/examples/documentsdb/create-collection.md +22 -0
- package/docs/examples/documentsdb/create-document.md +25 -0
- package/docs/examples/documentsdb/create-documents.md +17 -0
- package/docs/examples/documentsdb/create-index.md +21 -0
- package/docs/examples/documentsdb/create-transaction.md +15 -0
- package/docs/examples/documentsdb/create.md +17 -0
- package/docs/examples/documentsdb/decrement-document-attribute.md +21 -0
- package/docs/examples/documentsdb/delete-collection.md +16 -0
- package/docs/examples/documentsdb/delete-document.md +18 -0
- package/docs/examples/documentsdb/delete-documents.md +18 -0
- package/docs/examples/documentsdb/delete-index.md +17 -0
- package/docs/examples/documentsdb/delete-transaction.md +15 -0
- package/docs/examples/documentsdb/delete.md +15 -0
- package/docs/examples/documentsdb/get-collection-usage.md +17 -0
- package/docs/examples/documentsdb/get-collection.md +16 -0
- package/docs/examples/documentsdb/get-document.md +19 -0
- package/docs/examples/documentsdb/get-index.md +17 -0
- package/docs/examples/documentsdb/get-transaction.md +15 -0
- package/docs/examples/documentsdb/get-usage.md +16 -0
- package/docs/examples/documentsdb/get.md +15 -0
- package/docs/examples/documentsdb/increment-document-attribute.md +21 -0
- package/docs/examples/documentsdb/list-collection-logs.md +17 -0
- package/docs/examples/documentsdb/list-collections.md +18 -0
- package/docs/examples/documentsdb/list-document-logs.md +18 -0
- package/docs/examples/documentsdb/list-documents.md +20 -0
- package/docs/examples/documentsdb/list-indexes.md +18 -0
- package/docs/examples/documentsdb/list-transactions.md +15 -0
- package/docs/examples/documentsdb/list-usage.md +15 -0
- package/docs/examples/documentsdb/list.md +17 -0
- package/docs/examples/documentsdb/update-collection.md +20 -0
- package/docs/examples/documentsdb/update-document.md +20 -0
- package/docs/examples/documentsdb/update-documents.md +19 -0
- package/docs/examples/documentsdb/update-transaction.md +17 -0
- package/docs/examples/documentsdb/update.md +17 -0
- package/docs/examples/documentsdb/upsert-document.md +20 -0
- package/docs/examples/documentsdb/upsert-documents.md +18 -0
- package/docs/examples/domains/update-purchase.md +16 -0
- package/docs/examples/domains/update-transfer-in.md +16 -0
- package/docs/examples/tablesdb/create-index.md +2 -2
- package/docs/examples/vectorsdb/create-collection.md +21 -0
- package/docs/examples/vectorsdb/create-document.md +29 -0
- package/docs/examples/vectorsdb/create-documents.md +17 -0
- package/docs/examples/vectorsdb/create-index.md +21 -0
- package/docs/examples/vectorsdb/create-operations.md +26 -0
- package/docs/examples/vectorsdb/create-text-embeddings.md +16 -0
- package/docs/examples/vectorsdb/create-transaction.md +15 -0
- package/docs/examples/vectorsdb/create.md +17 -0
- package/docs/examples/vectorsdb/delete-collection.md +16 -0
- package/docs/examples/vectorsdb/delete-document.md +18 -0
- package/docs/examples/vectorsdb/delete-documents.md +18 -0
- package/docs/examples/vectorsdb/delete-index.md +17 -0
- package/docs/examples/vectorsdb/delete-transaction.md +15 -0
- package/docs/examples/vectorsdb/delete.md +15 -0
- package/docs/examples/vectorsdb/get-collection-usage.md +17 -0
- package/docs/examples/vectorsdb/get-collection.md +16 -0
- package/docs/examples/vectorsdb/get-document.md +19 -0
- package/docs/examples/vectorsdb/get-index.md +17 -0
- package/docs/examples/vectorsdb/get-transaction.md +15 -0
- package/docs/examples/vectorsdb/get-usage.md +16 -0
- package/docs/examples/vectorsdb/get.md +15 -0
- package/docs/examples/vectorsdb/list-collection-logs.md +17 -0
- package/docs/examples/vectorsdb/list-collections.md +18 -0
- package/docs/examples/vectorsdb/list-documents.md +20 -0
- package/docs/examples/vectorsdb/list-indexes.md +18 -0
- package/docs/examples/vectorsdb/list-transactions.md +15 -0
- package/docs/examples/vectorsdb/list-usage.md +15 -0
- package/docs/examples/vectorsdb/list.md +17 -0
- package/docs/examples/vectorsdb/update-collection.md +21 -0
- package/docs/examples/vectorsdb/update-document.md +20 -0
- package/docs/examples/vectorsdb/update-documents.md +19 -0
- package/docs/examples/vectorsdb/update-transaction.md +17 -0
- package/docs/examples/vectorsdb/update.md +17 -0
- package/docs/examples/vectorsdb/upsert-document.md +20 -0
- package/docs/examples/vectorsdb/upsert-documents.md +18 -0
- package/docs/examples/webhooks/create.md +22 -0
- package/docs/examples/webhooks/delete.md +15 -0
- package/docs/examples/webhooks/get.md +15 -0
- package/docs/examples/webhooks/list.md +16 -0
- package/docs/examples/webhooks/update-signature.md +15 -0
- package/docs/examples/webhooks/update.md +22 -0
- package/package.json +1 -1
- package/src/client.ts +1 -1
- package/src/enums/appwrite-migration-resource.ts +2 -0
- package/src/enums/backup-services.ts +3 -0
- package/src/enums/build-runtime.ts +89 -0
- package/src/enums/database-type.ts +2 -0
- package/src/enums/databases-index-type.ts +6 -0
- package/src/enums/documents-db-index-type.ts +6 -0
- package/src/enums/domain-purchase-status.ts +6 -0
- package/src/enums/domain-transfer-status-enum.ts +10 -0
- package/src/enums/model.ts +3 -0
- package/src/enums/runtime.ts +89 -0
- package/src/enums/runtimes.ts +89 -0
- package/src/enums/scopes.ts +2 -0
- package/src/enums/{index-type.ts → tables-db-index-type.ts} +1 -1
- package/src/enums/vectors-db-index-type.ts +8 -0
- package/src/index.ts +11 -4
- package/src/models.ts +519 -19
- package/src/services/databases.ts +10 -10
- package/src/services/documents-db.ts +2608 -0
- package/src/services/domains.ts +30 -30
- package/src/services/projects.ts +0 -473
- package/src/services/tables-db.ts +10 -10
- package/src/services/vectors-db.ts +2406 -0
- package/src/services/webhooks.ts +451 -0
- package/types/enums/appwrite-migration-resource.d.ts +2 -0
- package/types/enums/backup-services.d.ts +3 -0
- package/types/enums/build-runtime.d.ts +90 -1
- package/types/enums/database-type.d.ts +3 -1
- package/types/enums/databases-index-type.d.ts +6 -0
- package/types/enums/documents-db-index-type.d.ts +6 -0
- package/types/enums/domain-purchase-status.d.ts +6 -0
- package/types/enums/domain-transfer-status-enum.d.ts +10 -0
- package/types/enums/model.d.ts +3 -0
- package/types/enums/runtime.d.ts +90 -1
- package/types/enums/runtimes.d.ts +90 -1
- package/types/enums/scopes.d.ts +2 -0
- package/types/enums/{index-type.d.ts → tables-db-index-type.d.ts} +1 -1
- package/types/enums/vectors-db-index-type.d.ts +8 -0
- package/types/index.d.ts +11 -4
- package/types/models.d.ts +509 -19
- package/types/services/databases.d.ts +5 -5
- package/types/services/documents-db.d.ts +977 -0
- package/types/services/domains.d.ts +22 -22
- package/types/services/projects.d.ts +0 -171
- package/types/services/tables-db.d.ts +5 -5
- package/types/services/vectors-db.d.ts +854 -0
- package/types/services/webhooks.d.ts +165 -0
- package/.github/workflows/autoclose.yml +0 -11
|
@@ -89,7 +89,7 @@ export declare class Domains {
|
|
|
89
89
|
* @param {string} params.companyName - Company or organization name for the registrant.
|
|
90
90
|
* @param {number} params.periodYears - Registration term in years (1-10).
|
|
91
91
|
* @throws {AppwriteException}
|
|
92
|
-
* @returns {Promise<Models.
|
|
92
|
+
* @returns {Promise<Models.DomainPurchase>}
|
|
93
93
|
*/
|
|
94
94
|
createPurchase(params: {
|
|
95
95
|
domain: string;
|
|
@@ -103,7 +103,7 @@ export declare class Domains {
|
|
|
103
103
|
addressLine3?: string;
|
|
104
104
|
companyName?: string;
|
|
105
105
|
periodYears?: number;
|
|
106
|
-
}): Promise<Models.
|
|
106
|
+
}): Promise<Models.DomainPurchase>;
|
|
107
107
|
/**
|
|
108
108
|
* Create a domain purchase with registrant information.
|
|
109
109
|
*
|
|
@@ -119,32 +119,32 @@ export declare class Domains {
|
|
|
119
119
|
* @param {string} companyName - Company or organization name for the registrant.
|
|
120
120
|
* @param {number} periodYears - Registration term in years (1-10).
|
|
121
121
|
* @throws {AppwriteException}
|
|
122
|
-
* @returns {Promise<Models.
|
|
122
|
+
* @returns {Promise<Models.DomainPurchase>}
|
|
123
123
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
124
124
|
*/
|
|
125
|
-
createPurchase(domain: string, organizationId: string, firstName: string, lastName: string, email: string, phone: string, billingAddressId: string, paymentMethodId: string, addressLine3?: string, companyName?: string, periodYears?: number): Promise<Models.
|
|
125
|
+
createPurchase(domain: string, organizationId: string, firstName: string, lastName: string, email: string, phone: string, billingAddressId: string, paymentMethodId: string, addressLine3?: string, companyName?: string, periodYears?: number): Promise<Models.DomainPurchase>;
|
|
126
126
|
/**
|
|
127
|
-
* Confirm a domain purchase after payment authentication.
|
|
127
|
+
* Confirm and complete a domain purchase after payment authentication.
|
|
128
128
|
*
|
|
129
129
|
* @param {string} params.domainId - Domain ID to confirm purchase for.
|
|
130
130
|
* @param {string} params.organizationId - Team ID that owns the domain.
|
|
131
131
|
* @throws {AppwriteException}
|
|
132
|
-
* @returns {Promise<Models.
|
|
132
|
+
* @returns {Promise<Models.DomainPurchase>}
|
|
133
133
|
*/
|
|
134
|
-
|
|
134
|
+
updatePurchase(params: {
|
|
135
135
|
domainId: string;
|
|
136
136
|
organizationId: string;
|
|
137
|
-
}): Promise<Models.
|
|
137
|
+
}): Promise<Models.DomainPurchase>;
|
|
138
138
|
/**
|
|
139
|
-
* Confirm a domain purchase after payment authentication.
|
|
139
|
+
* Confirm and complete a domain purchase after payment authentication.
|
|
140
140
|
*
|
|
141
141
|
* @param {string} domainId - Domain ID to confirm purchase for.
|
|
142
142
|
* @param {string} organizationId - Team ID that owns the domain.
|
|
143
143
|
* @throws {AppwriteException}
|
|
144
|
-
* @returns {Promise<Models.
|
|
144
|
+
* @returns {Promise<Models.DomainPurchase>}
|
|
145
145
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
146
146
|
*/
|
|
147
|
-
|
|
147
|
+
updatePurchase(domainId: string, organizationId: string): Promise<Models.DomainPurchase>;
|
|
148
148
|
/**
|
|
149
149
|
* List domain suggestions.
|
|
150
150
|
*
|
|
@@ -187,14 +187,14 @@ export declare class Domains {
|
|
|
187
187
|
* @param {string} params.authCode - Authorization code for the domain transfer.
|
|
188
188
|
* @param {string} params.paymentMethodId - Payment method ID to authorize and capture the transfer.
|
|
189
189
|
* @throws {AppwriteException}
|
|
190
|
-
* @returns {Promise<Models.
|
|
190
|
+
* @returns {Promise<Models.DomainPurchase>}
|
|
191
191
|
*/
|
|
192
192
|
createTransferIn(params: {
|
|
193
193
|
domain: string;
|
|
194
194
|
organizationId: string;
|
|
195
195
|
authCode: string;
|
|
196
196
|
paymentMethodId: string;
|
|
197
|
-
}): Promise<Models.
|
|
197
|
+
}): Promise<Models.DomainPurchase>;
|
|
198
198
|
/**
|
|
199
199
|
* Create a domain transfer in with authorization code and registrant information.
|
|
200
200
|
*
|
|
@@ -203,32 +203,32 @@ export declare class Domains {
|
|
|
203
203
|
* @param {string} authCode - Authorization code for the domain transfer.
|
|
204
204
|
* @param {string} paymentMethodId - Payment method ID to authorize and capture the transfer.
|
|
205
205
|
* @throws {AppwriteException}
|
|
206
|
-
* @returns {Promise<Models.
|
|
206
|
+
* @returns {Promise<Models.DomainPurchase>}
|
|
207
207
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
208
208
|
*/
|
|
209
|
-
createTransferIn(domain: string, organizationId: string, authCode: string, paymentMethodId: string): Promise<Models.
|
|
209
|
+
createTransferIn(domain: string, organizationId: string, authCode: string, paymentMethodId: string): Promise<Models.DomainPurchase>;
|
|
210
210
|
/**
|
|
211
|
-
* Confirm a domain transfer in after payment authentication.
|
|
211
|
+
* Confirm and complete a domain transfer in after payment authentication.
|
|
212
212
|
*
|
|
213
213
|
* @param {string} params.domainId - Domain ID to confirm transfer for.
|
|
214
214
|
* @param {string} params.organizationId - Team ID that owns the domain.
|
|
215
215
|
* @throws {AppwriteException}
|
|
216
|
-
* @returns {Promise<Models.
|
|
216
|
+
* @returns {Promise<Models.DomainPurchase>}
|
|
217
217
|
*/
|
|
218
|
-
|
|
218
|
+
updateTransferIn(params: {
|
|
219
219
|
domainId: string;
|
|
220
220
|
organizationId: string;
|
|
221
|
-
}): Promise<Models.
|
|
221
|
+
}): Promise<Models.DomainPurchase>;
|
|
222
222
|
/**
|
|
223
|
-
* Confirm a domain transfer in after payment authentication.
|
|
223
|
+
* Confirm and complete a domain transfer in after payment authentication.
|
|
224
224
|
*
|
|
225
225
|
* @param {string} domainId - Domain ID to confirm transfer for.
|
|
226
226
|
* @param {string} organizationId - Team ID that owns the domain.
|
|
227
227
|
* @throws {AppwriteException}
|
|
228
|
-
* @returns {Promise<Models.
|
|
228
|
+
* @returns {Promise<Models.DomainPurchase>}
|
|
229
229
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
230
230
|
*/
|
|
231
|
-
|
|
231
|
+
updateTransferIn(domainId: string, organizationId: string): Promise<Models.DomainPurchase>;
|
|
232
232
|
/**
|
|
233
233
|
* Create a domain transfer out and return the authorization code.
|
|
234
234
|
*
|
|
@@ -1623,175 +1623,4 @@ export declare class Projects {
|
|
|
1623
1623
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1624
1624
|
*/
|
|
1625
1625
|
deleteSMSTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate>;
|
|
1626
|
-
/**
|
|
1627
|
-
* Get a list of all webhooks belonging to the project. You can use the query params to filter your results.
|
|
1628
|
-
*
|
|
1629
|
-
* @param {string} params.projectId - Project unique ID.
|
|
1630
|
-
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1631
|
-
* @throws {AppwriteException}
|
|
1632
|
-
* @returns {Promise<Models.WebhookList>}
|
|
1633
|
-
*/
|
|
1634
|
-
listWebhooks(params: {
|
|
1635
|
-
projectId: string;
|
|
1636
|
-
total?: boolean;
|
|
1637
|
-
}): Promise<Models.WebhookList>;
|
|
1638
|
-
/**
|
|
1639
|
-
* Get a list of all webhooks belonging to the project. You can use the query params to filter your results.
|
|
1640
|
-
*
|
|
1641
|
-
* @param {string} projectId - Project unique ID.
|
|
1642
|
-
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1643
|
-
* @throws {AppwriteException}
|
|
1644
|
-
* @returns {Promise<Models.WebhookList>}
|
|
1645
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1646
|
-
*/
|
|
1647
|
-
listWebhooks(projectId: string, total?: boolean): Promise<Models.WebhookList>;
|
|
1648
|
-
/**
|
|
1649
|
-
* Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.
|
|
1650
|
-
*
|
|
1651
|
-
* @param {string} params.projectId - Project unique ID.
|
|
1652
|
-
* @param {string} params.name - Webhook name. Max length: 128 chars.
|
|
1653
|
-
* @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
|
|
1654
|
-
* @param {string} params.url - Webhook URL.
|
|
1655
|
-
* @param {boolean} params.security - Certificate verification, false for disabled or true for enabled.
|
|
1656
|
-
* @param {boolean} params.enabled - Enable or disable a webhook.
|
|
1657
|
-
* @param {string} params.httpUser - Webhook HTTP user. Max length: 256 chars.
|
|
1658
|
-
* @param {string} params.httpPass - Webhook HTTP password. Max length: 256 chars.
|
|
1659
|
-
* @throws {AppwriteException}
|
|
1660
|
-
* @returns {Promise<Models.Webhook>}
|
|
1661
|
-
*/
|
|
1662
|
-
createWebhook(params: {
|
|
1663
|
-
projectId: string;
|
|
1664
|
-
name: string;
|
|
1665
|
-
events: string[];
|
|
1666
|
-
url: string;
|
|
1667
|
-
security: boolean;
|
|
1668
|
-
enabled?: boolean;
|
|
1669
|
-
httpUser?: string;
|
|
1670
|
-
httpPass?: string;
|
|
1671
|
-
}): Promise<Models.Webhook>;
|
|
1672
|
-
/**
|
|
1673
|
-
* Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.
|
|
1674
|
-
*
|
|
1675
|
-
* @param {string} projectId - Project unique ID.
|
|
1676
|
-
* @param {string} name - Webhook name. Max length: 128 chars.
|
|
1677
|
-
* @param {string[]} events - Events list. Maximum of 100 events are allowed.
|
|
1678
|
-
* @param {string} url - Webhook URL.
|
|
1679
|
-
* @param {boolean} security - Certificate verification, false for disabled or true for enabled.
|
|
1680
|
-
* @param {boolean} enabled - Enable or disable a webhook.
|
|
1681
|
-
* @param {string} httpUser - Webhook HTTP user. Max length: 256 chars.
|
|
1682
|
-
* @param {string} httpPass - Webhook HTTP password. Max length: 256 chars.
|
|
1683
|
-
* @throws {AppwriteException}
|
|
1684
|
-
* @returns {Promise<Models.Webhook>}
|
|
1685
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1686
|
-
*/
|
|
1687
|
-
createWebhook(projectId: string, name: string, events: string[], url: string, security: boolean, enabled?: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
|
|
1688
|
-
/**
|
|
1689
|
-
* Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project.
|
|
1690
|
-
*
|
|
1691
|
-
* @param {string} params.projectId - Project unique ID.
|
|
1692
|
-
* @param {string} params.webhookId - Webhook unique ID.
|
|
1693
|
-
* @throws {AppwriteException}
|
|
1694
|
-
* @returns {Promise<Models.Webhook>}
|
|
1695
|
-
*/
|
|
1696
|
-
getWebhook(params: {
|
|
1697
|
-
projectId: string;
|
|
1698
|
-
webhookId: string;
|
|
1699
|
-
}): Promise<Models.Webhook>;
|
|
1700
|
-
/**
|
|
1701
|
-
* Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project.
|
|
1702
|
-
*
|
|
1703
|
-
* @param {string} projectId - Project unique ID.
|
|
1704
|
-
* @param {string} webhookId - Webhook unique ID.
|
|
1705
|
-
* @throws {AppwriteException}
|
|
1706
|
-
* @returns {Promise<Models.Webhook>}
|
|
1707
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1708
|
-
*/
|
|
1709
|
-
getWebhook(projectId: string, webhookId: string): Promise<Models.Webhook>;
|
|
1710
|
-
/**
|
|
1711
|
-
* Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.
|
|
1712
|
-
*
|
|
1713
|
-
* @param {string} params.projectId - Project unique ID.
|
|
1714
|
-
* @param {string} params.webhookId - Webhook unique ID.
|
|
1715
|
-
* @param {string} params.name - Webhook name. Max length: 128 chars.
|
|
1716
|
-
* @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
|
|
1717
|
-
* @param {string} params.url - Webhook URL.
|
|
1718
|
-
* @param {boolean} params.security - Certificate verification, false for disabled or true for enabled.
|
|
1719
|
-
* @param {boolean} params.enabled - Enable or disable a webhook.
|
|
1720
|
-
* @param {string} params.httpUser - Webhook HTTP user. Max length: 256 chars.
|
|
1721
|
-
* @param {string} params.httpPass - Webhook HTTP password. Max length: 256 chars.
|
|
1722
|
-
* @throws {AppwriteException}
|
|
1723
|
-
* @returns {Promise<Models.Webhook>}
|
|
1724
|
-
*/
|
|
1725
|
-
updateWebhook(params: {
|
|
1726
|
-
projectId: string;
|
|
1727
|
-
webhookId: string;
|
|
1728
|
-
name: string;
|
|
1729
|
-
events: string[];
|
|
1730
|
-
url: string;
|
|
1731
|
-
security: boolean;
|
|
1732
|
-
enabled?: boolean;
|
|
1733
|
-
httpUser?: string;
|
|
1734
|
-
httpPass?: string;
|
|
1735
|
-
}): Promise<Models.Webhook>;
|
|
1736
|
-
/**
|
|
1737
|
-
* Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.
|
|
1738
|
-
*
|
|
1739
|
-
* @param {string} projectId - Project unique ID.
|
|
1740
|
-
* @param {string} webhookId - Webhook unique ID.
|
|
1741
|
-
* @param {string} name - Webhook name. Max length: 128 chars.
|
|
1742
|
-
* @param {string[]} events - Events list. Maximum of 100 events are allowed.
|
|
1743
|
-
* @param {string} url - Webhook URL.
|
|
1744
|
-
* @param {boolean} security - Certificate verification, false for disabled or true for enabled.
|
|
1745
|
-
* @param {boolean} enabled - Enable or disable a webhook.
|
|
1746
|
-
* @param {string} httpUser - Webhook HTTP user. Max length: 256 chars.
|
|
1747
|
-
* @param {string} httpPass - Webhook HTTP password. Max length: 256 chars.
|
|
1748
|
-
* @throws {AppwriteException}
|
|
1749
|
-
* @returns {Promise<Models.Webhook>}
|
|
1750
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1751
|
-
*/
|
|
1752
|
-
updateWebhook(projectId: string, webhookId: string, name: string, events: string[], url: string, security: boolean, enabled?: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
|
|
1753
|
-
/**
|
|
1754
|
-
* Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events.
|
|
1755
|
-
*
|
|
1756
|
-
* @param {string} params.projectId - Project unique ID.
|
|
1757
|
-
* @param {string} params.webhookId - Webhook unique ID.
|
|
1758
|
-
* @throws {AppwriteException}
|
|
1759
|
-
* @returns {Promise<{}>}
|
|
1760
|
-
*/
|
|
1761
|
-
deleteWebhook(params: {
|
|
1762
|
-
projectId: string;
|
|
1763
|
-
webhookId: string;
|
|
1764
|
-
}): Promise<{}>;
|
|
1765
|
-
/**
|
|
1766
|
-
* Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events.
|
|
1767
|
-
*
|
|
1768
|
-
* @param {string} projectId - Project unique ID.
|
|
1769
|
-
* @param {string} webhookId - Webhook unique ID.
|
|
1770
|
-
* @throws {AppwriteException}
|
|
1771
|
-
* @returns {Promise<{}>}
|
|
1772
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1773
|
-
*/
|
|
1774
|
-
deleteWebhook(projectId: string, webhookId: string): Promise<{}>;
|
|
1775
|
-
/**
|
|
1776
|
-
* Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.
|
|
1777
|
-
*
|
|
1778
|
-
* @param {string} params.projectId - Project unique ID.
|
|
1779
|
-
* @param {string} params.webhookId - Webhook unique ID.
|
|
1780
|
-
* @throws {AppwriteException}
|
|
1781
|
-
* @returns {Promise<Models.Webhook>}
|
|
1782
|
-
*/
|
|
1783
|
-
updateWebhookSignature(params: {
|
|
1784
|
-
projectId: string;
|
|
1785
|
-
webhookId: string;
|
|
1786
|
-
}): Promise<Models.Webhook>;
|
|
1787
|
-
/**
|
|
1788
|
-
* Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.
|
|
1789
|
-
*
|
|
1790
|
-
* @param {string} projectId - Project unique ID.
|
|
1791
|
-
* @param {string} webhookId - Webhook unique ID.
|
|
1792
|
-
* @throws {AppwriteException}
|
|
1793
|
-
* @returns {Promise<Models.Webhook>}
|
|
1794
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1795
|
-
*/
|
|
1796
|
-
updateWebhookSignature(projectId: string, webhookId: string): Promise<Models.Webhook>;
|
|
1797
1626
|
}
|
|
@@ -3,7 +3,7 @@ import type { Models } from '../models';
|
|
|
3
3
|
import { UsageRange } from '../enums/usage-range';
|
|
4
4
|
import { RelationshipType } from '../enums/relationship-type';
|
|
5
5
|
import { RelationMutate } from '../enums/relation-mutate';
|
|
6
|
-
import {
|
|
6
|
+
import { TablesDBIndexType } from '../enums/tables-db-index-type';
|
|
7
7
|
import { OrderBy } from '../enums/order-by';
|
|
8
8
|
export declare class TablesDB {
|
|
9
9
|
client: Client;
|
|
@@ -1781,7 +1781,7 @@ export declare class TablesDB {
|
|
|
1781
1781
|
* @param {string} params.databaseId - Database ID.
|
|
1782
1782
|
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1783
1783
|
* @param {string} params.key - Index Key.
|
|
1784
|
-
* @param {
|
|
1784
|
+
* @param {TablesDBIndexType} params.type - Index type.
|
|
1785
1785
|
* @param {string[]} params.columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
|
|
1786
1786
|
* @param {OrderBy[]} params.orders - Array of index orders. Maximum of 100 orders are allowed.
|
|
1787
1787
|
* @param {number[]} params.lengths - Length of index. Maximum of 100
|
|
@@ -1792,7 +1792,7 @@ export declare class TablesDB {
|
|
|
1792
1792
|
databaseId: string;
|
|
1793
1793
|
tableId: string;
|
|
1794
1794
|
key: string;
|
|
1795
|
-
type:
|
|
1795
|
+
type: TablesDBIndexType;
|
|
1796
1796
|
columns: string[];
|
|
1797
1797
|
orders?: OrderBy[];
|
|
1798
1798
|
lengths?: number[];
|
|
@@ -1804,7 +1804,7 @@ export declare class TablesDB {
|
|
|
1804
1804
|
* @param {string} databaseId - Database ID.
|
|
1805
1805
|
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1806
1806
|
* @param {string} key - Index Key.
|
|
1807
|
-
* @param {
|
|
1807
|
+
* @param {TablesDBIndexType} type - Index type.
|
|
1808
1808
|
* @param {string[]} columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
|
|
1809
1809
|
* @param {OrderBy[]} orders - Array of index orders. Maximum of 100 orders are allowed.
|
|
1810
1810
|
* @param {number[]} lengths - Length of index. Maximum of 100
|
|
@@ -1812,7 +1812,7 @@ export declare class TablesDB {
|
|
|
1812
1812
|
* @returns {Promise<Models.ColumnIndex>}
|
|
1813
1813
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1814
1814
|
*/
|
|
1815
|
-
createIndex(databaseId: string, tableId: string, key: string, type:
|
|
1815
|
+
createIndex(databaseId: string, tableId: string, key: string, type: TablesDBIndexType, columns: string[], orders?: OrderBy[], lengths?: number[]): Promise<Models.ColumnIndex>;
|
|
1816
1816
|
/**
|
|
1817
1817
|
* Get index by ID.
|
|
1818
1818
|
*
|