@squidcloud/backend 1.0.83 → 1.0.85
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.
|
@@ -10,7 +10,7 @@ import { ActionMethodDecorator, AiAssistantActionType, ApiEndpointId, Collection
|
|
|
10
10
|
* as a parameter. The context object contains information about the action.
|
|
11
11
|
*
|
|
12
12
|
* To read more about securing a database, see the
|
|
13
|
-
* [documentation]{@link https://docs.squid.cloud/docs/backend/security-rules/secure-data-access#securedatabase}.
|
|
13
|
+
* [documentation]{@link https://docs.squid.cloud/docs/development-tools/backend/security-rules/secure-data-access#securedatabase}.
|
|
14
14
|
* @param type The type af action to secure.
|
|
15
15
|
* @param integrationId The id of the integration to secure.
|
|
16
16
|
*/
|
|
@@ -26,7 +26,7 @@ export declare function secureDatabase<T extends DatabaseActionType>(type: T, in
|
|
|
26
26
|
* as a parameter. The context object contains information about the action.
|
|
27
27
|
*
|
|
28
28
|
* To read more about securing a collection rules, see the
|
|
29
|
-
* [documentation]{@link https://docs.squid.cloud/docs/backend/security-rules/secure-data-access#securecollection}.
|
|
29
|
+
* [documentation]{@link https://docs.squid.cloud/docs/development-tools/backend/security-rules/secure-data-access#securecollection}.
|
|
30
30
|
* @param collectionName The name of the collection to secure.
|
|
31
31
|
* @param type The type af action to secure.
|
|
32
32
|
* @param integrationId The id of the integration to secure.
|
|
@@ -42,7 +42,7 @@ export declare function secureCollection<T extends DatabaseActionType>(collectio
|
|
|
42
42
|
* The function takes a context object as a parameter. The context object contains information about the action.
|
|
43
43
|
*
|
|
44
44
|
* To read more about securing an API, see the
|
|
45
|
-
* [documentation]{@link https://docs.squid.cloud/docs/backend/security-rules/secure-api}.
|
|
45
|
+
* [documentation]{@link https://docs.squid.cloud/docs/development-tools/backend/security-rules/secure-api}.
|
|
46
46
|
* @param integrationId The id of the integration to secure.
|
|
47
47
|
* @param endpointId The id of the endpoint to secure.
|
|
48
48
|
*/
|
|
@@ -55,7 +55,7 @@ export declare function secureApi<T extends SecureApiAction>(integrationId: Inte
|
|
|
55
55
|
* The function takes a context object as a parameter. The context object contains information about the action.
|
|
56
56
|
*
|
|
57
57
|
* To read more about securing a GraphQL integration, see the
|
|
58
|
-
* [documentation]{@link https://docs.squid.cloud/docs/backend/security-rules/secure-graphql}.
|
|
58
|
+
* [documentation]{@link https://docs.squid.cloud/docs/development-tools/backend/security-rules/secure-graphql}.
|
|
59
59
|
* @param integrationId
|
|
60
60
|
*/
|
|
61
61
|
export declare function secureGraphQL<T extends SecureGraphQLAction>(integrationId: IntegrationId): ActionMethodDecorator<SecureGraphQLAction>;
|
|
@@ -66,7 +66,7 @@ export declare function secureGraphQL<T extends SecureGraphQLAction>(integration
|
|
|
66
66
|
*
|
|
67
67
|
* Once the function is exposed, it can be called from the Squid Cloud SDK using the `executeFunction` method.
|
|
68
68
|
* To read more about exposing an executable, see the
|
|
69
|
-
* [documentation]{@link https://docs.squid.cloud/docs/backend/executables}.
|
|
69
|
+
* [documentation]{@link https://docs.squid.cloud/docs/development-tools/backend/executables}.
|
|
70
70
|
*/
|
|
71
71
|
export declare function executable(): ActionMethodDecorator<ExecutableAction>;
|
|
72
72
|
/**
|
|
@@ -74,7 +74,7 @@ export declare function executable(): ActionMethodDecorator<ExecutableAction>;
|
|
|
74
74
|
* change is made to the collection.
|
|
75
75
|
* The function accepts a context object as a parameter. The context object contains information about the change.
|
|
76
76
|
*
|
|
77
|
-
* To read more about triggers, see the [documentation]{@link https://docs.squid.cloud/docs/backend/triggers}.
|
|
77
|
+
* To read more about triggers, see the [documentation]{@link https://docs.squid.cloud/docs/development-tools/backend/triggers}.
|
|
78
78
|
*
|
|
79
79
|
* @param id The id of the trigger. Should be unique.
|
|
80
80
|
* @param collectionName The name of the collection to trigger on.
|
|
@@ -85,7 +85,7 @@ export declare function trigger(id: TriggerId, collectionName: CollectionName, i
|
|
|
85
85
|
* Decorator that marks a function as a scheduler. The function will be called according to the provided cron
|
|
86
86
|
* expression.
|
|
87
87
|
*
|
|
88
|
-
* To read more about schedulers, see the [documentation]{@link https://docs.squid.cloud/docs/backend/schedulers}.
|
|
88
|
+
* To read more about schedulers, see the [documentation]{@link https://docs.squid.cloud/docs/development-tools/backend/schedulers}.
|
|
89
89
|
*
|
|
90
90
|
* @param id The id of the scheduler. Should be unique.
|
|
91
91
|
* @param cronExpression The cron expression to schedule the function on.
|
|
@@ -103,7 +103,7 @@ export declare function scheduler(id: SchedulerId, cronExpression: CronExpressio
|
|
|
103
103
|
* using:
|
|
104
104
|
* `this.createWebhookResponse(<params>)`.
|
|
105
105
|
*
|
|
106
|
-
* To read more about webhooks, see the [documentation]{@link https://docs.squid.cloud/docs/backend/webhooks}.
|
|
106
|
+
* To read more about webhooks, see the [documentation]{@link https://docs.squid.cloud/docs/development-tools/backend/webhooks}.
|
|
107
107
|
* @param id The id of the webhook. Should be unique.
|
|
108
108
|
*/
|
|
109
109
|
export declare function webhook(id: WebhookId): ActionMethodDecorator<WebhookAction>;
|
|
@@ -113,7 +113,7 @@ export declare function webhook(id: WebhookId): ActionMethodDecorator<WebhookAct
|
|
|
113
113
|
*
|
|
114
114
|
* A named query can be invoked from the SDK using the `executeNamedQuery` method.
|
|
115
115
|
*
|
|
116
|
-
* To read more about named queries, see the [documentation]{@link https://docs.squid.cloud/docs/backend/named-queries}.
|
|
116
|
+
* To read more about named queries, see the [documentation]{@link https://docs.squid.cloud/docs/development-tools/backend/named-queries}.
|
|
117
117
|
*
|
|
118
118
|
* @param integrationId The database integration id (Note that the `built_in_db` does not support named queries)
|
|
119
119
|
* @param name The name of the query that will be used to call it from the SDK.
|
|
@@ -42,7 +42,7 @@ export declare class SquidService {
|
|
|
42
42
|
/**
|
|
43
43
|
* Returns the assets directory for your application.
|
|
44
44
|
* To read more about the assets directory, see the [Squid
|
|
45
|
-
* documentation](https://docs.squid.cloud/docs/backend/project-structure#assets-directory).
|
|
45
|
+
* documentation](https://docs.squid.cloud/docs/development-tools/backend/project-structure#assets-directory).
|
|
46
46
|
*
|
|
47
47
|
* @returns the assets directory for your application.
|
|
48
48
|
*/
|