From 26f9503e5b7952e273fff4c517d55e4fee6b8742 Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Wed, 13 Mar 2024 07:31:10 +0000 Subject: [PATCH] chore: generated code for commit c324c06b. [skip ci] https://github.com/algolia/api-clients-automation/commit/c324c06bd3aa095f8d1b709d40f86446abe0d132 Co-authored-by: algolia-bot Co-authored-by: Jason Berry --- packages/ingestion/model/actionType.ts | 2 +- packages/ingestion/model/clientMethodProps.ts | 4 ++-- packages/ingestion/model/index.ts | 4 ++++ .../ingestion/model/sourceGA4BigQueryExport.ts | 18 ++++++++++++++++++ packages/ingestion/model/sourceInput.ts | 2 ++ packages/ingestion/model/sourceType.ts | 1 + packages/ingestion/model/sourceUpdateInput.ts | 2 ++ packages/ingestion/model/streamingTrigger.ts | 10 ++++++++++ .../ingestion/model/streamingTriggerType.ts | 6 ++++++ .../ingestion/model/streamingUtilsInput.ts | 10 ++++++++++ packages/ingestion/model/taskCreateTrigger.ts | 2 ++ packages/ingestion/model/taskInput.ts | 6 +++++- packages/ingestion/model/trigger.ts | 7 ++++++- packages/ingestion/model/triggerType.ts | 8 ++++++-- packages/ingestion/src/ingestionClient.ts | 4 ++-- 15 files changed, 77 insertions(+), 9 deletions(-) create mode 100644 packages/ingestion/model/sourceGA4BigQueryExport.ts create mode 100644 packages/ingestion/model/streamingTrigger.ts create mode 100644 packages/ingestion/model/streamingTriggerType.ts create mode 100644 packages/ingestion/model/streamingUtilsInput.ts diff --git a/packages/ingestion/model/actionType.ts b/packages/ingestion/model/actionType.ts index 3184f4fe5..14a979b66 100644 --- a/packages/ingestion/model/actionType.ts +++ b/packages/ingestion/model/actionType.ts @@ -3,4 +3,4 @@ /** * The action to perform on the Algolia index. */ -export type ActionType = 'partial' | 'replace' | 'save'; +export type ActionType = 'append' | 'partial' | 'replace' | 'save'; diff --git a/packages/ingestion/model/clientMethodProps.ts b/packages/ingestion/model/clientMethodProps.ts index 966b6ba2b..aa9337ea1 100644 --- a/packages/ingestion/model/clientMethodProps.ts +++ b/packages/ingestion/model/clientMethodProps.ts @@ -410,11 +410,11 @@ export type GetTasksProps = { */ enabled?: boolean; /** - * The sourceIDs of the tasks to retrive. + * The sourceIDs of the tasks to retrieve. */ sourceID?: string[]; /** - * The destinationIDs of the tasks to retrive. + * The destinationIDs of the tasks to retrieve. */ destinationID?: string[]; /** diff --git a/packages/ingestion/model/index.ts b/packages/ingestion/model/index.ts index 25859e7e4..814d3ec9f 100644 --- a/packages/ingestion/model/index.ts +++ b/packages/ingestion/model/index.ts @@ -87,6 +87,7 @@ export * from './sourceCommercetools'; export * from './sourceCreate'; export * from './sourceCreateResponse'; export * from './sourceDocker'; +export * from './sourceGA4BigQueryExport'; export * from './sourceInput'; export * from './sourceJSON'; export * from './sourceSearch'; @@ -97,6 +98,9 @@ export * from './sourceUpdateCommercetools'; export * from './sourceUpdateDocker'; export * from './sourceUpdateInput'; export * from './sourceUpdateResponse'; +export * from './streamingTrigger'; +export * from './streamingTriggerType'; +export * from './streamingUtilsInput'; export * from './subscriptionTrigger'; export * from './subscriptionTriggerType'; export * from './task'; diff --git a/packages/ingestion/model/sourceGA4BigQueryExport.ts b/packages/ingestion/model/sourceGA4BigQueryExport.ts new file mode 100644 index 000000000..6df725550 --- /dev/null +++ b/packages/ingestion/model/sourceGA4BigQueryExport.ts @@ -0,0 +1,18 @@ +// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT. + +export type SourceGA4BigQueryExport = { + /** + * GCP project ID that the BigQuery Export writes to. + */ + projectID: string; + + /** + * BigQuery dataset ID that the BigQuery Export writes to. + */ + datasetID: string; + + /** + * Prefix of the tables that the BigQuery Export writes to (i.e. Events_intraday_ for streaming, events_ for daily). + */ + tablePrefix: string; +}; diff --git a/packages/ingestion/model/sourceInput.ts b/packages/ingestion/model/sourceInput.ts index baf9eba1f..a46b168e5 100644 --- a/packages/ingestion/model/sourceInput.ts +++ b/packages/ingestion/model/sourceInput.ts @@ -5,6 +5,7 @@ import type { SourceBigQuery } from './sourceBigQuery'; import type { SourceCSV } from './sourceCSV'; import type { SourceCommercetools } from './sourceCommercetools'; import type { SourceDocker } from './sourceDocker'; +import type { SourceGA4BigQueryExport } from './sourceGA4BigQueryExport'; import type { SourceJSON } from './sourceJSON'; export type SourceInput = @@ -13,4 +14,5 @@ export type SourceInput = | SourceCommercetools | SourceCSV | SourceDocker + | SourceGA4BigQueryExport | SourceJSON; diff --git a/packages/ingestion/model/sourceType.ts b/packages/ingestion/model/sourceType.ts index 8e8429779..adb0c3e39 100644 --- a/packages/ingestion/model/sourceType.ts +++ b/packages/ingestion/model/sourceType.ts @@ -6,4 +6,5 @@ export type SourceType = | 'commercetools' | 'csv' | 'docker' + | 'ga4BigqueryExport' | 'json'; diff --git a/packages/ingestion/model/sourceUpdateInput.ts b/packages/ingestion/model/sourceUpdateInput.ts index 6d279026c..206544a3b 100644 --- a/packages/ingestion/model/sourceUpdateInput.ts +++ b/packages/ingestion/model/sourceUpdateInput.ts @@ -2,6 +2,7 @@ import type { SourceBigQuery } from './sourceBigQuery'; import type { SourceCSV } from './sourceCSV'; +import type { SourceGA4BigQueryExport } from './sourceGA4BigQueryExport'; import type { SourceJSON } from './sourceJSON'; import type { SourceUpdateCommercetools } from './sourceUpdateCommercetools'; import type { SourceUpdateDocker } from './sourceUpdateDocker'; @@ -9,6 +10,7 @@ import type { SourceUpdateDocker } from './sourceUpdateDocker'; export type SourceUpdateInput = | SourceBigQuery | SourceCSV + | SourceGA4BigQueryExport | SourceJSON | SourceUpdateCommercetools | SourceUpdateDocker; diff --git a/packages/ingestion/model/streamingTrigger.ts b/packages/ingestion/model/streamingTrigger.ts new file mode 100644 index 000000000..f7bf38dbd --- /dev/null +++ b/packages/ingestion/model/streamingTrigger.ts @@ -0,0 +1,10 @@ +// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT. + +import type { StreamingTriggerType } from './streamingTriggerType'; + +/** + * The trigger input for a task of type \'streaming\'. + */ +export type StreamingTrigger = { + type: StreamingTriggerType; +}; diff --git a/packages/ingestion/model/streamingTriggerType.ts b/packages/ingestion/model/streamingTriggerType.ts new file mode 100644 index 000000000..0c505aa4e --- /dev/null +++ b/packages/ingestion/model/streamingTriggerType.ts @@ -0,0 +1,6 @@ +// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT. + +/** + * A task that runs continuously. + */ +export type StreamingTriggerType = 'streaming'; diff --git a/packages/ingestion/model/streamingUtilsInput.ts b/packages/ingestion/model/streamingUtilsInput.ts new file mode 100644 index 000000000..93e710ce9 --- /dev/null +++ b/packages/ingestion/model/streamingUtilsInput.ts @@ -0,0 +1,10 @@ +// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT. + +import type { MappingInput } from './mappingInput'; + +/** + * The input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed. + */ +export type StreamingUtilsInput = { + mapping: MappingInput; +}; diff --git a/packages/ingestion/model/taskCreateTrigger.ts b/packages/ingestion/model/taskCreateTrigger.ts index cce199c84..40f2625b3 100644 --- a/packages/ingestion/model/taskCreateTrigger.ts +++ b/packages/ingestion/model/taskCreateTrigger.ts @@ -2,9 +2,11 @@ import type { OnDemandTriggerInput } from './onDemandTriggerInput'; import type { ScheduleTriggerInput } from './scheduleTriggerInput'; +import type { StreamingTrigger } from './streamingTrigger'; import type { SubscriptionTrigger } from './subscriptionTrigger'; export type TaskCreateTrigger = | OnDemandTriggerInput | ScheduleTriggerInput + | StreamingTrigger | SubscriptionTrigger; diff --git a/packages/ingestion/model/taskInput.ts b/packages/ingestion/model/taskInput.ts index bcbfa2a88..02397086b 100644 --- a/packages/ingestion/model/taskInput.ts +++ b/packages/ingestion/model/taskInput.ts @@ -2,5 +2,9 @@ import type { OnDemandDateUtilsInput } from './onDemandDateUtilsInput'; import type { ScheduleDateUtilsInput } from './scheduleDateUtilsInput'; +import type { StreamingUtilsInput } from './streamingUtilsInput'; -export type TaskInput = OnDemandDateUtilsInput | ScheduleDateUtilsInput; +export type TaskInput = + | OnDemandDateUtilsInput + | ScheduleDateUtilsInput + | StreamingUtilsInput; diff --git a/packages/ingestion/model/trigger.ts b/packages/ingestion/model/trigger.ts index 01246dae0..ff4e2ffb2 100644 --- a/packages/ingestion/model/trigger.ts +++ b/packages/ingestion/model/trigger.ts @@ -2,6 +2,11 @@ import type { OnDemandTrigger } from './onDemandTrigger'; import type { ScheduleTrigger } from './scheduleTrigger'; +import type { StreamingTrigger } from './streamingTrigger'; import type { SubscriptionTrigger } from './subscriptionTrigger'; -export type Trigger = OnDemandTrigger | ScheduleTrigger | SubscriptionTrigger; +export type Trigger = + | OnDemandTrigger + | ScheduleTrigger + | StreamingTrigger + | SubscriptionTrigger; diff --git a/packages/ingestion/model/triggerType.ts b/packages/ingestion/model/triggerType.ts index bbc23b79b..bc2f08a7b 100644 --- a/packages/ingestion/model/triggerType.ts +++ b/packages/ingestion/model/triggerType.ts @@ -1,6 +1,10 @@ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT. /** - * The type of the task reflect how it can be used: - onDemand: a task that runs manually - schedule: a task that runs regularly, following a given cron expression - subscription: a task that runs after a subscription event is received from an integration (e.g. Webhook). + * The type of the task reflect how it can be used: - onDemand: a task that runs manually - schedule: a task that runs regularly, following a given cron expression - subscription: a task that runs after a subscription event is received from an integration (e.g. Webhook). - streaming: a task that runs continuously. */ -export type TriggerType = 'onDemand' | 'schedule' | 'subscription'; +export type TriggerType = + | 'onDemand' + | 'schedule' + | 'streaming' + | 'subscription'; diff --git a/packages/ingestion/src/ingestionClient.ts b/packages/ingestion/src/ingestionClient.ts index 53ffaeacf..0ec2a80ee 100644 --- a/packages/ingestion/src/ingestionClient.ts +++ b/packages/ingestion/src/ingestionClient.ts @@ -1418,8 +1418,8 @@ export function createIngestionClient({ * @param getTasks.page - The page number to fetch, starting at 1. * @param getTasks.action - The action of the tasks to retrieve. * @param getTasks.enabled - Whether the task is enabled or not. - * @param getTasks.sourceID - The sourceIDs of the tasks to retrive. - * @param getTasks.destinationID - The destinationIDs of the tasks to retrive. + * @param getTasks.sourceID - The sourceIDs of the tasks to retrieve. + * @param getTasks.destinationID - The destinationIDs of the tasks to retrieve. * @param getTasks.triggerType - The trigger type of the task. * @param getTasks.sort - The key by which the list should be sorted. * @param getTasks.order - The order of the returned list.