@superblocksteam/sdk-api 2.0.96 → 2.0.97-next.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/README.md +68 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/integrations/athena/client.d.ts +3 -3
- package/dist/integrations/athena/client.d.ts.map +1 -1
- package/dist/integrations/athena/client.js +4 -4
- package/dist/integrations/athena/client.js.map +1 -1
- package/dist/integrations/athena/types.d.ts +3 -2
- package/dist/integrations/athena/types.d.ts.map +1 -1
- package/dist/integrations/base/graphql-integration-client.d.ts +5 -3
- package/dist/integrations/base/graphql-integration-client.d.ts.map +1 -1
- package/dist/integrations/base/graphql-integration-client.js +8 -6
- package/dist/integrations/base/graphql-integration-client.js.map +1 -1
- package/dist/integrations/base/rest-api-integration-client.d.ts +6 -4
- package/dist/integrations/base/rest-api-integration-client.d.ts.map +1 -1
- package/dist/integrations/base/rest-api-integration-client.js +7 -5
- package/dist/integrations/base/rest-api-integration-client.js.map +1 -1
- package/dist/integrations/base/types.d.ts +9 -4
- package/dist/integrations/base/types.d.ts.map +1 -1
- package/dist/integrations/bigquery/client.d.ts +3 -3
- package/dist/integrations/bigquery/client.d.ts.map +1 -1
- package/dist/integrations/bigquery/client.js +4 -4
- package/dist/integrations/bigquery/client.js.map +1 -1
- package/dist/integrations/bigquery/types.d.ts +3 -2
- package/dist/integrations/bigquery/types.d.ts.map +1 -1
- package/dist/integrations/cockroachdb/client.d.ts +3 -3
- package/dist/integrations/cockroachdb/client.d.ts.map +1 -1
- package/dist/integrations/cockroachdb/client.js +4 -4
- package/dist/integrations/cockroachdb/client.js.map +1 -1
- package/dist/integrations/cockroachdb/types.d.ts +3 -2
- package/dist/integrations/cockroachdb/types.d.ts.map +1 -1
- package/dist/integrations/cosmosdb/client.d.ts +7 -7
- package/dist/integrations/cosmosdb/client.d.ts.map +1 -1
- package/dist/integrations/cosmosdb/client.js +14 -14
- package/dist/integrations/cosmosdb/client.js.map +1 -1
- package/dist/integrations/cosmosdb/types.d.ts +12 -6
- package/dist/integrations/cosmosdb/types.d.ts.map +1 -1
- package/dist/integrations/couchbase/client.d.ts +5 -5
- package/dist/integrations/couchbase/client.d.ts.map +1 -1
- package/dist/integrations/couchbase/client.js +8 -8
- package/dist/integrations/couchbase/client.js.map +1 -1
- package/dist/integrations/couchbase/types.d.ts +8 -4
- package/dist/integrations/couchbase/types.d.ts.map +1 -1
- package/dist/integrations/databricks/client.d.ts +3 -3
- package/dist/integrations/databricks/client.d.ts.map +1 -1
- package/dist/integrations/databricks/client.js +4 -4
- package/dist/integrations/databricks/client.js.map +1 -1
- package/dist/integrations/databricks/types.d.ts +3 -2
- package/dist/integrations/databricks/types.d.ts.map +1 -1
- package/dist/integrations/dynamodb/client.d.ts +12 -12
- package/dist/integrations/dynamodb/client.d.ts.map +1 -1
- package/dist/integrations/dynamodb/client.js +24 -24
- package/dist/integrations/dynamodb/client.js.map +1 -1
- package/dist/integrations/dynamodb/types.d.ts +28 -14
- package/dist/integrations/dynamodb/types.d.ts.map +1 -1
- package/dist/integrations/gcs/client.d.ts +8 -8
- package/dist/integrations/gcs/client.d.ts.map +1 -1
- package/dist/integrations/gcs/client.js +16 -16
- package/dist/integrations/gcs/client.js.map +1 -1
- package/dist/integrations/gcs/types.d.ts +14 -7
- package/dist/integrations/gcs/types.d.ts.map +1 -1
- package/dist/integrations/graphql/types.d.ts +11 -4
- package/dist/integrations/graphql/types.d.ts.map +1 -1
- package/dist/integrations/gsheets/client.d.ts +2 -2
- package/dist/integrations/gsheets/client.d.ts.map +1 -1
- package/dist/integrations/gsheets/client.js +2 -2
- package/dist/integrations/gsheets/client.js.map +1 -1
- package/dist/integrations/gsheets/types.d.ts +2 -1
- package/dist/integrations/gsheets/types.d.ts.map +1 -1
- package/dist/integrations/index.d.ts +1 -1
- package/dist/integrations/index.d.ts.map +1 -1
- package/dist/integrations/index.js.map +1 -1
- package/dist/integrations/kafka/client.d.ts +3 -3
- package/dist/integrations/kafka/client.d.ts.map +1 -1
- package/dist/integrations/kafka/client.js +6 -6
- package/dist/integrations/kafka/client.js.map +1 -1
- package/dist/integrations/kafka/types.d.ts +4 -2
- package/dist/integrations/kafka/types.d.ts.map +1 -1
- package/dist/integrations/kinesis/client.d.ts +3 -3
- package/dist/integrations/kinesis/client.d.ts.map +1 -1
- package/dist/integrations/kinesis/client.js +6 -6
- package/dist/integrations/kinesis/client.js.map +1 -1
- package/dist/integrations/kinesis/types.d.ts +4 -2
- package/dist/integrations/kinesis/types.d.ts.map +1 -1
- package/dist/integrations/lakebase/client.d.ts +3 -3
- package/dist/integrations/lakebase/client.d.ts.map +1 -1
- package/dist/integrations/lakebase/client.js +4 -4
- package/dist/integrations/lakebase/client.js.map +1 -1
- package/dist/integrations/lakebase/types.d.ts +3 -2
- package/dist/integrations/lakebase/types.d.ts.map +1 -1
- package/dist/integrations/mariadb/client.d.ts +3 -3
- package/dist/integrations/mariadb/client.d.ts.map +1 -1
- package/dist/integrations/mariadb/client.js +4 -4
- package/dist/integrations/mariadb/client.js.map +1 -1
- package/dist/integrations/mariadb/types.d.ts +3 -2
- package/dist/integrations/mariadb/types.d.ts.map +1 -1
- package/dist/integrations/mongodb/client.d.ts +2 -2
- package/dist/integrations/mongodb/client.d.ts.map +1 -1
- package/dist/integrations/mongodb/client.js +2 -2
- package/dist/integrations/mongodb/client.js.map +1 -1
- package/dist/integrations/mongodb/types.d.ts +2 -1
- package/dist/integrations/mongodb/types.d.ts.map +1 -1
- package/dist/integrations/mssql/client.d.ts +3 -3
- package/dist/integrations/mssql/client.d.ts.map +1 -1
- package/dist/integrations/mssql/client.js +4 -4
- package/dist/integrations/mssql/client.js.map +1 -1
- package/dist/integrations/mssql/types.d.ts +3 -2
- package/dist/integrations/mssql/types.d.ts.map +1 -1
- package/dist/integrations/mysql/client.d.ts +3 -3
- package/dist/integrations/mysql/client.d.ts.map +1 -1
- package/dist/integrations/mysql/client.js +4 -4
- package/dist/integrations/mysql/client.js.map +1 -1
- package/dist/integrations/mysql/types.d.ts +3 -2
- package/dist/integrations/mysql/types.d.ts.map +1 -1
- package/dist/integrations/oracledb/client.d.ts +3 -3
- package/dist/integrations/oracledb/client.d.ts.map +1 -1
- package/dist/integrations/oracledb/client.js +4 -4
- package/dist/integrations/oracledb/client.js.map +1 -1
- package/dist/integrations/oracledb/types.d.ts +3 -2
- package/dist/integrations/oracledb/types.d.ts.map +1 -1
- package/dist/integrations/postgres/client.d.ts +3 -3
- package/dist/integrations/postgres/client.d.ts.map +1 -1
- package/dist/integrations/postgres/client.js +4 -4
- package/dist/integrations/postgres/client.js.map +1 -1
- package/dist/integrations/postgres/types.d.ts +3 -2
- package/dist/integrations/postgres/types.d.ts.map +1 -1
- package/dist/integrations/python/client.d.ts +2 -2
- package/dist/integrations/python/client.d.ts.map +1 -1
- package/dist/integrations/python/client.js +2 -2
- package/dist/integrations/python/client.js.map +1 -1
- package/dist/integrations/python/types.d.ts +19 -2
- package/dist/integrations/python/types.d.ts.map +1 -1
- package/dist/integrations/redis/client.d.ts +12 -12
- package/dist/integrations/redis/client.d.ts.map +1 -1
- package/dist/integrations/redis/client.js +24 -24
- package/dist/integrations/redis/client.js.map +1 -1
- package/dist/integrations/redis/types.d.ts +22 -11
- package/dist/integrations/redis/types.d.ts.map +1 -1
- package/dist/integrations/redshift/client.d.ts +3 -3
- package/dist/integrations/redshift/client.d.ts.map +1 -1
- package/dist/integrations/redshift/client.js +4 -4
- package/dist/integrations/redshift/client.js.map +1 -1
- package/dist/integrations/redshift/types.d.ts +3 -2
- package/dist/integrations/redshift/types.d.ts.map +1 -1
- package/dist/integrations/registry.d.ts +21 -2
- package/dist/integrations/registry.d.ts.map +1 -1
- package/dist/integrations/registry.js.map +1 -1
- package/dist/integrations/s3/client.d.ts +8 -8
- package/dist/integrations/s3/client.d.ts.map +1 -1
- package/dist/integrations/s3/client.js +16 -16
- package/dist/integrations/s3/client.js.map +1 -1
- package/dist/integrations/s3/types.d.ts +14 -7
- package/dist/integrations/s3/types.d.ts.map +1 -1
- package/dist/integrations/salesforce/client.d.ts +10 -10
- package/dist/integrations/salesforce/client.d.ts.map +1 -1
- package/dist/integrations/salesforce/client.js +20 -20
- package/dist/integrations/salesforce/client.js.map +1 -1
- package/dist/integrations/salesforce/types.d.ts +18 -9
- package/dist/integrations/salesforce/types.d.ts.map +1 -1
- package/dist/integrations/smtp/client.d.ts +2 -2
- package/dist/integrations/smtp/client.d.ts.map +1 -1
- package/dist/integrations/smtp/client.js +2 -2
- package/dist/integrations/smtp/client.js.map +1 -1
- package/dist/integrations/smtp/types.d.ts +2 -1
- package/dist/integrations/smtp/types.d.ts.map +1 -1
- package/dist/integrations/snowflake/client.d.ts +3 -3
- package/dist/integrations/snowflake/client.d.ts.map +1 -1
- package/dist/integrations/snowflake/client.js +4 -4
- package/dist/integrations/snowflake/client.js.map +1 -1
- package/dist/integrations/snowflake/types.d.ts +3 -2
- package/dist/integrations/snowflake/types.d.ts.map +1 -1
- package/dist/integrations/snowflakepostgres/types.d.ts +3 -2
- package/dist/integrations/snowflakepostgres/types.d.ts.map +1 -1
- package/dist/runtime/context.d.ts +2 -1
- package/dist/runtime/context.d.ts.map +1 -1
- package/dist/runtime/context.js +2 -2
- package/dist/runtime/context.js.map +1 -1
- package/dist/runtime/execute.d.ts +4 -2
- package/dist/runtime/execute.d.ts.map +1 -1
- package/dist/runtime/execute.js.map +1 -1
- package/dist/runtime/executor.d.ts +2 -1
- package/dist/runtime/executor.d.ts.map +1 -1
- package/dist/runtime/executor.js.map +1 -1
- package/dist/runtime/streaming-context.d.ts +3 -2
- package/dist/runtime/streaming-context.d.ts.map +1 -1
- package/dist/runtime/streaming-context.js +2 -2
- package/dist/runtime/streaming-context.js.map +1 -1
- package/dist/runtime/streaming-executor.d.ts +4 -2
- package/dist/runtime/streaming-executor.d.ts.map +1 -1
- package/dist/runtime/streaming-executor.js.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +1 -0
- package/src/integrations/airtable/README.md +7 -3
- package/src/integrations/anthropic/README.md +8 -4
- package/src/integrations/asana/README.md +7 -3
- package/src/integrations/athena/README.md +8 -4
- package/src/integrations/athena/client.ts +5 -3
- package/src/integrations/athena/types.ts +7 -1
- package/src/integrations/base/graphql-integration-client.ts +9 -4
- package/src/integrations/base/rest-api-integration-client.ts +16 -3
- package/src/integrations/base/types.ts +9 -2
- package/src/integrations/bigquery/README.md +8 -4
- package/src/integrations/bigquery/client.ts +5 -3
- package/src/integrations/bigquery/types.ts +7 -1
- package/src/integrations/bitbucket/README.md +7 -3
- package/src/integrations/box/README.md +7 -3
- package/src/integrations/circleci/README.md +7 -3
- package/src/integrations/cockroachdb/README.md +8 -4
- package/src/integrations/cockroachdb/client.ts +5 -3
- package/src/integrations/cockroachdb/types.ts +7 -1
- package/src/integrations/cohere/README.md +7 -3
- package/src/integrations/confluence/README.md +7 -3
- package/src/integrations/cosmosdb/README.md +7 -3
- package/src/integrations/cosmosdb/client.ts +19 -8
- package/src/integrations/cosmosdb/types.ts +12 -0
- package/src/integrations/couchbase/README.md +10 -6
- package/src/integrations/couchbase/client.ts +23 -4
- package/src/integrations/couchbase/types.ts +12 -1
- package/src/integrations/databricks/README.md +8 -4
- package/src/integrations/databricks/client.ts +5 -3
- package/src/integrations/databricks/types.ts +7 -1
- package/src/integrations/datadog/README.md +7 -3
- package/src/integrations/dropbox/README.md +7 -3
- package/src/integrations/dynamodb/README.md +17 -13
- package/src/integrations/dynamodb/client.ts +52 -15
- package/src/integrations/dynamodb/types.ts +32 -6
- package/src/integrations/elasticsearch/README.md +7 -3
- package/src/integrations/fireworks/README.md +7 -3
- package/src/integrations/front/README.md +7 -3
- package/src/integrations/gcs/README.md +13 -9
- package/src/integrations/gcs/client.ts +61 -24
- package/src/integrations/gcs/types.ts +27 -4
- package/src/integrations/gemini/README.md +7 -3
- package/src/integrations/github/README.md +7 -3
- package/src/integrations/googleanalytics/README.md +7 -3
- package/src/integrations/googledrive/README.md +7 -3
- package/src/integrations/graphql/README.md +8 -4
- package/src/integrations/graphql/types.ts +11 -2
- package/src/integrations/groq/README.md +7 -3
- package/src/integrations/gsheets/README.md +7 -3
- package/src/integrations/gsheets/client.ts +4 -1
- package/src/integrations/gsheets/types.ts +2 -0
- package/src/integrations/hubspot/README.md +7 -3
- package/src/integrations/index.ts +1 -0
- package/src/integrations/intercom/README.md +7 -3
- package/src/integrations/jira/README.md +7 -3
- package/src/integrations/kafka/README.md +8 -4
- package/src/integrations/kafka/client.ts +8 -3
- package/src/integrations/kafka/types.ts +12 -2
- package/src/integrations/kinesis/README.md +8 -4
- package/src/integrations/kinesis/client.ts +13 -4
- package/src/integrations/kinesis/types.ts +10 -2
- package/src/integrations/lakebase/client.ts +7 -1
- package/src/integrations/lakebase/types.ts +7 -1
- package/src/integrations/launchdarkly/README.md +7 -3
- package/src/integrations/mariadb/README.md +8 -4
- package/src/integrations/mariadb/client.ts +5 -3
- package/src/integrations/mariadb/types.ts +7 -1
- package/src/integrations/mistral/README.md +7 -3
- package/src/integrations/mongodb/README.md +7 -3
- package/src/integrations/mongodb/client.ts +4 -1
- package/src/integrations/mongodb/types.ts +2 -0
- package/src/integrations/mssql/README.md +8 -4
- package/src/integrations/mssql/client.ts +5 -3
- package/src/integrations/mssql/types.ts +7 -1
- package/src/integrations/mysql/README.md +8 -4
- package/src/integrations/mysql/client.ts +5 -3
- package/src/integrations/mysql/types.ts +7 -1
- package/src/integrations/notion/README.md +7 -3
- package/src/integrations/openai_v2/README.md +8 -4
- package/src/integrations/oracledb/README.md +8 -4
- package/src/integrations/oracledb/client.ts +5 -3
- package/src/integrations/oracledb/types.ts +7 -1
- package/src/integrations/pagerduty/README.md +7 -3
- package/src/integrations/perplexity/README.md +7 -3
- package/src/integrations/postgres/README.md +28 -4
- package/src/integrations/postgres/client.ts +5 -3
- package/src/integrations/postgres/types.ts +7 -1
- package/src/integrations/python/README.md +20 -5
- package/src/integrations/python/client.ts +4 -1
- package/src/integrations/python/types.ts +19 -1
- package/src/integrations/redis/README.md +7 -3
- package/src/integrations/redis/client.ts +46 -23
- package/src/integrations/redis/types.ts +40 -11
- package/src/integrations/redshift/README.md +8 -4
- package/src/integrations/redshift/client.ts +5 -3
- package/src/integrations/redshift/types.ts +7 -1
- package/src/integrations/registry.ts +22 -0
- package/src/integrations/s3/README.md +13 -9
- package/src/integrations/s3/client.ts +61 -24
- package/src/integrations/s3/types.ts +27 -4
- package/src/integrations/salesforce/README.md +15 -11
- package/src/integrations/salesforce/client.ts +29 -12
- package/src/integrations/salesforce/types.ts +30 -3
- package/src/integrations/segment/README.md +7 -3
- package/src/integrations/sendgrid/README.md +7 -3
- package/src/integrations/slack/README.md +7 -3
- package/src/integrations/smtp/client.ts +10 -3
- package/src/integrations/smtp/types.ts +2 -1
- package/src/integrations/snowflake/README.md +8 -4
- package/src/integrations/snowflake/client.ts +5 -3
- package/src/integrations/snowflake/types.ts +7 -1
- package/src/integrations/snowflakepostgres/types.ts +7 -1
- package/src/integrations/stabilityai/README.md +7 -3
- package/src/integrations/stripe/README.md +7 -3
- package/src/integrations/superblocks-ocr/README.md +7 -3
- package/src/integrations/twilio/README.md +7 -3
- package/src/integrations/zendesk/README.md +7 -3
- package/src/integrations/zoom/README.md +7 -3
- package/src/runtime/context.ts +8 -2
- package/src/runtime/execute.ts +4 -0
- package/src/runtime/executor.ts +2 -0
- package/src/runtime/streaming-context.ts +7 -3
- package/src/runtime/streaming-executor.ts +4 -0
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
|
|
8
8
|
import type { z } from "zod";
|
|
9
9
|
import type { BaseIntegrationClient } from "../../types.js";
|
|
10
|
+
import type { TraceMetadata } from "../registry.js";
|
|
10
11
|
|
|
11
12
|
/**
|
|
12
13
|
* DynamoDB AttributeValue type descriptor.
|
|
@@ -100,6 +101,7 @@ export interface DynamoDBClient extends BaseIntegrationClient {
|
|
|
100
101
|
statement: string,
|
|
101
102
|
schema: z.ZodSchema<T>,
|
|
102
103
|
params?: DynamoDBAttributeValue[],
|
|
104
|
+
metadata?: TraceMetadata,
|
|
103
105
|
): Promise<T>;
|
|
104
106
|
|
|
105
107
|
/**
|
|
@@ -108,12 +110,14 @@ export interface DynamoDBClient extends BaseIntegrationClient {
|
|
|
108
110
|
* @param table - The table name
|
|
109
111
|
* @param key - The primary key as AttributeValue map
|
|
110
112
|
* @param schema - Zod schema for validating the result
|
|
113
|
+
* @param metadata - Optional trace metadata for diagnostics
|
|
111
114
|
* @returns The validated result
|
|
112
115
|
*/
|
|
113
116
|
getItem<T>(
|
|
114
117
|
table: string,
|
|
115
118
|
key: Record<string, DynamoDBAttributeValue>,
|
|
116
119
|
schema: z.ZodSchema<T>,
|
|
120
|
+
metadata?: TraceMetadata,
|
|
117
121
|
): Promise<T>;
|
|
118
122
|
|
|
119
123
|
/**
|
|
@@ -123,7 +127,9 @@ export interface DynamoDBClient extends BaseIntegrationClient {
|
|
|
123
127
|
* @param schema - Zod schema for validating the result
|
|
124
128
|
* @param filterExpression - Optional filter expression (e.g., 'status = :s')
|
|
125
129
|
* @param expressionAttributeValues - Values for expression placeholders
|
|
126
|
-
* @param expressionAttributeNames - Name aliases for reserved words
|
|
130
|
+
* @param expressionAttributeNames - Name aliases for reserved words. **Note:** since both
|
|
131
|
+
* this param and `metadata` accept plain objects, pass `undefined` when you only need metadata.
|
|
132
|
+
* @param metadata - Optional trace metadata for diagnostics
|
|
127
133
|
* @returns The validated result
|
|
128
134
|
*/
|
|
129
135
|
scan<T>(
|
|
@@ -132,6 +138,7 @@ export interface DynamoDBClient extends BaseIntegrationClient {
|
|
|
132
138
|
filterExpression?: string,
|
|
133
139
|
expressionAttributeValues?: Record<string, DynamoDBAttributeValue>,
|
|
134
140
|
expressionAttributeNames?: Record<string, string>,
|
|
141
|
+
metadata?: TraceMetadata,
|
|
135
142
|
): Promise<T>;
|
|
136
143
|
|
|
137
144
|
/**
|
|
@@ -141,7 +148,9 @@ export interface DynamoDBClient extends BaseIntegrationClient {
|
|
|
141
148
|
* @param keyConditionExpression - Key condition (e.g., 'pk = :pk')
|
|
142
149
|
* @param expressionAttributeValues - Values for expression placeholders
|
|
143
150
|
* @param schema - Zod schema for validating the result
|
|
144
|
-
* @param expressionAttributeNames - Optional name aliases for reserved words
|
|
151
|
+
* @param expressionAttributeNames - Optional name aliases for reserved words. **Note:** since both
|
|
152
|
+
* this param and `metadata` accept plain objects, pass `undefined` when you only need metadata.
|
|
153
|
+
* @param metadata - Optional trace metadata for diagnostics
|
|
145
154
|
* @returns The validated result
|
|
146
155
|
*/
|
|
147
156
|
queryTable<T>(
|
|
@@ -150,6 +159,7 @@ export interface DynamoDBClient extends BaseIntegrationClient {
|
|
|
150
159
|
expressionAttributeValues: Record<string, DynamoDBAttributeValue>,
|
|
151
160
|
schema: z.ZodSchema<T>,
|
|
152
161
|
expressionAttributeNames?: Record<string, string>,
|
|
162
|
+
metadata?: TraceMetadata,
|
|
153
163
|
): Promise<T>;
|
|
154
164
|
|
|
155
165
|
/**
|
|
@@ -157,11 +167,13 @@ export interface DynamoDBClient extends BaseIntegrationClient {
|
|
|
157
167
|
*
|
|
158
168
|
* @param table - The table name
|
|
159
169
|
* @param item - The item as an AttributeValue map
|
|
170
|
+
* @param metadata - Optional trace metadata for diagnostics
|
|
160
171
|
* @returns The raw result from DynamoDB
|
|
161
172
|
*/
|
|
162
173
|
putItem(
|
|
163
174
|
table: string,
|
|
164
175
|
item: Record<string, DynamoDBAttributeValue>,
|
|
176
|
+
metadata?: TraceMetadata,
|
|
165
177
|
): Promise<unknown>;
|
|
166
178
|
|
|
167
179
|
/**
|
|
@@ -171,7 +183,9 @@ export interface DynamoDBClient extends BaseIntegrationClient {
|
|
|
171
183
|
* @param key - The primary key as AttributeValue map
|
|
172
184
|
* @param updateExpression - Update expression (e.g., 'SET #n = :name, age = :age')
|
|
173
185
|
* @param expressionAttributeValues - Values for expression placeholders
|
|
174
|
-
* @param expressionAttributeNames - Optional name aliases for reserved words
|
|
186
|
+
* @param expressionAttributeNames - Optional name aliases for reserved words. **Note:** since both
|
|
187
|
+
* this param and `metadata` accept plain objects, pass `undefined` when you only need metadata.
|
|
188
|
+
* @param metadata - Optional trace metadata for diagnostics
|
|
175
189
|
* @returns The raw result from DynamoDB
|
|
176
190
|
*/
|
|
177
191
|
updateItem(
|
|
@@ -180,6 +194,7 @@ export interface DynamoDBClient extends BaseIntegrationClient {
|
|
|
180
194
|
updateExpression: string,
|
|
181
195
|
expressionAttributeValues: Record<string, DynamoDBAttributeValue>,
|
|
182
196
|
expressionAttributeNames?: Record<string, string>,
|
|
197
|
+
metadata?: TraceMetadata,
|
|
183
198
|
): Promise<unknown>;
|
|
184
199
|
|
|
185
200
|
/**
|
|
@@ -187,45 +202,56 @@ export interface DynamoDBClient extends BaseIntegrationClient {
|
|
|
187
202
|
*
|
|
188
203
|
* @param table - The table name
|
|
189
204
|
* @param key - The primary key as AttributeValue map
|
|
205
|
+
* @param metadata - Optional trace metadata for diagnostics
|
|
190
206
|
* @returns The raw result from DynamoDB
|
|
191
207
|
*/
|
|
192
208
|
deleteItem(
|
|
193
209
|
table: string,
|
|
194
210
|
key: Record<string, DynamoDBAttributeValue>,
|
|
211
|
+
metadata?: TraceMetadata,
|
|
195
212
|
): Promise<unknown>;
|
|
196
213
|
|
|
197
214
|
/**
|
|
198
215
|
* Write multiple items in a single batch.
|
|
199
216
|
*
|
|
200
217
|
* @param requestItems - Map of table names to write request arrays
|
|
218
|
+
* @param metadata - Optional trace metadata for diagnostics
|
|
201
219
|
* @returns The raw result from DynamoDB
|
|
202
220
|
*/
|
|
203
221
|
batchWriteItem(
|
|
204
222
|
requestItems: Record<string, Array<Record<string, unknown>>>,
|
|
223
|
+
metadata?: TraceMetadata,
|
|
205
224
|
): Promise<unknown>;
|
|
206
225
|
|
|
207
226
|
/**
|
|
208
227
|
* List all DynamoDB tables.
|
|
209
228
|
*
|
|
210
229
|
* @param schema - Zod schema for validating the result
|
|
230
|
+
* @param metadata - Optional trace metadata for diagnostics
|
|
211
231
|
* @returns The validated table list
|
|
212
232
|
*/
|
|
213
|
-
listTables<T>(schema: z.ZodSchema<T
|
|
233
|
+
listTables<T>(schema: z.ZodSchema<T>, metadata?: TraceMetadata): Promise<T>;
|
|
214
234
|
|
|
215
235
|
/**
|
|
216
236
|
* Describe a DynamoDB table's structure and metadata.
|
|
217
237
|
*
|
|
218
238
|
* @param table - The table name
|
|
219
239
|
* @param schema - Zod schema for validating the result
|
|
240
|
+
* @param metadata - Optional trace metadata for diagnostics
|
|
220
241
|
* @returns The validated table description
|
|
221
242
|
*/
|
|
222
|
-
describeTable<T>(
|
|
243
|
+
describeTable<T>(
|
|
244
|
+
table: string,
|
|
245
|
+
schema: z.ZodSchema<T>,
|
|
246
|
+
metadata?: TraceMetadata,
|
|
247
|
+
): Promise<T>;
|
|
223
248
|
|
|
224
249
|
/**
|
|
225
250
|
* Delete a DynamoDB table.
|
|
226
251
|
*
|
|
227
252
|
* @param table - The table name to delete
|
|
253
|
+
* @param metadata - Optional trace metadata for diagnostics
|
|
228
254
|
* @returns The raw result from DynamoDB
|
|
229
255
|
*/
|
|
230
|
-
deleteTable(table: string): Promise<unknown>;
|
|
256
|
+
deleteTable(table: string, metadata?: TraceMetadata): Promise<unknown>;
|
|
231
257
|
}
|
|
@@ -4,9 +4,9 @@ Search, index, and manage documents in Elasticsearch clusters.
|
|
|
4
4
|
|
|
5
5
|
## Methods
|
|
6
6
|
|
|
7
|
-
| Method
|
|
8
|
-
|
|
|
9
|
-
| `apiRequest(options, schema)` | Make any Elasticsearch API request with schema validation |
|
|
7
|
+
| Method | Description |
|
|
8
|
+
| ---------------------------------------- | --------------------------------------------------------- |
|
|
9
|
+
| `apiRequest(options, schema, metadata?)` | Make any Elasticsearch API request with schema validation |
|
|
10
10
|
|
|
11
11
|
## Usage
|
|
12
12
|
|
|
@@ -379,6 +379,10 @@ try {
|
|
|
379
379
|
}
|
|
380
380
|
```
|
|
381
381
|
|
|
382
|
+
## Trace Metadata
|
|
383
|
+
|
|
384
|
+
All methods accept an optional `metadata` parameter as the last argument for diagnostics labeling. See the [root SDK README](../../../README.md#trace-metadata) for details.
|
|
385
|
+
|
|
382
386
|
## Common Pitfalls
|
|
383
387
|
|
|
384
388
|
### No Specialized Methods
|
|
@@ -4,9 +4,9 @@ Interact with Fireworks AI's fast inference platform for LLM chat completions an
|
|
|
4
4
|
|
|
5
5
|
## Methods
|
|
6
6
|
|
|
7
|
-
| Method
|
|
8
|
-
|
|
|
9
|
-
| `apiRequest(options, schema)` | Make any Fireworks API request with schema validation |
|
|
7
|
+
| Method | Description |
|
|
8
|
+
| ---------------------------------------- | ----------------------------------------------------- |
|
|
9
|
+
| `apiRequest(options, schema, metadata?)` | Make any Fireworks API request with schema validation |
|
|
10
10
|
|
|
11
11
|
## Usage
|
|
12
12
|
|
|
@@ -261,6 +261,10 @@ const result = await ctx.integrations.fireworks.apiRequest(
|
|
|
261
261
|
);
|
|
262
262
|
```
|
|
263
263
|
|
|
264
|
+
## Trace Metadata
|
|
265
|
+
|
|
266
|
+
All methods accept an optional `metadata` parameter as the last argument for diagnostics labeling. See the [root SDK README](../../../README.md#trace-metadata) for details.
|
|
267
|
+
|
|
264
268
|
## Common Pitfalls
|
|
265
269
|
|
|
266
270
|
### No Specialized Methods
|
|
@@ -4,9 +4,9 @@ Manage conversations, contacts, and team inboxes with Front's collaborative emai
|
|
|
4
4
|
|
|
5
5
|
## Methods
|
|
6
6
|
|
|
7
|
-
| Method
|
|
8
|
-
|
|
|
9
|
-
| `apiRequest(options, schema)` | Make any Front API request with schema validation |
|
|
7
|
+
| Method | Description |
|
|
8
|
+
| ---------------------------------------- | ------------------------------------------------- |
|
|
9
|
+
| `apiRequest(options, schema, metadata?)` | Make any Front API request with schema validation |
|
|
10
10
|
|
|
11
11
|
## Usage
|
|
12
12
|
|
|
@@ -271,6 +271,10 @@ const result = await ctx.integrations.front.apiRequest(
|
|
|
271
271
|
);
|
|
272
272
|
```
|
|
273
273
|
|
|
274
|
+
## Trace Metadata
|
|
275
|
+
|
|
276
|
+
All methods accept an optional `metadata` parameter as the last argument for diagnostics labeling. See the [root SDK README](../../../README.md#trace-metadata) for details.
|
|
277
|
+
|
|
274
278
|
## Common Pitfalls
|
|
275
279
|
|
|
276
280
|
### No Specialized Methods
|
|
@@ -4,15 +4,15 @@ Interact with Google Cloud Storage buckets with full type safety and runtime val
|
|
|
4
4
|
|
|
5
5
|
## Methods
|
|
6
6
|
|
|
7
|
-
| Method
|
|
8
|
-
|
|
|
9
|
-
| `listBuckets(schema)` | List all buckets |
|
|
10
|
-
| `listObjects(bucket, schema, options?)` | List objects in a bucket |
|
|
11
|
-
| `getObject(bucket, path, schema, options?)` | Get an object |
|
|
12
|
-
| `deleteObject(bucket, path)` | Delete an object |
|
|
13
|
-
| `uploadObject(bucket, path, body)` | Upload a single object |
|
|
14
|
-
| `uploadMultipleObjects(bucket, fileObjects)` | Upload multiple objects |
|
|
15
|
-
| `generateSignedUrl(bucket, path, schema)` | Generate a signed URL |
|
|
7
|
+
| Method | Description |
|
|
8
|
+
| ------------------------------------------------------- | ------------------------ |
|
|
9
|
+
| `listBuckets(schema, metadata?)` | List all buckets |
|
|
10
|
+
| `listObjects(bucket, schema, options?, metadata?)` | List objects in a bucket |
|
|
11
|
+
| `getObject(bucket, path, schema, options?, metadata?)` | Get an object |
|
|
12
|
+
| `deleteObject(bucket, path, metadata?)` | Delete an object |
|
|
13
|
+
| `uploadObject(bucket, path, body, metadata?)` | Upload a single object |
|
|
14
|
+
| `uploadMultipleObjects(bucket, fileObjects, metadata?)` | Upload multiple objects |
|
|
15
|
+
| `generateSignedUrl(bucket, path, schema, metadata?)` | Generate a signed URL |
|
|
16
16
|
|
|
17
17
|
## Usage
|
|
18
18
|
|
|
@@ -104,6 +104,10 @@ const url = await ctx.integrations.storage.generateSignedUrl(
|
|
|
104
104
|
);
|
|
105
105
|
```
|
|
106
106
|
|
|
107
|
+
## Trace Metadata
|
|
108
|
+
|
|
109
|
+
All methods accept an optional `metadata` parameter as the last argument for diagnostics labeling. See the [root SDK README](../../../README.md#trace-metadata) for details.
|
|
110
|
+
|
|
107
111
|
## Common Pitfalls
|
|
108
112
|
|
|
109
113
|
### Size is Returned as String
|
|
@@ -8,7 +8,7 @@ import type { z } from "zod";
|
|
|
8
8
|
import type { PartialMessage } from "@bufbuild/protobuf";
|
|
9
9
|
import type { Plugin as GCSPlugin } from "@superblocksteam/types/dist/src/plugins/gcs/v1/plugin_pb";
|
|
10
10
|
import type { IntegrationConfig, IntegrationClientImpl } from "../types.js";
|
|
11
|
-
import type { QueryExecutor } from "../registry.js";
|
|
11
|
+
import type { QueryExecutor, TraceMetadata } from "../registry.js";
|
|
12
12
|
import { RestApiValidationError } from "../../errors.js";
|
|
13
13
|
import { IntegrationError } from "../../runtime/errors.js";
|
|
14
14
|
import type {
|
|
@@ -44,13 +44,18 @@ export class GCSClientImpl implements GCSClient, IntegrationClientImpl {
|
|
|
44
44
|
private async execute(
|
|
45
45
|
action: GCSAction,
|
|
46
46
|
request: PartialMessage<GCSPlugin>,
|
|
47
|
+
metadata?: TraceMetadata,
|
|
47
48
|
): Promise<unknown> {
|
|
48
49
|
const fullRequest: PartialMessage<GCSPlugin> = {
|
|
49
50
|
...request,
|
|
50
51
|
action,
|
|
51
52
|
};
|
|
52
53
|
|
|
53
|
-
return this.executeQuery(
|
|
54
|
+
return this.executeQuery(
|
|
55
|
+
fullRequest as Record<string, unknown>,
|
|
56
|
+
undefined,
|
|
57
|
+
metadata,
|
|
58
|
+
);
|
|
54
59
|
}
|
|
55
60
|
|
|
56
61
|
/**
|
|
@@ -97,9 +102,12 @@ export class GCSClientImpl implements GCSClient, IntegrationClientImpl {
|
|
|
97
102
|
}
|
|
98
103
|
}
|
|
99
104
|
|
|
100
|
-
async listBuckets<T>(
|
|
105
|
+
async listBuckets<T>(
|
|
106
|
+
schema: z.ZodSchema<T>,
|
|
107
|
+
metadata?: TraceMetadata,
|
|
108
|
+
): Promise<T> {
|
|
101
109
|
return this.withErrorHandling("listBuckets", async () => {
|
|
102
|
-
const result = await this.execute("LIST_BUCKETS", {});
|
|
110
|
+
const result = await this.execute("LIST_BUCKETS", {}, metadata);
|
|
103
111
|
return this.validate(result, schema, "listBuckets");
|
|
104
112
|
});
|
|
105
113
|
}
|
|
@@ -108,6 +116,7 @@ export class GCSClientImpl implements GCSClient, IntegrationClientImpl {
|
|
|
108
116
|
bucket: string,
|
|
109
117
|
schema: z.ZodSchema<T>,
|
|
110
118
|
options?: GCSListObjectsOptions,
|
|
119
|
+
metadata?: TraceMetadata,
|
|
111
120
|
): Promise<T> {
|
|
112
121
|
return this.withErrorHandling("listObjects", async () => {
|
|
113
122
|
const request: PartialMessage<GCSPlugin> = {
|
|
@@ -118,7 +127,11 @@ export class GCSClientImpl implements GCSClient, IntegrationClientImpl {
|
|
|
118
127
|
request.prefix = options.prefix;
|
|
119
128
|
}
|
|
120
129
|
|
|
121
|
-
const result = await this.execute(
|
|
130
|
+
const result = await this.execute(
|
|
131
|
+
"LIST_BUCKET_OBJECTS",
|
|
132
|
+
request,
|
|
133
|
+
metadata,
|
|
134
|
+
);
|
|
122
135
|
return this.validate(result, schema, "listObjects");
|
|
123
136
|
});
|
|
124
137
|
}
|
|
@@ -128,6 +141,7 @@ export class GCSClientImpl implements GCSClient, IntegrationClientImpl {
|
|
|
128
141
|
path: string,
|
|
129
142
|
schema: z.ZodSchema<T>,
|
|
130
143
|
options?: GCSGetObjectOptions,
|
|
144
|
+
metadata?: TraceMetadata,
|
|
131
145
|
): Promise<T> {
|
|
132
146
|
return this.withErrorHandling("getObject", async () => {
|
|
133
147
|
const request: PartialMessage<GCSPlugin> = {
|
|
@@ -139,17 +153,25 @@ export class GCSClientImpl implements GCSClient, IntegrationClientImpl {
|
|
|
139
153
|
request.responseType = options.responseType;
|
|
140
154
|
}
|
|
141
155
|
|
|
142
|
-
const result = await this.execute("GET_OBJECT", request);
|
|
156
|
+
const result = await this.execute("GET_OBJECT", request, metadata);
|
|
143
157
|
return this.validate(result, schema, "getObject");
|
|
144
158
|
});
|
|
145
159
|
}
|
|
146
160
|
|
|
147
|
-
async deleteObject(
|
|
161
|
+
async deleteObject(
|
|
162
|
+
bucket: string,
|
|
163
|
+
path: string,
|
|
164
|
+
metadata?: TraceMetadata,
|
|
165
|
+
): Promise<void> {
|
|
148
166
|
return this.withErrorHandling("deleteObject", async () => {
|
|
149
|
-
await this.execute(
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
167
|
+
await this.execute(
|
|
168
|
+
"DELETE_OBJECT",
|
|
169
|
+
{
|
|
170
|
+
resource: bucket,
|
|
171
|
+
path,
|
|
172
|
+
},
|
|
173
|
+
metadata,
|
|
174
|
+
);
|
|
153
175
|
});
|
|
154
176
|
}
|
|
155
177
|
|
|
@@ -157,25 +179,35 @@ export class GCSClientImpl implements GCSClient, IntegrationClientImpl {
|
|
|
157
179
|
bucket: string,
|
|
158
180
|
path: string,
|
|
159
181
|
body: string,
|
|
182
|
+
metadata?: TraceMetadata,
|
|
160
183
|
): Promise<void> {
|
|
161
184
|
return this.withErrorHandling("uploadObject", async () => {
|
|
162
|
-
await this.execute(
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
185
|
+
await this.execute(
|
|
186
|
+
"UPLOAD_OBJECT",
|
|
187
|
+
{
|
|
188
|
+
resource: bucket,
|
|
189
|
+
path,
|
|
190
|
+
body,
|
|
191
|
+
},
|
|
192
|
+
metadata,
|
|
193
|
+
);
|
|
167
194
|
});
|
|
168
195
|
}
|
|
169
196
|
|
|
170
197
|
async uploadMultipleObjects(
|
|
171
198
|
bucket: string,
|
|
172
199
|
fileObjects: string,
|
|
200
|
+
metadata?: TraceMetadata,
|
|
173
201
|
): Promise<void> {
|
|
174
202
|
return this.withErrorHandling("uploadMultipleObjects", async () => {
|
|
175
|
-
await this.execute(
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
203
|
+
await this.execute(
|
|
204
|
+
"UPLOAD_MULTIPLE_OBJECTS",
|
|
205
|
+
{
|
|
206
|
+
resource: bucket,
|
|
207
|
+
fileObjects,
|
|
208
|
+
},
|
|
209
|
+
metadata,
|
|
210
|
+
);
|
|
179
211
|
});
|
|
180
212
|
}
|
|
181
213
|
|
|
@@ -183,12 +215,17 @@ export class GCSClientImpl implements GCSClient, IntegrationClientImpl {
|
|
|
183
215
|
bucket: string,
|
|
184
216
|
path: string,
|
|
185
217
|
schema: z.ZodSchema<T>,
|
|
218
|
+
metadata?: TraceMetadata,
|
|
186
219
|
): Promise<T> {
|
|
187
220
|
return this.withErrorHandling("generateSignedUrl", async () => {
|
|
188
|
-
const result = await this.execute(
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
221
|
+
const result = await this.execute(
|
|
222
|
+
"GENERATE_PRESIGNED_URL",
|
|
223
|
+
{
|
|
224
|
+
resource: bucket,
|
|
225
|
+
path,
|
|
226
|
+
},
|
|
227
|
+
metadata,
|
|
228
|
+
);
|
|
192
229
|
return this.validate(result, schema, "generateSignedUrl");
|
|
193
230
|
});
|
|
194
231
|
}
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
import type { z } from "zod";
|
|
6
6
|
import type { BaseIntegrationClient } from "../../types.js";
|
|
7
|
+
import type { TraceMetadata } from "../registry.js";
|
|
7
8
|
|
|
8
9
|
/**
|
|
9
10
|
* GCS action types (used internally by the client).
|
|
@@ -72,7 +73,7 @@ export interface GCSClient extends BaseIntegrationClient {
|
|
|
72
73
|
* @param schema - Zod schema for validating the result
|
|
73
74
|
* @returns The validated bucket list
|
|
74
75
|
*/
|
|
75
|
-
listBuckets<T>(schema: z.ZodSchema<T
|
|
76
|
+
listBuckets<T>(schema: z.ZodSchema<T>, metadata?: TraceMetadata): Promise<T>;
|
|
76
77
|
|
|
77
78
|
/**
|
|
78
79
|
* List objects in a bucket.
|
|
@@ -80,12 +81,14 @@ export interface GCSClient extends BaseIntegrationClient {
|
|
|
80
81
|
* @param bucket - Bucket name
|
|
81
82
|
* @param schema - Zod schema for validating the result
|
|
82
83
|
* @param options - Optional prefix filter
|
|
84
|
+
* @param metadata - Optional trace metadata for diagnostics
|
|
83
85
|
* @returns The validated object list
|
|
84
86
|
*/
|
|
85
87
|
listObjects<T>(
|
|
86
88
|
bucket: string,
|
|
87
89
|
schema: z.ZodSchema<T>,
|
|
88
90
|
options?: GCSListObjectsOptions,
|
|
91
|
+
metadata?: TraceMetadata,
|
|
89
92
|
): Promise<T>;
|
|
90
93
|
|
|
91
94
|
/**
|
|
@@ -95,6 +98,7 @@ export interface GCSClient extends BaseIntegrationClient {
|
|
|
95
98
|
* @param path - Object path
|
|
96
99
|
* @param schema - Zod schema for validating the result
|
|
97
100
|
* @param options - Optional response type
|
|
101
|
+
* @param metadata - Optional trace metadata for diagnostics
|
|
98
102
|
* @returns The validated object content
|
|
99
103
|
*/
|
|
100
104
|
getObject<T>(
|
|
@@ -102,6 +106,7 @@ export interface GCSClient extends BaseIntegrationClient {
|
|
|
102
106
|
path: string,
|
|
103
107
|
schema: z.ZodSchema<T>,
|
|
104
108
|
options?: GCSGetObjectOptions,
|
|
109
|
+
metadata?: TraceMetadata,
|
|
105
110
|
): Promise<T>;
|
|
106
111
|
|
|
107
112
|
/**
|
|
@@ -109,8 +114,13 @@ export interface GCSClient extends BaseIntegrationClient {
|
|
|
109
114
|
*
|
|
110
115
|
* @param bucket - Bucket name
|
|
111
116
|
* @param path - Object path
|
|
117
|
+
* @param metadata - Optional trace metadata for diagnostics
|
|
112
118
|
*/
|
|
113
|
-
deleteObject(
|
|
119
|
+
deleteObject(
|
|
120
|
+
bucket: string,
|
|
121
|
+
path: string,
|
|
122
|
+
metadata?: TraceMetadata,
|
|
123
|
+
): Promise<void>;
|
|
114
124
|
|
|
115
125
|
/**
|
|
116
126
|
* Upload an object to a bucket.
|
|
@@ -118,16 +128,27 @@ export interface GCSClient extends BaseIntegrationClient {
|
|
|
118
128
|
* @param bucket - Bucket name
|
|
119
129
|
* @param path - Object path
|
|
120
130
|
* @param body - File content (base64 or text)
|
|
131
|
+
* @param metadata - Optional trace metadata for diagnostics
|
|
121
132
|
*/
|
|
122
|
-
uploadObject(
|
|
133
|
+
uploadObject(
|
|
134
|
+
bucket: string,
|
|
135
|
+
path: string,
|
|
136
|
+
body: string,
|
|
137
|
+
metadata?: TraceMetadata,
|
|
138
|
+
): Promise<void>;
|
|
123
139
|
|
|
124
140
|
/**
|
|
125
141
|
* Upload multiple objects to a bucket.
|
|
126
142
|
*
|
|
127
143
|
* @param bucket - Bucket name
|
|
128
144
|
* @param fileObjects - Serialized file objects
|
|
145
|
+
* @param metadata - Optional trace metadata for diagnostics
|
|
129
146
|
*/
|
|
130
|
-
uploadMultipleObjects(
|
|
147
|
+
uploadMultipleObjects(
|
|
148
|
+
bucket: string,
|
|
149
|
+
fileObjects: string,
|
|
150
|
+
metadata?: TraceMetadata,
|
|
151
|
+
): Promise<void>;
|
|
131
152
|
|
|
132
153
|
/**
|
|
133
154
|
* Generate a signed URL for an object.
|
|
@@ -135,11 +156,13 @@ export interface GCSClient extends BaseIntegrationClient {
|
|
|
135
156
|
* @param bucket - Bucket name
|
|
136
157
|
* @param path - Object path
|
|
137
158
|
* @param schema - Zod schema for validating the result
|
|
159
|
+
* @param metadata - Optional trace metadata for diagnostics
|
|
138
160
|
* @returns The validated signed URL
|
|
139
161
|
*/
|
|
140
162
|
generateSignedUrl<T>(
|
|
141
163
|
bucket: string,
|
|
142
164
|
path: string,
|
|
143
165
|
schema: z.ZodSchema<T>,
|
|
166
|
+
metadata?: TraceMetadata,
|
|
144
167
|
): Promise<T>;
|
|
145
168
|
}
|
|
@@ -4,9 +4,9 @@ Interact with Google's Gemini API for multimodal AI capabilities including text,
|
|
|
4
4
|
|
|
5
5
|
## Methods
|
|
6
6
|
|
|
7
|
-
| Method
|
|
8
|
-
|
|
|
9
|
-
| `apiRequest(options, schema)` | Make any Gemini API request with schema validation |
|
|
7
|
+
| Method | Description |
|
|
8
|
+
| ---------------------------------------- | -------------------------------------------------- |
|
|
9
|
+
| `apiRequest(options, schema, metadata?)` | Make any Gemini API request with schema validation |
|
|
10
10
|
|
|
11
11
|
## Usage
|
|
12
12
|
|
|
@@ -259,6 +259,10 @@ const result = await ctx.integrations.gemini.apiRequest(
|
|
|
259
259
|
console.log(`Total tokens: ${result.totalTokens}`);
|
|
260
260
|
```
|
|
261
261
|
|
|
262
|
+
## Trace Metadata
|
|
263
|
+
|
|
264
|
+
All methods accept an optional `metadata` parameter as the last argument for diagnostics labeling. See the [root SDK README](../../../README.md#trace-metadata) for details.
|
|
265
|
+
|
|
262
266
|
## Common Pitfalls
|
|
263
267
|
|
|
264
268
|
### No Specialized Methods
|
|
@@ -4,9 +4,9 @@ Manage repositories, issues, pull requests, and interact with GitHub's APIs.
|
|
|
4
4
|
|
|
5
5
|
## Methods
|
|
6
6
|
|
|
7
|
-
| Method
|
|
8
|
-
|
|
|
9
|
-
| `apiRequest(options, schema)` | Make any GitHub API request with schema validation |
|
|
7
|
+
| Method | Description |
|
|
8
|
+
| ---------------------------------------- | -------------------------------------------------- |
|
|
9
|
+
| `apiRequest(options, schema, metadata?)` | Make any GitHub API request with schema validation |
|
|
10
10
|
|
|
11
11
|
## Usage
|
|
12
12
|
|
|
@@ -283,6 +283,10 @@ await ctx.integrations.repo.apiRequest(
|
|
|
283
283
|
);
|
|
284
284
|
```
|
|
285
285
|
|
|
286
|
+
## Trace Metadata
|
|
287
|
+
|
|
288
|
+
All methods accept an optional `metadata` parameter as the last argument for diagnostics labeling. See the [root SDK README](../../../README.md#trace-metadata) for details.
|
|
289
|
+
|
|
286
290
|
## Common Pitfalls
|
|
287
291
|
|
|
288
292
|
### No Specialized Methods
|
|
@@ -4,9 +4,9 @@ Run reports, get real-time data, and interact with Google Analytics 4 properties
|
|
|
4
4
|
|
|
5
5
|
## Methods
|
|
6
6
|
|
|
7
|
-
| Method
|
|
8
|
-
|
|
|
9
|
-
| `apiRequest(options, schema)` | Make any Google Analytics API request with schema validation |
|
|
7
|
+
| Method | Description |
|
|
8
|
+
| ---------------------------------------- | ------------------------------------------------------------ |
|
|
9
|
+
| `apiRequest(options, schema, metadata?)` | Make any Google Analytics API request with schema validation |
|
|
10
10
|
|
|
11
11
|
## Usage
|
|
12
12
|
|
|
@@ -238,6 +238,10 @@ result.accountSummaries?.forEach((account) => {
|
|
|
238
238
|
});
|
|
239
239
|
```
|
|
240
240
|
|
|
241
|
+
## Trace Metadata
|
|
242
|
+
|
|
243
|
+
All methods accept an optional `metadata` parameter as the last argument for diagnostics labeling. See the [root SDK README](../../../README.md#trace-metadata) for details.
|
|
244
|
+
|
|
241
245
|
## Common Pitfalls
|
|
242
246
|
|
|
243
247
|
### No Specialized Methods
|
|
@@ -4,9 +4,9 @@ Upload, download, and manage files in Google Drive.
|
|
|
4
4
|
|
|
5
5
|
## Methods
|
|
6
6
|
|
|
7
|
-
| Method
|
|
8
|
-
|
|
|
9
|
-
| `apiRequest(options, schema)` | Make any Google Drive API request with schema validation |
|
|
7
|
+
| Method | Description |
|
|
8
|
+
| ---------------------------------------- | -------------------------------------------------------- |
|
|
9
|
+
| `apiRequest(options, schema, metadata?)` | Make any Google Drive API request with schema validation |
|
|
10
10
|
|
|
11
11
|
## Usage
|
|
12
12
|
|
|
@@ -289,6 +289,10 @@ await ctx.integrations.drive.apiRequest(
|
|
|
289
289
|
);
|
|
290
290
|
```
|
|
291
291
|
|
|
292
|
+
## Trace Metadata
|
|
293
|
+
|
|
294
|
+
All methods accept an optional `metadata` parameter as the last argument for diagnostics labeling. See the [root SDK README](../../../README.md#trace-metadata) for details.
|
|
295
|
+
|
|
292
296
|
## Common Pitfalls
|
|
293
297
|
|
|
294
298
|
### No Specialized Methods
|
|
@@ -4,10 +4,10 @@ Execute GraphQL queries and mutations against configured GraphQL endpoints with
|
|
|
4
4
|
|
|
5
5
|
## Methods
|
|
6
6
|
|
|
7
|
-
| Method
|
|
8
|
-
|
|
|
9
|
-
| `query<T>(query, schema, variables?)` | Execute a GraphQL query with required schema validation |
|
|
10
|
-
| `mutation<T>(mutation, schema, variables?)` | Execute a GraphQL mutation with required schema validation |
|
|
7
|
+
| Method | Description |
|
|
8
|
+
| ------------------------------------------------------ | ---------------------------------------------------------- |
|
|
9
|
+
| `query<T>(query, schema, variables?, metadata?)` | Execute a GraphQL query with required schema validation |
|
|
10
|
+
| `mutation<T>(mutation, schema, variables?, metadata?)` | Execute a GraphQL mutation with required schema validation |
|
|
11
11
|
|
|
12
12
|
## Usage
|
|
13
13
|
|
|
@@ -196,6 +196,10 @@ const UserProfileResponseSchema = z.object({
|
|
|
196
196
|
});
|
|
197
197
|
```
|
|
198
198
|
|
|
199
|
+
## Trace Metadata
|
|
200
|
+
|
|
201
|
+
All methods accept an optional `metadata` parameter as the last argument for diagnostics labeling. See the [root SDK README](../../../README.md#trace-metadata) for details.
|
|
202
|
+
|
|
199
203
|
## Common Pitfalls
|
|
200
204
|
|
|
201
205
|
### Response Must Include `data` Wrapper
|