@appconda/sdk 1.0.555 → 1.0.557
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/package.json +1 -1
- package/src/modules/emploid/schema.ts +6 -6
- package/src/modules/emploid/types.ts +1 -1
- package/dist/EmploidClient.d.ts +0 -52
- package/dist/EmploidClient.js +0 -78
- package/dist/client.d.ts +0 -149
- package/dist/client.js +0 -408
- package/dist/enums/api-service.d.ts +0 -13
- package/dist/enums/api-service.js +0 -15
- package/dist/enums/api.d.ts +0 -5
- package/dist/enums/api.js +0 -7
- package/dist/enums/auth-method.d.ts +0 -9
- package/dist/enums/auth-method.js +0 -11
- package/dist/enums/browser.d.ts +0 -16
- package/dist/enums/browser.js +0 -18
- package/dist/enums/compression.d.ts +0 -5
- package/dist/enums/compression.js +0 -7
- package/dist/enums/credit-card.d.ts +0 -18
- package/dist/enums/credit-card.js +0 -20
- package/dist/enums/database-usage-range.d.ts +0 -5
- package/dist/enums/database-usage-range.js +0 -7
- package/dist/enums/email-template-locale.d.ts +0 -133
- package/dist/enums/email-template-locale.js +0 -135
- package/dist/enums/email-template-type.d.ts +0 -9
- package/dist/enums/email-template-type.js +0 -11
- package/dist/enums/entities/EntityLimitType.d.ts +0 -4
- package/dist/enums/entities/EntityLimitType.js +0 -6
- package/dist/enums/entities/PropertyAttributeName.d.ts +0 -27
- package/dist/enums/entities/PropertyAttributeName.js +0 -29
- package/dist/enums/entities/PropertyCondition.d.ts +0 -7
- package/dist/enums/entities/PropertyCondition.js +0 -10
- package/dist/enums/entities/PropertyType.d.ts +0 -12
- package/dist/enums/entities/PropertyType.js +0 -18
- package/dist/enums/entities/PropertyValueType.d.ts +0 -6
- package/dist/enums/entities/PropertyValueType.js +0 -8
- package/dist/enums/entities/RowAccess.d.ts +0 -2
- package/dist/enums/entities/RowAccess.js +0 -2
- package/dist/enums/entities/ViewFilterCondition.d.ts +0 -12
- package/dist/enums/entities/ViewFilterCondition.js +0 -14
- package/dist/enums/execution-method.d.ts +0 -8
- package/dist/enums/execution-method.js +0 -10
- package/dist/enums/flag.d.ts +0 -197
- package/dist/enums/flag.js +0 -199
- package/dist/enums/function-usage-range.d.ts +0 -5
- package/dist/enums/function-usage-range.js +0 -7
- package/dist/enums/image-format.d.ts +0 -7
- package/dist/enums/image-format.js +0 -9
- package/dist/enums/image-gravity.d.ts +0 -11
- package/dist/enums/image-gravity.js +0 -13
- package/dist/enums/index-type.d.ts +0 -5
- package/dist/enums/index-type.js +0 -7
- package/dist/enums/messaging-provider-type.d.ts +0 -5
- package/dist/enums/messaging-provider-type.js +0 -7
- package/dist/enums/name.d.ts +0 -14
- package/dist/enums/name.js +0 -16
- package/dist/enums/o-auth-provider copy.d.ts +0 -41
- package/dist/enums/o-auth-provider copy.js +0 -43
- package/dist/enums/password-hash.d.ts +0 -13
- package/dist/enums/password-hash.js +0 -15
- package/dist/enums/platform-type.d.ts +0 -17
- package/dist/enums/platform-type.js +0 -19
- package/dist/enums/project-usage-range.d.ts +0 -4
- package/dist/enums/project-usage-range.js +0 -6
- package/dist/enums/region.d.ts +0 -4
- package/dist/enums/region.js +0 -6
- package/dist/enums/relation-mutate.d.ts +0 -5
- package/dist/enums/relation-mutate.js +0 -7
- package/dist/enums/relationship-type.d.ts +0 -6
- package/dist/enums/relationship-type.js +0 -8
- package/dist/enums/resource-type.d.ts +0 -4
- package/dist/enums/resource-type.js +0 -6
- package/dist/enums/runtime.d.ts +0 -48
- package/dist/enums/runtime.js +0 -50
- package/dist/enums/s-m-t-p-secure.d.ts +0 -3
- package/dist/enums/s-m-t-p-secure.js +0 -5
- package/dist/enums/shared/ApplicationLayout.d.ts +0 -4
- package/dist/enums/shared/ApplicationLayout.js +0 -6
- package/dist/enums/shared/Colors.d.ts +0 -24
- package/dist/enums/shared/Colors.js +0 -26
- package/dist/enums/shared/InputType.d.ts +0 -6
- package/dist/enums/shared/InputType.js +0 -8
- package/dist/enums/shared/Periodicity.d.ts +0 -7
- package/dist/enums/shared/Periodicity.js +0 -9
- package/dist/enums/shared/SvgIcon.d.ts +0 -37
- package/dist/enums/shared/SvgIcon.js +0 -39
- package/dist/enums/shared/Theme.d.ts +0 -4
- package/dist/enums/shared/Theme.js +0 -6
- package/dist/enums/sms-template-locale.d.ts +0 -133
- package/dist/enums/sms-template-locale.js +0 -135
- package/dist/enums/sms-template-type.d.ts +0 -6
- package/dist/enums/sms-template-type.js +0 -8
- package/dist/enums/smtp-encryption.d.ts +0 -5
- package/dist/enums/smtp-encryption.js +0 -7
- package/dist/enums/storage-usage-range.d.ts +0 -5
- package/dist/enums/storage-usage-range.js +0 -7
- package/dist/enums/subscriptions/PricingModel.d.ts +0 -11
- package/dist/enums/subscriptions/PricingModel.js +0 -12
- package/dist/enums/subscriptions/SubscriptionBillingPeriod.d.ts +0 -10
- package/dist/enums/subscriptions/SubscriptionBillingPeriod.js +0 -11
- package/dist/enums/subscriptions/SubscriptionFeatureLimitType.d.ts +0 -10
- package/dist/enums/subscriptions/SubscriptionFeatureLimitType.js +0 -13
- package/dist/enums/subscriptions/SubscriptionPriceType.d.ts +0 -7
- package/dist/enums/subscriptions/SubscriptionPriceType.js +0 -8
- package/dist/enums/tenants/LinkedAccountStatus.d.ts +0 -5
- package/dist/enums/tenants/LinkedAccountStatus.js +0 -7
- package/dist/enums/tenants/TenantUserJoined.d.ts +0 -6
- package/dist/enums/tenants/TenantUserJoined.js +0 -8
- package/dist/enums/tenants/TenantUserStatus.d.ts +0 -6
- package/dist/enums/tenants/TenantUserStatus.js +0 -8
- package/dist/enums/tenants/TenantUserType.d.ts +0 -5
- package/dist/enums/tenants/TenantUserType.js +0 -7
- package/dist/enums/user-usage-range.d.ts +0 -5
- package/dist/enums/user-usage-range.js +0 -7
- package/dist/getAppcondaClient.d.ts +0 -14
- package/dist/getAppcondaClient.js +0 -60
- package/dist/getSDKForService.d.ts +0 -22
- package/dist/getSDKForService.js +0 -72
- package/dist/id.d.ts +0 -20
- package/dist/id.js +0 -45
- package/dist/index.d.ts +0 -7
- package/dist/index.js +0 -6
- package/dist/lib/errors.d.ts +0 -70
- package/dist/lib/errors.js +0 -79
- package/dist/lib/index.d.ts +0 -0
- package/dist/lib/index.js +0 -1
- package/dist/lib/types.d.ts +0 -5
- package/dist/lib/types.js +0 -2
- package/dist/models.d.ts +0 -3272
- package/dist/models.js +0 -2
- package/dist/modules/account/enums/authentication-factor.d.ts +0 -6
- package/dist/modules/account/enums/authentication-factor.js +0 -8
- package/dist/modules/account/enums/authenticator-type.d.ts +0 -3
- package/dist/modules/account/enums/authenticator-type.js +0 -5
- package/dist/modules/account/enums/o-auth-provider.d.ts +0 -41
- package/dist/modules/account/enums/o-auth-provider.js +0 -43
- package/dist/modules/account/index.d.ts +0 -2
- package/dist/modules/account/index.js +0 -3
- package/dist/modules/account/schema.d.ts +0 -7
- package/dist/modules/account/schema.js +0 -8
- package/dist/modules/account/service.d.ts +0 -530
- package/dist/modules/account/service.js +0 -1263
- package/dist/modules/account/types.d.ts +0 -411
- package/dist/modules/account/types.js +0 -2
- package/dist/modules/accounv1/index.d.ts +0 -3
- package/dist/modules/accounv1/index.js +0 -4
- package/dist/modules/accounv1/schema.d.ts +0 -43
- package/dist/modules/accounv1/schema.js +0 -44
- package/dist/modules/accounv1/service.d.ts +0 -14
- package/dist/modules/accounv1/service.js +0 -28
- package/dist/modules/accounv1/types.d.ts +0 -14
- package/dist/modules/accounv1/types.js +0 -2
- package/dist/modules/acl/service.d.ts +0 -26
- package/dist/modules/acl/service.js +0 -27
- package/dist/modules/agent/index.d.ts +0 -3
- package/dist/modules/agent/index.js +0 -4
- package/dist/modules/agent/schema.d.ts +0 -20
- package/dist/modules/agent/schema.js +0 -21
- package/dist/modules/agent/service.d.ts +0 -12
- package/dist/modules/agent/service.js +0 -22
- package/dist/modules/agent/types.d.ts +0 -11
- package/dist/modules/agent/types.js +0 -2
- package/dist/modules/ai/index.d.ts +0 -1
- package/dist/modules/ai/index.js +0 -2
- package/dist/modules/ai/node/index.d.ts +0 -1
- package/dist/modules/ai/node/index.js +0 -2
- package/dist/modules/ai/node/service.d.ts +0 -5
- package/dist/modules/ai/node/service.js +0 -12
- package/dist/modules/bpm/index.d.ts +0 -3
- package/dist/modules/bpm/index.js +0 -4
- package/dist/modules/bpm/schema.d.ts +0 -18
- package/dist/modules/bpm/schema.js +0 -19
- package/dist/modules/bpm/service.d.ts +0 -11
- package/dist/modules/bpm/service.js +0 -20
- package/dist/modules/bpm/types.d.ts +0 -9
- package/dist/modules/bpm/types.js +0 -2
- package/dist/modules/builder/index.d.ts +0 -3
- package/dist/modules/builder/index.js +0 -4
- package/dist/modules/builder/schema.d.ts +0 -80
- package/dist/modules/builder/schema.js +0 -81
- package/dist/modules/builder/service.d.ts +0 -22
- package/dist/modules/builder/service.js +0 -52
- package/dist/modules/builder/types.d.ts +0 -62
- package/dist/modules/builder/types.js +0 -2
- package/dist/modules/datasource/index.d.ts +0 -3
- package/dist/modules/datasource/index.js +0 -4
- package/dist/modules/datasource/schema.d.ts +0 -55
- package/dist/modules/datasource/schema.js +0 -56
- package/dist/modules/datasource/service.d.ts +0 -19
- package/dist/modules/datasource/service.js +0 -43
- package/dist/modules/datasource/types.d.ts +0 -28
- package/dist/modules/datasource/types.js +0 -2
- package/dist/modules/emploid/index.d.ts +0 -3
- package/dist/modules/emploid/index.js +0 -4
- package/dist/modules/emploid/schema.d.ts +0 -1057
- package/dist/modules/emploid/schema.js +0 -1019
- package/dist/modules/emploid/service.d.ts +0 -198
- package/dist/modules/emploid/service.js +0 -575
- package/dist/modules/emploid/types.d.ts +0 -350
- package/dist/modules/emploid/types.js +0 -2
- package/dist/modules/google/index.d.ts +0 -3
- package/dist/modules/google/index.js +0 -4
- package/dist/modules/google/schema.d.ts +0 -13
- package/dist/modules/google/schema.js +0 -14
- package/dist/modules/google/service.d.ts +0 -10
- package/dist/modules/google/service.js +0 -16
- package/dist/modules/google/types.d.ts +0 -12
- package/dist/modules/google/types.js +0 -2
- package/dist/modules/hooks/index.d.ts +0 -2
- package/dist/modules/hooks/index.js +0 -3
- package/dist/modules/hooks/lib/Hooks.d.ts +0 -32
- package/dist/modules/hooks/lib/Hooks.js +0 -64
- package/dist/modules/hooks/lib/jobs/index.d.ts +0 -2
- package/dist/modules/hooks/lib/jobs/index.js +0 -3
- package/dist/modules/hooks/lib/jobs/job1.d.ts +0 -1
- package/dist/modules/hooks/lib/jobs/job1.js +0 -16
- package/dist/modules/hooks/lib/jobs/log-job.d.ts +0 -1
- package/dist/modules/hooks/lib/jobs/log-job.js +0 -9
- package/dist/modules/hooks/lib/wait.d.ts +0 -8
- package/dist/modules/hooks/lib/wait.js +0 -13
- package/dist/modules/index.d.ts +0 -18
- package/dist/modules/index.js +0 -19
- package/dist/modules/mail/index.d.ts +0 -3
- package/dist/modules/mail/index.js +0 -4
- package/dist/modules/mail/schema.d.ts +0 -6
- package/dist/modules/mail/schema.js +0 -7
- package/dist/modules/mail/service.d.ts +0 -8
- package/dist/modules/mail/service.js +0 -10
- package/dist/modules/mail/types.d.ts +0 -6
- package/dist/modules/mail/types.js +0 -2
- package/dist/modules/notion/index.d.ts +0 -3
- package/dist/modules/notion/index.js +0 -4
- package/dist/modules/notion/schema.d.ts +0 -13
- package/dist/modules/notion/schema.js +0 -14
- package/dist/modules/notion/service.d.ts +0 -10
- package/dist/modules/notion/service.js +0 -19
- package/dist/modules/notion/types.d.ts +0 -11
- package/dist/modules/notion/types.js +0 -2
- package/dist/modules/organization/index.d.ts +0 -3
- package/dist/modules/organization/index.js +0 -4
- package/dist/modules/organization/schema.d.ts +0 -31
- package/dist/modules/organization/schema.js +0 -27
- package/dist/modules/organization/service.d.ts +0 -13
- package/dist/modules/organization/service.js +0 -25
- package/dist/modules/organization/types.d.ts +0 -11
- package/dist/modules/organization/types.js +0 -2
- package/dist/modules/scheduled-job/index.d.ts +0 -5
- package/dist/modules/scheduled-job/index.js +0 -6
- package/dist/modules/scheduled-job/lib/Schedules.d.ts +0 -34
- package/dist/modules/scheduled-job/lib/Schedules.js +0 -65
- package/dist/modules/scheduled-job/lib/jobs/index.d.ts +0 -1
- package/dist/modules/scheduled-job/lib/jobs/index.js +0 -2
- package/dist/modules/scheduled-job/lib/jobs/job1.d.ts +0 -1
- package/dist/modules/scheduled-job/lib/jobs/job1.js +0 -10
- package/dist/modules/scheduled-job/lib/wait.d.ts +0 -8
- package/dist/modules/scheduled-job/lib/wait.js +0 -13
- package/dist/modules/scheduled-job/schema.d.ts +0 -39
- package/dist/modules/scheduled-job/schema.js +0 -40
- package/dist/modules/scheduled-job/service.d.ts +0 -20
- package/dist/modules/scheduled-job/service.js +0 -46
- package/dist/modules/scheduled-job/types.d.ts +0 -66
- package/dist/modules/scheduled-job/types.js +0 -2
- package/dist/modules/scrapflow/index.d.ts +0 -2
- package/dist/modules/scrapflow/index.js +0 -3
- package/dist/modules/scrapflow/schema.d.ts +0 -105
- package/dist/modules/scrapflow/schema.js +0 -106
- package/dist/modules/scrapflow/service.d.ts +0 -24
- package/dist/modules/scrapflow/service.js +0 -61
- package/dist/modules/scrapflow/types.d.ts +0 -0
- package/dist/modules/scrapflow/types.js +0 -1
- package/dist/modules/task/index.d.ts +0 -3
- package/dist/modules/task/index.js +0 -4
- package/dist/modules/task/schema.d.ts +0 -355
- package/dist/modules/task/schema.js +0 -371
- package/dist/modules/task/service.d.ts +0 -69
- package/dist/modules/task/service.js +0 -193
- package/dist/modules/task/types.d.ts +0 -293
- package/dist/modules/task/types.js +0 -37
- package/dist/modules/tenant/index.d.ts +0 -2
- package/dist/modules/tenant/index.js +0 -3
- package/dist/modules/tenant/schema.d.ts +0 -26
- package/dist/modules/tenant/schema.js +0 -28
- package/dist/modules/tenant/service.d.ts +0 -14
- package/dist/modules/tenant/service.js +0 -28
- package/dist/modules/tenant/tenant.d.ts +0 -32
- package/dist/modules/tenant/tenant.js +0 -125
- package/dist/modules/tenant/types.d.ts +0 -20
- package/dist/modules/tenant/types.js +0 -2
- package/dist/modules/waitlist/index.d.ts +0 -3
- package/dist/modules/waitlist/index.js +0 -4
- package/dist/modules/waitlist/schema.d.ts +0 -17
- package/dist/modules/waitlist/schema.js +0 -18
- package/dist/modules/waitlist/service.d.ts +0 -13
- package/dist/modules/waitlist/service.js +0 -28
- package/dist/modules/waitlist/types.d.ts +0 -14
- package/dist/modules/waitlist/types.js +0 -2
- package/dist/permission.d.ts +0 -43
- package/dist/permission.js +0 -54
- package/dist/query.d.ts +0 -194
- package/dist/query.js +0 -204
- package/dist/role.d.ts +0 -70
- package/dist/role.js +0 -94
- package/dist/service-client.d.ts +0 -10
- package/dist/service-client.js +0 -31
- package/dist/service.d.ts +0 -11
- package/dist/service.js +0 -23
- package/dist/services/applets.d.ts +0 -9
- package/dist/services/applets.js +0 -40
- package/dist/services/avatars.d.ts +0 -115
- package/dist/services/avatars.js +0 -251
- package/dist/services/chat-flow.d.ts +0 -7
- package/dist/services/chat-flow.js +0 -26
- package/dist/services/community.d.ts +0 -19
- package/dist/services/community.js +0 -69
- package/dist/services/configuration.d.ts +0 -5
- package/dist/services/configuration.js +0 -11
- package/dist/services/databases.d.ts +0 -613
- package/dist/services/databases.js +0 -1736
- package/dist/services/functions.d.ts +0 -319
- package/dist/services/functions.js +0 -810
- package/dist/services/graphql.d.ts +0 -25
- package/dist/services/graphql.js +0 -57
- package/dist/services/health.d.ts +0 -231
- package/dist/services/health.js +0 -463
- package/dist/services/locale.d.ts +0 -80
- package/dist/services/locale.js +0 -144
- package/dist/services/messaging.d.ts +0 -685
- package/dist/services/messaging.js +0 -1920
- package/dist/services/permissions.d.ts +0 -20
- package/dist/services/permissions.js +0 -90
- package/dist/services/pricing.d.ts +0 -15
- package/dist/services/pricing.js +0 -21
- package/dist/services/projects.d.ts +0 -542
- package/dist/services/projects.js +0 -1526
- package/dist/services/roles.d.ts +0 -19
- package/dist/services/roles.js +0 -72
- package/dist/services/schema.d.ts +0 -17
- package/dist/services/schema.js +0 -48
- package/dist/services/storage.d.ts +0 -189
- package/dist/services/storage.js +0 -474
- package/dist/services/subscription.d.ts +0 -15
- package/dist/services/subscription.js +0 -30
- package/dist/services/teams.d.ts +0 -167
- package/dist/services/teams.js +0 -395
- package/dist/services/tenant-subscription.d.ts +0 -12
- package/dist/services/tenant-subscription.js +0 -52
- package/dist/services/users.d.ts +0 -499
- package/dist/services/users.js +0 -1283
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { ServiceClient } from "../service-client";
|
|
2
|
-
export class Configuration extends ServiceClient {
|
|
3
|
-
getServiceName() {
|
|
4
|
-
return 'com.appconda.service.configuration';
|
|
5
|
-
}
|
|
6
|
-
async getAppConfiguration() {
|
|
7
|
-
const payload = {};
|
|
8
|
-
return await this.actionCall('GetAppConfiguration', payload);
|
|
9
|
-
}
|
|
10
|
-
}
|
|
11
|
-
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlndXJhdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9zZXJ2aWNlcy9jb25maWd1cmF0aW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sRUFBRSxhQUFhLEVBQUUsTUFBTSxtQkFBbUIsQ0FBQztBQUdsRCxNQUFNLE9BQU8sYUFBYyxTQUFRLGFBQWE7SUFDbEMsY0FBYztRQUNwQixPQUFPLG9DQUFvQyxDQUFDO0lBQ2hELENBQUM7SUFFTSxLQUFLLENBQUMsbUJBQW1CO1FBQzVCLE1BQU0sT0FBTyxHQUFZLEVBQUUsQ0FBQztRQUM1QixPQUFPLE1BQU0sSUFBSSxDQUFDLFVBQVUsQ0FBQyxxQkFBcUIsRUFBRSxPQUFPLENBQUMsQ0FBQztJQUNqRSxDQUFDO0NBRUoiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBQYXlsb2FkIH0gZnJvbSBcIi4uL2NsaWVudFwiO1xuaW1wb3J0IHsgU2VydmljZUNsaWVudCB9IGZyb20gXCIuLi9zZXJ2aWNlLWNsaWVudFwiO1xuXG5cbmV4cG9ydCBjbGFzcyBDb25maWd1cmF0aW9uIGV4dGVuZHMgU2VydmljZUNsaWVudCB7XG4gICAgcHJvdGVjdGVkIGdldFNlcnZpY2VOYW1lKCk6IHN0cmluZyB7XG4gICAgICAgIHJldHVybiAnY29tLmFwcGNvbmRhLnNlcnZpY2UuY29uZmlndXJhdGlvbic7XG4gICAgfVxuXG4gICAgcHVibGljIGFzeW5jIGdldEFwcENvbmZpZ3VyYXRpb24oKTogUHJvbWlzZTxhbnk+IHtcbiAgICAgICAgY29uc3QgcGF5bG9hZDogUGF5bG9hZCA9IHt9O1xuICAgICAgICByZXR1cm4gYXdhaXQgdGhpcy5hY3Rpb25DYWxsKCdHZXRBcHBDb25maWd1cmF0aW9uJywgcGF5bG9hZCk7XG4gICAgfVxuXG59XG4iXX0=
|
|
@@ -1,613 +0,0 @@
|
|
|
1
|
-
import { Client } from '../client';
|
|
2
|
-
import type { Models } from '../models';
|
|
3
|
-
import { RelationshipType } from '../enums/relationship-type';
|
|
4
|
-
import { RelationMutate } from '../enums/relation-mutate';
|
|
5
|
-
import { IndexType } from '../enums/index-type';
|
|
6
|
-
export declare class Databases {
|
|
7
|
-
client: Client;
|
|
8
|
-
constructor(client: Client);
|
|
9
|
-
/**
|
|
10
|
-
* List databases
|
|
11
|
-
*
|
|
12
|
-
* Get a list of all databases from the current Appconda project. You can use the search parameter to filter your results.
|
|
13
|
-
*
|
|
14
|
-
* @param {string[]} queries
|
|
15
|
-
* @param {string} search
|
|
16
|
-
* @throws {AppcondaException}
|
|
17
|
-
* @returns {Promise<Models.DatabaseList>}
|
|
18
|
-
*/
|
|
19
|
-
list(queries?: string[], search?: string): Promise<Models.DatabaseList>;
|
|
20
|
-
/**
|
|
21
|
-
* Create database
|
|
22
|
-
*
|
|
23
|
-
* Create a new Database.
|
|
24
|
-
|
|
25
|
-
*
|
|
26
|
-
* @param {string} databaseId
|
|
27
|
-
* @param {string} name
|
|
28
|
-
* @param {boolean} enabled
|
|
29
|
-
* @throws {AppcondaException}
|
|
30
|
-
* @returns {Promise<Models.Database>}
|
|
31
|
-
*/
|
|
32
|
-
create(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
|
|
33
|
-
/**
|
|
34
|
-
* Get database
|
|
35
|
-
*
|
|
36
|
-
* Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.
|
|
37
|
-
*
|
|
38
|
-
* @param {string} databaseId
|
|
39
|
-
* @throws {AppcondaException}
|
|
40
|
-
* @returns {Promise<Models.Database>}
|
|
41
|
-
*/
|
|
42
|
-
get(databaseId: string): Promise<Models.Database>;
|
|
43
|
-
/**
|
|
44
|
-
* Update database
|
|
45
|
-
*
|
|
46
|
-
* Update a database by its unique ID.
|
|
47
|
-
*
|
|
48
|
-
* @param {string} databaseId
|
|
49
|
-
* @param {string} name
|
|
50
|
-
* @param {boolean} enabled
|
|
51
|
-
* @throws {AppcondaException}
|
|
52
|
-
* @returns {Promise<Models.Database>}
|
|
53
|
-
*/
|
|
54
|
-
update(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
|
|
55
|
-
/**
|
|
56
|
-
* Delete database
|
|
57
|
-
*
|
|
58
|
-
* Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.
|
|
59
|
-
*
|
|
60
|
-
* @param {string} databaseId
|
|
61
|
-
* @throws {AppcondaException}
|
|
62
|
-
* @returns {Promise<{}>}
|
|
63
|
-
*/
|
|
64
|
-
delete(databaseId: string): Promise<{}>;
|
|
65
|
-
/**
|
|
66
|
-
* List collections
|
|
67
|
-
*
|
|
68
|
-
* Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.
|
|
69
|
-
*
|
|
70
|
-
* @param {string} databaseId
|
|
71
|
-
* @param {string[]} queries
|
|
72
|
-
* @param {string} search
|
|
73
|
-
* @throws {AppcondaException}
|
|
74
|
-
* @returns {Promise<Models.CollectionList>}
|
|
75
|
-
*/
|
|
76
|
-
listCollections(databaseId: string, queries?: string[], search?: string): Promise<Models.CollectionList>;
|
|
77
|
-
/**
|
|
78
|
-
* Create collection
|
|
79
|
-
*
|
|
80
|
-
* Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https://appconda.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
|
|
81
|
-
*
|
|
82
|
-
* @param {string} databaseId
|
|
83
|
-
* @param {string} collectionId
|
|
84
|
-
* @param {string} name
|
|
85
|
-
* @param {string[]} permissions
|
|
86
|
-
* @param {boolean} documentSecurity
|
|
87
|
-
* @param {boolean} enabled
|
|
88
|
-
* @throws {AppcondaException}
|
|
89
|
-
* @returns {Promise<Models.Collection>}
|
|
90
|
-
*/
|
|
91
|
-
createCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
|
|
92
|
-
/**
|
|
93
|
-
* Get collection
|
|
94
|
-
*
|
|
95
|
-
* Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.
|
|
96
|
-
*
|
|
97
|
-
* @param {string} databaseId
|
|
98
|
-
* @param {string} collectionId
|
|
99
|
-
* @throws {AppcondaException}
|
|
100
|
-
* @returns {Promise<Models.Collection>}
|
|
101
|
-
*/
|
|
102
|
-
getCollection(databaseId: string, collectionId: string): Promise<Models.Collection>;
|
|
103
|
-
/**
|
|
104
|
-
* Update collection
|
|
105
|
-
*
|
|
106
|
-
* Update a collection by its unique ID.
|
|
107
|
-
*
|
|
108
|
-
* @param {string} databaseId
|
|
109
|
-
* @param {string} collectionId
|
|
110
|
-
* @param {string} name
|
|
111
|
-
* @param {string[]} permissions
|
|
112
|
-
* @param {boolean} documentSecurity
|
|
113
|
-
* @param {boolean} enabled
|
|
114
|
-
* @throws {AppcondaException}
|
|
115
|
-
* @returns {Promise<Models.Collection>}
|
|
116
|
-
*/
|
|
117
|
-
updateCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
|
|
118
|
-
/**
|
|
119
|
-
* Delete collection
|
|
120
|
-
*
|
|
121
|
-
* Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.
|
|
122
|
-
*
|
|
123
|
-
* @param {string} databaseId
|
|
124
|
-
* @param {string} collectionId
|
|
125
|
-
* @throws {AppcondaException}
|
|
126
|
-
* @returns {Promise<{}>}
|
|
127
|
-
*/
|
|
128
|
-
deleteCollection(databaseId: string, collectionId: string): Promise<{}>;
|
|
129
|
-
/**
|
|
130
|
-
* List attributes
|
|
131
|
-
*
|
|
132
|
-
* List attributes in the collection.
|
|
133
|
-
*
|
|
134
|
-
* @param {string} databaseId
|
|
135
|
-
* @param {string} collectionId
|
|
136
|
-
* @param {string[]} queries
|
|
137
|
-
* @throws {AppcondaException}
|
|
138
|
-
* @returns {Promise<Models.AttributeList>}
|
|
139
|
-
*/
|
|
140
|
-
listAttributes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.AttributeList>;
|
|
141
|
-
/**
|
|
142
|
-
* Create boolean attribute
|
|
143
|
-
*
|
|
144
|
-
* Create a boolean attribute.
|
|
145
|
-
|
|
146
|
-
*
|
|
147
|
-
* @param {string} databaseId
|
|
148
|
-
* @param {string} collectionId
|
|
149
|
-
* @param {string} key
|
|
150
|
-
* @param {boolean} required
|
|
151
|
-
* @param {boolean} xdefault
|
|
152
|
-
* @param {boolean} array
|
|
153
|
-
* @throws {AppcondaException}
|
|
154
|
-
* @returns {Promise<Models.AttributeBoolean>}
|
|
155
|
-
*/
|
|
156
|
-
createBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean, array?: boolean): Promise<Models.AttributeBoolean>;
|
|
157
|
-
/**
|
|
158
|
-
* Update boolean attribute
|
|
159
|
-
*
|
|
160
|
-
* Update a boolean attribute. Changing the `default` value will not update already existing documents.
|
|
161
|
-
*
|
|
162
|
-
* @param {string} databaseId
|
|
163
|
-
* @param {string} collectionId
|
|
164
|
-
* @param {string} key
|
|
165
|
-
* @param {boolean} required
|
|
166
|
-
* @param {boolean} xdefault
|
|
167
|
-
* @param {string} newKey
|
|
168
|
-
* @throws {AppcondaException}
|
|
169
|
-
* @returns {Promise<Models.AttributeBoolean>}
|
|
170
|
-
*/
|
|
171
|
-
updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean, newKey?: string): Promise<Models.AttributeBoolean>;
|
|
172
|
-
/**
|
|
173
|
-
* Create datetime attribute
|
|
174
|
-
*
|
|
175
|
-
* Create a date time attribute according to the ISO 8601 standard.
|
|
176
|
-
*
|
|
177
|
-
* @param {string} databaseId
|
|
178
|
-
* @param {string} collectionId
|
|
179
|
-
* @param {string} key
|
|
180
|
-
* @param {boolean} required
|
|
181
|
-
* @param {string} xdefault
|
|
182
|
-
* @param {boolean} array
|
|
183
|
-
* @throws {AppcondaException}
|
|
184
|
-
* @returns {Promise<Models.AttributeDatetime>}
|
|
185
|
-
*/
|
|
186
|
-
createDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeDatetime>;
|
|
187
|
-
/**
|
|
188
|
-
* Update dateTime attribute
|
|
189
|
-
*
|
|
190
|
-
* Update a date time attribute. Changing the `default` value will not update already existing documents.
|
|
191
|
-
*
|
|
192
|
-
* @param {string} databaseId
|
|
193
|
-
* @param {string} collectionId
|
|
194
|
-
* @param {string} key
|
|
195
|
-
* @param {boolean} required
|
|
196
|
-
* @param {string} xdefault
|
|
197
|
-
* @param {string} newKey
|
|
198
|
-
* @throws {AppcondaException}
|
|
199
|
-
* @returns {Promise<Models.AttributeDatetime>}
|
|
200
|
-
*/
|
|
201
|
-
updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeDatetime>;
|
|
202
|
-
/**
|
|
203
|
-
* Create email attribute
|
|
204
|
-
*
|
|
205
|
-
* Create an email attribute.
|
|
206
|
-
|
|
207
|
-
*
|
|
208
|
-
* @param {string} databaseId
|
|
209
|
-
* @param {string} collectionId
|
|
210
|
-
* @param {string} key
|
|
211
|
-
* @param {boolean} required
|
|
212
|
-
* @param {string} xdefault
|
|
213
|
-
* @param {boolean} array
|
|
214
|
-
* @throws {AppcondaException}
|
|
215
|
-
* @returns {Promise<Models.AttributeEmail>}
|
|
216
|
-
*/
|
|
217
|
-
createEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeEmail>;
|
|
218
|
-
/**
|
|
219
|
-
* Update email attribute
|
|
220
|
-
*
|
|
221
|
-
* Update an email attribute. Changing the `default` value will not update already existing documents.
|
|
222
|
-
|
|
223
|
-
*
|
|
224
|
-
* @param {string} databaseId
|
|
225
|
-
* @param {string} collectionId
|
|
226
|
-
* @param {string} key
|
|
227
|
-
* @param {boolean} required
|
|
228
|
-
* @param {string} xdefault
|
|
229
|
-
* @param {string} newKey
|
|
230
|
-
* @throws {AppcondaException}
|
|
231
|
-
* @returns {Promise<Models.AttributeEmail>}
|
|
232
|
-
*/
|
|
233
|
-
updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeEmail>;
|
|
234
|
-
/**
|
|
235
|
-
* Create enum attribute
|
|
236
|
-
*
|
|
237
|
-
* Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute.
|
|
238
|
-
|
|
239
|
-
*
|
|
240
|
-
* @param {string} databaseId
|
|
241
|
-
* @param {string} collectionId
|
|
242
|
-
* @param {string} key
|
|
243
|
-
* @param {string[]} elements
|
|
244
|
-
* @param {boolean} required
|
|
245
|
-
* @param {string} xdefault
|
|
246
|
-
* @param {boolean} array
|
|
247
|
-
* @throws {AppcondaException}
|
|
248
|
-
* @returns {Promise<Models.AttributeEnum>}
|
|
249
|
-
*/
|
|
250
|
-
createEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeEnum>;
|
|
251
|
-
/**
|
|
252
|
-
* Update enum attribute
|
|
253
|
-
*
|
|
254
|
-
* Update an enum attribute. Changing the `default` value will not update already existing documents.
|
|
255
|
-
|
|
256
|
-
*
|
|
257
|
-
* @param {string} databaseId
|
|
258
|
-
* @param {string} collectionId
|
|
259
|
-
* @param {string} key
|
|
260
|
-
* @param {string[]} elements
|
|
261
|
-
* @param {boolean} required
|
|
262
|
-
* @param {string} xdefault
|
|
263
|
-
* @param {string} newKey
|
|
264
|
-
* @throws {AppcondaException}
|
|
265
|
-
* @returns {Promise<Models.AttributeEnum>}
|
|
266
|
-
*/
|
|
267
|
-
updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeEnum>;
|
|
268
|
-
/**
|
|
269
|
-
* Create float attribute
|
|
270
|
-
*
|
|
271
|
-
* Create a float attribute. Optionally, minimum and maximum values can be provided.
|
|
272
|
-
|
|
273
|
-
*
|
|
274
|
-
* @param {string} databaseId
|
|
275
|
-
* @param {string} collectionId
|
|
276
|
-
* @param {string} key
|
|
277
|
-
* @param {boolean} required
|
|
278
|
-
* @param {number} min
|
|
279
|
-
* @param {number} max
|
|
280
|
-
* @param {number} xdefault
|
|
281
|
-
* @param {boolean} array
|
|
282
|
-
* @throws {AppcondaException}
|
|
283
|
-
* @returns {Promise<Models.AttributeFloat>}
|
|
284
|
-
*/
|
|
285
|
-
createFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.AttributeFloat>;
|
|
286
|
-
/**
|
|
287
|
-
* Update float attribute
|
|
288
|
-
*
|
|
289
|
-
* Update a float attribute. Changing the `default` value will not update already existing documents.
|
|
290
|
-
|
|
291
|
-
*
|
|
292
|
-
* @param {string} databaseId
|
|
293
|
-
* @param {string} collectionId
|
|
294
|
-
* @param {string} key
|
|
295
|
-
* @param {boolean} required
|
|
296
|
-
* @param {number} min
|
|
297
|
-
* @param {number} max
|
|
298
|
-
* @param {number} xdefault
|
|
299
|
-
* @param {string} newKey
|
|
300
|
-
* @throws {AppcondaException}
|
|
301
|
-
* @returns {Promise<Models.AttributeFloat>}
|
|
302
|
-
*/
|
|
303
|
-
updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number, newKey?: string): Promise<Models.AttributeFloat>;
|
|
304
|
-
/**
|
|
305
|
-
* Create integer attribute
|
|
306
|
-
*
|
|
307
|
-
* Create an integer attribute. Optionally, minimum and maximum values can be provided.
|
|
308
|
-
|
|
309
|
-
*
|
|
310
|
-
* @param {string} databaseId
|
|
311
|
-
* @param {string} collectionId
|
|
312
|
-
* @param {string} key
|
|
313
|
-
* @param {boolean} required
|
|
314
|
-
* @param {number} min
|
|
315
|
-
* @param {number} max
|
|
316
|
-
* @param {number} xdefault
|
|
317
|
-
* @param {boolean} array
|
|
318
|
-
* @throws {AppcondaException}
|
|
319
|
-
* @returns {Promise<Models.AttributeInteger>}
|
|
320
|
-
*/
|
|
321
|
-
createIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.AttributeInteger>;
|
|
322
|
-
/**
|
|
323
|
-
* Update integer attribute
|
|
324
|
-
*
|
|
325
|
-
* Update an integer attribute. Changing the `default` value will not update already existing documents.
|
|
326
|
-
|
|
327
|
-
*
|
|
328
|
-
* @param {string} databaseId
|
|
329
|
-
* @param {string} collectionId
|
|
330
|
-
* @param {string} key
|
|
331
|
-
* @param {boolean} required
|
|
332
|
-
* @param {number} min
|
|
333
|
-
* @param {number} max
|
|
334
|
-
* @param {number} xdefault
|
|
335
|
-
* @param {string} newKey
|
|
336
|
-
* @throws {AppcondaException}
|
|
337
|
-
* @returns {Promise<Models.AttributeInteger>}
|
|
338
|
-
*/
|
|
339
|
-
updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number, newKey?: string): Promise<Models.AttributeInteger>;
|
|
340
|
-
/**
|
|
341
|
-
* Create IP address attribute
|
|
342
|
-
*
|
|
343
|
-
* Create IP address attribute.
|
|
344
|
-
|
|
345
|
-
*
|
|
346
|
-
* @param {string} databaseId
|
|
347
|
-
* @param {string} collectionId
|
|
348
|
-
* @param {string} key
|
|
349
|
-
* @param {boolean} required
|
|
350
|
-
* @param {string} xdefault
|
|
351
|
-
* @param {boolean} array
|
|
352
|
-
* @throws {AppcondaException}
|
|
353
|
-
* @returns {Promise<Models.AttributeIp>}
|
|
354
|
-
*/
|
|
355
|
-
createIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeIp>;
|
|
356
|
-
/**
|
|
357
|
-
* Update IP address attribute
|
|
358
|
-
*
|
|
359
|
-
* Update an ip attribute. Changing the `default` value will not update already existing documents.
|
|
360
|
-
|
|
361
|
-
*
|
|
362
|
-
* @param {string} databaseId
|
|
363
|
-
* @param {string} collectionId
|
|
364
|
-
* @param {string} key
|
|
365
|
-
* @param {boolean} required
|
|
366
|
-
* @param {string} xdefault
|
|
367
|
-
* @param {string} newKey
|
|
368
|
-
* @throws {AppcondaException}
|
|
369
|
-
* @returns {Promise<Models.AttributeIp>}
|
|
370
|
-
*/
|
|
371
|
-
updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeIp>;
|
|
372
|
-
/**
|
|
373
|
-
* Create relationship attribute
|
|
374
|
-
*
|
|
375
|
-
* Create relationship attribute. [Learn more about relationship attributes](https://appconda.io/docs/databases-relationships#relationship-attributes).
|
|
376
|
-
|
|
377
|
-
*
|
|
378
|
-
* @param {string} databaseId
|
|
379
|
-
* @param {string} collectionId
|
|
380
|
-
* @param {string} relatedCollectionId
|
|
381
|
-
* @param {RelationshipType} type
|
|
382
|
-
* @param {boolean} twoWay
|
|
383
|
-
* @param {string} key
|
|
384
|
-
* @param {string} twoWayKey
|
|
385
|
-
* @param {RelationMutate} onDelete
|
|
386
|
-
* @throws {AppcondaException}
|
|
387
|
-
* @returns {Promise<Models.AttributeRelationship>}
|
|
388
|
-
*/
|
|
389
|
-
createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: RelationshipType, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: RelationMutate): Promise<Models.AttributeRelationship>;
|
|
390
|
-
/**
|
|
391
|
-
* Create string attribute
|
|
392
|
-
*
|
|
393
|
-
* Create a string attribute.
|
|
394
|
-
|
|
395
|
-
*
|
|
396
|
-
* @param {string} databaseId
|
|
397
|
-
* @param {string} collectionId
|
|
398
|
-
* @param {string} key
|
|
399
|
-
* @param {number} size
|
|
400
|
-
* @param {boolean} required
|
|
401
|
-
* @param {string} xdefault
|
|
402
|
-
* @param {boolean} array
|
|
403
|
-
* @param {boolean} encrypt
|
|
404
|
-
* @throws {AppcondaException}
|
|
405
|
-
* @returns {Promise<Models.AttributeString>}
|
|
406
|
-
*/
|
|
407
|
-
createStringAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeString>;
|
|
408
|
-
/**
|
|
409
|
-
* Update string attribute
|
|
410
|
-
*
|
|
411
|
-
* Update a string attribute. Changing the `default` value will not update already existing documents.
|
|
412
|
-
|
|
413
|
-
*
|
|
414
|
-
* @param {string} databaseId
|
|
415
|
-
* @param {string} collectionId
|
|
416
|
-
* @param {string} key
|
|
417
|
-
* @param {boolean} required
|
|
418
|
-
* @param {string} xdefault
|
|
419
|
-
* @param {number} size
|
|
420
|
-
* @param {string} newKey
|
|
421
|
-
* @throws {AppcondaException}
|
|
422
|
-
* @returns {Promise<Models.AttributeString>}
|
|
423
|
-
*/
|
|
424
|
-
updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, size?: number, newKey?: string): Promise<Models.AttributeString>;
|
|
425
|
-
/**
|
|
426
|
-
* Create URL attribute
|
|
427
|
-
*
|
|
428
|
-
* Create a URL attribute.
|
|
429
|
-
|
|
430
|
-
*
|
|
431
|
-
* @param {string} databaseId
|
|
432
|
-
* @param {string} collectionId
|
|
433
|
-
* @param {string} key
|
|
434
|
-
* @param {boolean} required
|
|
435
|
-
* @param {string} xdefault
|
|
436
|
-
* @param {boolean} array
|
|
437
|
-
* @throws {AppcondaException}
|
|
438
|
-
* @returns {Promise<Models.AttributeUrl>}
|
|
439
|
-
*/
|
|
440
|
-
createUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeUrl>;
|
|
441
|
-
/**
|
|
442
|
-
* Update URL attribute
|
|
443
|
-
*
|
|
444
|
-
* Update an url attribute. Changing the `default` value will not update already existing documents.
|
|
445
|
-
|
|
446
|
-
*
|
|
447
|
-
* @param {string} databaseId
|
|
448
|
-
* @param {string} collectionId
|
|
449
|
-
* @param {string} key
|
|
450
|
-
* @param {boolean} required
|
|
451
|
-
* @param {string} xdefault
|
|
452
|
-
* @param {string} newKey
|
|
453
|
-
* @throws {AppcondaException}
|
|
454
|
-
* @returns {Promise<Models.AttributeUrl>}
|
|
455
|
-
*/
|
|
456
|
-
updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeUrl>;
|
|
457
|
-
/**
|
|
458
|
-
* Get attribute
|
|
459
|
-
*
|
|
460
|
-
* Get attribute by ID.
|
|
461
|
-
*
|
|
462
|
-
* @param {string} databaseId
|
|
463
|
-
* @param {string} collectionId
|
|
464
|
-
* @param {string} key
|
|
465
|
-
* @throws {AppcondaException}
|
|
466
|
-
* @returns {Promise<{}>}
|
|
467
|
-
*/
|
|
468
|
-
getAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>;
|
|
469
|
-
/**
|
|
470
|
-
* Delete attribute
|
|
471
|
-
*
|
|
472
|
-
* Deletes an attribute.
|
|
473
|
-
*
|
|
474
|
-
* @param {string} databaseId
|
|
475
|
-
* @param {string} collectionId
|
|
476
|
-
* @param {string} key
|
|
477
|
-
* @throws {AppcondaException}
|
|
478
|
-
* @returns {Promise<{}>}
|
|
479
|
-
*/
|
|
480
|
-
deleteAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>;
|
|
481
|
-
/**
|
|
482
|
-
* Update relationship attribute
|
|
483
|
-
*
|
|
484
|
-
* Update relationship attribute. [Learn more about relationship attributes](https://appconda.io/docs/databases-relationships#relationship-attributes).
|
|
485
|
-
|
|
486
|
-
*
|
|
487
|
-
* @param {string} databaseId
|
|
488
|
-
* @param {string} collectionId
|
|
489
|
-
* @param {string} key
|
|
490
|
-
* @param {RelationMutate} onDelete
|
|
491
|
-
* @param {string} newKey
|
|
492
|
-
* @throws {AppcondaException}
|
|
493
|
-
* @returns {Promise<Models.AttributeRelationship>}
|
|
494
|
-
*/
|
|
495
|
-
updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate, newKey?: string): Promise<Models.AttributeRelationship>;
|
|
496
|
-
/**
|
|
497
|
-
* List documents
|
|
498
|
-
*
|
|
499
|
-
* Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
|
|
500
|
-
*
|
|
501
|
-
* @param {string} databaseId
|
|
502
|
-
* @param {string} collectionId
|
|
503
|
-
* @param {string[]} queries
|
|
504
|
-
* @throws {AppcondaException}
|
|
505
|
-
* @returns {Promise<Models.DocumentList<Document>>}
|
|
506
|
-
*/
|
|
507
|
-
listDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.DocumentList<Document>>;
|
|
508
|
-
/**
|
|
509
|
-
* Create document
|
|
510
|
-
*
|
|
511
|
-
* Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appconda.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
|
|
512
|
-
*
|
|
513
|
-
* @param {string} databaseId
|
|
514
|
-
* @param {string} collectionId
|
|
515
|
-
* @param {string} documentId
|
|
516
|
-
* @param {Omit<Document, keyof Models.Document>} data
|
|
517
|
-
* @param {string[]} permissions
|
|
518
|
-
* @throws {AppcondaException}
|
|
519
|
-
* @returns {Promise<Document>}
|
|
520
|
-
*/
|
|
521
|
-
createDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: Omit<Document, keyof Models.Document>, permissions?: string[]): Promise<Document>;
|
|
522
|
-
/**
|
|
523
|
-
* Get document
|
|
524
|
-
*
|
|
525
|
-
* Get a document by its unique ID. This endpoint response returns a JSON object with the document data.
|
|
526
|
-
*
|
|
527
|
-
* @param {string} databaseId
|
|
528
|
-
* @param {string} collectionId
|
|
529
|
-
* @param {string} documentId
|
|
530
|
-
* @param {string[]} queries
|
|
531
|
-
* @throws {AppcondaException}
|
|
532
|
-
* @returns {Promise<Document>}
|
|
533
|
-
*/
|
|
534
|
-
getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document>;
|
|
535
|
-
/**
|
|
536
|
-
* Update document
|
|
537
|
-
*
|
|
538
|
-
* Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.
|
|
539
|
-
*
|
|
540
|
-
* @param {string} databaseId
|
|
541
|
-
* @param {string} collectionId
|
|
542
|
-
* @param {string} documentId
|
|
543
|
-
* @param {Partial<Omit<Document, keyof Models.Document>>} data
|
|
544
|
-
* @param {string[]} permissions
|
|
545
|
-
* @throws {AppcondaException}
|
|
546
|
-
* @returns {Promise<Document>}
|
|
547
|
-
*/
|
|
548
|
-
updateDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data?: Partial<Omit<Document, keyof Models.Document>>, permissions?: string[]): Promise<Document>;
|
|
549
|
-
/**
|
|
550
|
-
* Delete document
|
|
551
|
-
*
|
|
552
|
-
* Delete a document by its unique ID.
|
|
553
|
-
*
|
|
554
|
-
* @param {string} databaseId
|
|
555
|
-
* @param {string} collectionId
|
|
556
|
-
* @param {string} documentId
|
|
557
|
-
* @throws {AppcondaException}
|
|
558
|
-
* @returns {Promise<{}>}
|
|
559
|
-
*/
|
|
560
|
-
deleteDocument(databaseId: string, collectionId: string, documentId: string): Promise<{}>;
|
|
561
|
-
/**
|
|
562
|
-
* List indexes
|
|
563
|
-
*
|
|
564
|
-
* List indexes in the collection.
|
|
565
|
-
*
|
|
566
|
-
* @param {string} databaseId
|
|
567
|
-
* @param {string} collectionId
|
|
568
|
-
* @param {string[]} queries
|
|
569
|
-
* @throws {AppcondaException}
|
|
570
|
-
* @returns {Promise<Models.IndexList>}
|
|
571
|
-
*/
|
|
572
|
-
listIndexes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.IndexList>;
|
|
573
|
-
/**
|
|
574
|
-
* Create index
|
|
575
|
-
*
|
|
576
|
-
* Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.
|
|
577
|
-
Attributes can be `key`, `fulltext`, and `unique`.
|
|
578
|
-
*
|
|
579
|
-
* @param {string} databaseId
|
|
580
|
-
* @param {string} collectionId
|
|
581
|
-
* @param {string} key
|
|
582
|
-
* @param {IndexType} type
|
|
583
|
-
* @param {string[]} attributes
|
|
584
|
-
* @param {string[]} orders
|
|
585
|
-
* @throws {AppcondaException}
|
|
586
|
-
* @returns {Promise<Models.Index>}
|
|
587
|
-
*/
|
|
588
|
-
createIndex(databaseId: string, collectionId: string, key: string, type: IndexType, attributes: string[], orders?: string[]): Promise<Models.Index>;
|
|
589
|
-
/**
|
|
590
|
-
* Get index
|
|
591
|
-
*
|
|
592
|
-
* Get index by ID.
|
|
593
|
-
*
|
|
594
|
-
* @param {string} databaseId
|
|
595
|
-
* @param {string} collectionId
|
|
596
|
-
* @param {string} key
|
|
597
|
-
* @throws {AppcondaException}
|
|
598
|
-
* @returns {Promise<Models.Index>}
|
|
599
|
-
*/
|
|
600
|
-
getIndex(databaseId: string, collectionId: string, key: string): Promise<Models.Index>;
|
|
601
|
-
/**
|
|
602
|
-
* Delete index
|
|
603
|
-
*
|
|
604
|
-
* Delete an index.
|
|
605
|
-
*
|
|
606
|
-
* @param {string} databaseId
|
|
607
|
-
* @param {string} collectionId
|
|
608
|
-
* @param {string} key
|
|
609
|
-
* @throws {AppcondaException}
|
|
610
|
-
* @returns {Promise<{}>}
|
|
611
|
-
*/
|
|
612
|
-
deleteIndex(databaseId: string, collectionId: string, key: string): Promise<{}>;
|
|
613
|
-
}
|