algoliasearch-scala
API
Generated with
algoliasearch-scala/algoliasearch/algoliasearch.ingestion

algoliasearch.ingestion

package algoliasearch.ingestion

Members list

Type members

Classlikes

sealed trait ActionType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Append.type
object Partial.type
object Replace.type
object Save.type
object ActionType

Action to perform on the Algolia index.

Action to perform on the Algolia index.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ActionType.type
class ActionTypeSerializer extends CustomSerializer[ActionType]

Attributes

Supertypes
class CustomSerializer[ActionType]
trait Serializer[ActionType]
class Object
trait Matchable
class Any
case class AuthAPIKey(key: String) extends AuthInputTrait

Credentials for authenticating with an API key.

Credentials for authenticating with an API key.

Value parameters

key

API key. This field is null in the API response.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AuthInput
class Object
trait Matchable
class Any
Show all
case class AuthAPIKeyPartial(key: Option[String]) extends AuthInputPartialTrait

Credentials for authenticating with an API key.

Credentials for authenticating with an API key.

Value parameters

key

API key. This field is null in the API response.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AuthAlgolia(appID: String, apiKey: String) extends AuthInputTrait

Credentials for authenticating with Algolia.

Credentials for authenticating with Algolia.

Value parameters

apiKey

Algolia API key with the ACL: addObject, deleteObject, settings, editSettings, listIndexes, deleteIndex. This field is null in the API response.

appID

Algolia application ID.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AuthInput
class Object
trait Matchable
class Any
Show all
case class AuthAlgoliaInsights(appID: String, apiKey: String) extends AuthInputTrait

Credentials for authenticating with the Algolia Insights API.

Credentials for authenticating with the Algolia Insights API.

Value parameters

apiKey

Algolia API key with the ACL: search. This field is null in the API response.

appID

Algolia application ID.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AuthInput
class Object
trait Matchable
class Any
Show all
case class AuthAlgoliaInsightsPartial(appID: Option[String], apiKey: Option[String]) extends AuthInputPartialTrait

Credentials for authenticating with the Algolia Insights API.

Credentials for authenticating with the Algolia Insights API.

Value parameters

apiKey

Algolia API key with the ACL: search. This field is null in the API response.

appID

Algolia application ID.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AuthAlgoliaPartial(appID: Option[String], apiKey: Option[String]) extends AuthInputPartialTrait

Credentials for authenticating with Algolia.

Credentials for authenticating with Algolia.

Value parameters

apiKey

Algolia API key with the ACL: addObject, deleteObject, settings, editSettings, listIndexes, deleteIndex. This field is null in the API response.

appID

Algolia application ID.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AuthBasic(username: String, password: String) extends AuthInputTrait

Credentials for authenticating with user name and password.

Credentials for authenticating with user name and password.

Value parameters

password

Password. This field is null in the API response.

username

Username.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AuthInput
class Object
trait Matchable
class Any
Show all
case class AuthBasicPartial(username: Option[String], password: Option[String]) extends AuthInputPartialTrait

Credentials for authenticating with user name and password.

Credentials for authenticating with user name and password.

Value parameters

password

Password. This field is null in the API response.

username

Username.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AuthGoogleServiceAccount(clientEmail: String, privateKey: String) extends AuthInputTrait

Credentials for authenticating with a Google service account, such as BigQuery.

Credentials for authenticating with a Google service account, such as BigQuery.

Value parameters

clientEmail

Email address of the Google service account.

privateKey

Private key of the Google service account. This field is null in the API response.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AuthInput
class Object
trait Matchable
class Any
Show all
case class AuthGoogleServiceAccountPartial(clientEmail: Option[String], privateKey: Option[String]) extends AuthInputPartialTrait

Credentials for authenticating with a Google service account, such as BigQuery.

Credentials for authenticating with a Google service account, such as BigQuery.

Value parameters

clientEmail

Email address of the Google service account.

privateKey

Private key of the Google service account. This field is null in the API response.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait AuthInput

AuthInput

AuthInput

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AuthAPIKey
class AuthAlgolia
class AuthBasic
class AuthOAuth
Show all
object AuthInput

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
AuthInput.type
sealed trait AuthInputPartial

AuthInputPartial

AuthInputPartial

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
Show all
object AuthInputPartial

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object AuthInputPartialSerializer extends Serializer[AuthInputPartial]

Attributes

Supertypes
trait Serializer[AuthInputPartial]
class Object
trait Matchable
class Any
Self type
trait AuthInputPartialTrait extends AuthInputPartial

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
Show all
object AuthInputSerializer extends Serializer[AuthInput]

Attributes

Supertypes
trait Serializer[AuthInput]
class Object
trait Matchable
class Any
Self type
trait AuthInputTrait extends AuthInput

Attributes

Supertypes
trait AuthInput
class Object
trait Matchable
class Any
Known subtypes
class AuthAPIKey
class AuthAlgolia
class AuthBasic
class AuthOAuth
Show all
case class AuthOAuth(url: String, client_id: String, client_secret: String, scope: Option[String]) extends AuthInputTrait

Credentials for authenticating with OAuth 2.0.

Credentials for authenticating with OAuth 2.0.

Value parameters

client_id

Client ID.

client_secret

Client secret. This field is null in the API response.

scope

OAuth scope.

url

URL for the OAuth endpoint.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait AuthInput
class Object
trait Matchable
class Any
Show all
case class AuthOAuthPartial(url: Option[String], client_id: Option[String], client_secret: Option[String], scope: Option[String]) extends AuthInputPartialTrait

Credentials for authenticating with OAuth 2.0.

Credentials for authenticating with OAuth 2.0.

Value parameters

client_id

Client ID.

client_secret

Client secret. This field is null in the API response.

scope

OAuth scope.

url

URL for the OAuth endpoint.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Authentication(authenticationID: String, `type`: AuthenticationType, name: String, platform: Option[Platform], input: AuthInputPartial, createdAt: String, updatedAt: Option[String])

Resource representing the information required to authenticate with a source or a destination.

Resource representing the information required to authenticate with a source or a destination.

Value parameters

authenticationID

Universally unique identifier (UUID) of an authentication resource.

createdAt

Date of creation in RFC3339 format.

name

Descriptive name for the resource.

updatedAt

Date of last update in RFC3339 format.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AuthenticationCreate(`type`: AuthenticationType, name: String, platform: Option[Platform], input: AuthInput)

Request body for creating a new authentication resource.

Request body for creating a new authentication resource.

Value parameters

name

Descriptive name for the resource.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AuthenticationCreateResponse(authenticationID: String, name: String, createdAt: String)

API response for the successful creation of an authentication resource.

API response for the successful creation of an authentication resource.

Value parameters

authenticationID

Universally unique identifier (UUID) of an authentication resource.

createdAt

Date of creation in RFC3339 format.

name

Descriptive name for the resource.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AuthenticationSearch(authenticationIDs: Seq[String])

Request body for searching for authentication resources.

Request body for searching for authentication resources.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait AuthenticationSortKeys

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AuthType.type
object CreatedAt.type
object Name.type
object Platform.type
object UpdatedAt.type
object AuthenticationSortKeys

Property by which to sort the list of authentication resources.

Property by which to sort the list of authentication resources.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class AuthenticationSortKeysSerializer extends CustomSerializer[AuthenticationSortKeys]

Attributes

Supertypes
class CustomSerializer[AuthenticationSortKeys]
trait Serializer[AuthenticationSortKeys]
class Object
trait Matchable
class Any
sealed trait AuthenticationType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Algolia.type
object AlgoliaInsights.type
object ApiKey.type
object Basic.type
object GoogleServiceAccount.type
object Oauth.type
Show all
object AuthenticationType

Type of authentication. This determines the type of credentials required in the input object.

Type of authentication. This determines the type of credentials required in the input object.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class AuthenticationTypeSerializer extends CustomSerializer[AuthenticationType]

Attributes

Supertypes
class CustomSerializer[AuthenticationType]
trait Serializer[AuthenticationType]
class Object
trait Matchable
class Any
case class AuthenticationUpdate(`type`: Option[AuthenticationType], name: Option[String], platform: Option[Platform], input: Option[AuthInputPartial])

Request body for updating an authentication resource.

Request body for updating an authentication resource.

Value parameters

name

Descriptive name for the resource.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class AuthenticationUpdateResponse(authenticationID: String, name: String, updatedAt: String)

API response for a successful update of an authentication resource.

API response for a successful update of an authentication resource.

Value parameters

authenticationID

Universally unique identifier (UUID) of an authentication resource.

name

Descriptive name for the resource.

updatedAt

Date of last update in RFC3339 format.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class BigCommerceChannel(id: Int, currencies: Option[Seq[String]])

BigCommerceChannel

BigCommerceChannel

Value parameters

currencies

Currencies for the given channel.

id

ID of the BigCommerce channel.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class BigCommerceMetafield(namespace: String, key: String)

BigCommerceMetafield

BigCommerceMetafield

Value parameters

key

Key identifier of the metafield.

namespace

Namespace of the metafield.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait BigQueryDataType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Ga360.type
object Ga4.type
object BigQueryDataType

BigQueryDataType enumeration

BigQueryDataType enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class BigQueryDataTypeSerializer extends CustomSerializer[BigQueryDataType]

Attributes

Supertypes
class CustomSerializer[BigQueryDataType]
trait Serializer[BigQueryDataType]
class Object
trait Matchable
class Any
case class CommercetoolsCustomFields(inventory: Option[Seq[String]], price: Option[Seq[String]], category: Option[Seq[String]])

Custom fields from commercetools to add to the records. For more information, see Using Custom Types and Custom Fields.

Custom fields from commercetools to add to the records. For more information, see Using Custom Types and Custom Fields.

Value parameters

category

Category custom fields.

inventory

Inventory custom fields.

price

Price custom fields.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DeleteResponse(deletedAt: String)

DeleteResponse

DeleteResponse

Value parameters

deletedAt

Date of deletion in RFC3339 format.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Destination(destinationID: String, `type`: DestinationType, name: String, input: DestinationInput, createdAt: String, updatedAt: Option[String], authenticationID: Option[String])

Destinations are Algolia resources like indices or event streams.

Destinations are Algolia resources like indices or event streams.

Value parameters

authenticationID

Universally unique identifier (UUID) of an authentication resource.

createdAt

Date of creation in RFC3339 format.

destinationID

Universally unique identifier (UUID) of a destination resource.

name

Descriptive name for the resource.

updatedAt

Date of last update in RFC3339 format.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DestinationCreate(`type`: DestinationType, name: String, input: DestinationInput, authenticationID: Option[String])

API request body for creating a new destination.

API request body for creating a new destination.

Value parameters

authenticationID

Universally unique identifier (UUID) of an authentication resource.

name

Descriptive name for the resource.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DestinationCreateResponse(destinationID: String, name: String, createdAt: String)

API response for creating a new destination.

API response for creating a new destination.

Value parameters

createdAt

Date of creation in RFC3339 format.

destinationID

Universally unique identifier (UUID) of a destination resource.

name

Descriptive name for the resource.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DestinationIndexName(indexName: String, recordType: Option[RecordType], attributesToExclude: Option[Seq[String]]) extends DestinationInputTrait

DestinationIndexName

DestinationIndexName

Value parameters

attributesToExclude

Attributes from your source to exclude from Algolia records. Not all your data attributes will be useful for searching. Keeping your Algolia records small increases indexing and search performance. - Exclude nested attributes with . notation. For example, foo.bar indexes the foo attribute and all its children except the bar attribute. - Exclude attributes from arrays with [i], where i is the index of the array element. For example, foo.[0].bar only excludes the bar attribute from the first element of the foo array, but indexes the complete foo attribute for all other elements. Use * as wildcard: foo.[*].bar excludes bar from all elements of the foo array.

indexName

Algolia index name (case-sensitive).

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DestinationIndexPrefix(indexPrefix: String) extends DestinationInputTrait

DestinationIndexPrefix

DestinationIndexPrefix

Value parameters

indexPrefix

String added to the beginning of all indices created by this destination.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait DestinationInput

DestinationInput

DestinationInput

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object DestinationInput

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object DestinationInputSerializer extends Serializer[DestinationInput]

Attributes

Supertypes
trait Serializer[DestinationInput]
class Object
trait Matchable
class Any
Self type
trait DestinationInputTrait extends DestinationInput

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class DestinationSearch(destinationIDs: Seq[String])

API request body for searching destinations.

API request body for searching destinations.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait DestinationSortKeys

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CreatedAt.type
object Name.type
object Type.type
object UpdatedAt.type
object DestinationSortKeys

Property by which to sort the destinations.

Property by which to sort the destinations.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class DestinationSortKeysSerializer extends CustomSerializer[DestinationSortKeys]

Attributes

Supertypes
class CustomSerializer[DestinationSortKeys]
trait Serializer[DestinationSortKeys]
class Object
trait Matchable
class Any
sealed trait DestinationType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Insights.type
object Search.type
object DestinationType

Destination type. - search. Data is stored in an Algolia index. - insights. Data is recorded as user events in the Insights API.

Destination type. - search. Data is stored in an Algolia index. - insights. Data is recorded as user events in the Insights API.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class DestinationTypeSerializer extends CustomSerializer[DestinationType]

Attributes

Supertypes
class CustomSerializer[DestinationType]
trait Serializer[DestinationType]
class Object
trait Matchable
class Any
case class DestinationUpdate(`type`: Option[DestinationType], name: Option[String], input: Option[DestinationInput], authenticationID: Option[String])

API request body for updating a destination.

API request body for updating a destination.

Value parameters

authenticationID

Universally unique identifier (UUID) of an authentication resource.

name

Descriptive name for the resource.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DestinationUpdateResponse(destinationID: String, name: String, updatedAt: String)

API response for updating a destination.

API response for updating a destination.

Value parameters

destinationID

Universally unique identifier (UUID) of a destination resource.

name

Descriptive name for the resource.

updatedAt

Date of last update in RFC3339 format.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait DockerImageType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Airbyte.type
object Custom.type
object Singer.type
object DockerImageType

Image type.

Image type.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class DockerImageTypeSerializer extends CustomSerializer[DockerImageType]

Attributes

Supertypes
class CustomSerializer[DockerImageType]
trait Serializer[DockerImageType]
class Object
trait Matchable
class Any
sealed trait DockerRegistry

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Dockerhub.type
object Ghcr.type
object DockerRegistry

Container registry name from where to pull the image.

Container registry name from where to pull the image.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class DockerRegistrySerializer extends CustomSerializer[DockerRegistry]

Attributes

Supertypes
class CustomSerializer[DockerRegistry]
trait Serializer[DockerRegistry]
class Object
trait Matchable
class Any
case class DockerSourceDiscover(runID: String, createdAt: String)

DockerSourceDiscover

DockerSourceDiscover

Value parameters

createdAt

Date of creation in RFC3339 format.

runID

Universally unique identifier (UUID) of a task run.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class DockerSourceStreams(streams: Seq[Any])

DockerSourceStreams

DockerSourceStreams

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ErrorBase(message: Option[String], additionalProperties: Option[List[JField]])

Error.

Error.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class ErrorBaseSerializer extends Serializer[ErrorBase]

Attributes

Supertypes
trait Serializer[ErrorBase]
class Object
trait Matchable
class Any
case class Event(eventID: String, runID: String, parentID: Option[String], status: EventStatus, `type`: EventType, batchSize: Int, data: Option[Map[String, Any]], publishedAt: String)

An event describe a step of the task execution flow..

An event describe a step of the task execution flow..

Value parameters

batchSize

The extracted record batch size.

eventID

Universally unique identifier (UUID) of an event.

parentID

The parent event, the cause of this event.

publishedAt

Date of publish RFC3339 format.

runID

Universally unique identifier (UUID) of a task run.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait EventSortKeys

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object PublishedAt.type
object Status.type
object Type.type
object EventSortKeys

Property by which to sort the list of task run events.

Property by which to sort the list of task run events.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class EventSortKeysSerializer extends CustomSerializer[EventSortKeys]

Attributes

Supertypes
class CustomSerializer[EventSortKeys]
trait Serializer[EventSortKeys]
class Object
trait Matchable
class Any
sealed trait EventStatus

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Created.type
object Critical.type
object Failed.type
object Retried.type
object Started.type
object Succeeded.type
Show all
object EventStatus

EventStatus enumeration

EventStatus enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class EventStatusSerializer extends CustomSerializer[EventStatus]

Attributes

Supertypes
class CustomSerializer[EventStatus]
trait Serializer[EventStatus]
class Object
trait Matchable
class Any
sealed trait EventType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Fetch.type
object Log.type
object Record.type
object Transform.type
object EventType

EventType enumeration

EventType enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
EventType.type
class EventTypeSerializer extends CustomSerializer[EventType]

Attributes

Supertypes
class CustomSerializer[EventType]
trait Serializer[EventType]
class Object
trait Matchable
class Any
object JsonSupport

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class ListAuthenticationsResponse(authentications: Seq[Authentication], pagination: Pagination)

ListAuthenticationsResponse

ListAuthenticationsResponse

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ListDestinationsResponse(destinations: Seq[Destination], pagination: Pagination)

ListDestinationsResponse

ListDestinationsResponse

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ListEventsResponse(events: Seq[Event], pagination: Pagination, window: Window)

ListEventsResponse

ListEventsResponse

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ListSourcesResponse(sources: Seq[Source], pagination: Pagination)

ListSourcesResponse

ListSourcesResponse

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ListTasksResponse(tasks: Seq[Task], pagination: Pagination)

Configured tasks and pagination information.

Configured tasks and pagination information.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class MappingFieldDirective(fieldKey: String, value: Map[String, Any])

Describes how a field should be resolved by applying a set of directives.

Describes how a field should be resolved by applying a set of directives.

Value parameters

fieldKey

Destination field key.

value

How the destination field should be resolved from the source.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait MappingFormatSchema

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object MappingkitV1.type
object MappingFormatSchema

Mapping format schema.

Mapping format schema.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class MappingFormatSchemaSerializer extends CustomSerializer[MappingFormatSchema]

Attributes

Supertypes
class CustomSerializer[MappingFormatSchema]
trait Serializer[MappingFormatSchema]
class Object
trait Matchable
class Any
case class MappingInput(format: MappingFormatSchema, actions: Seq[MappingKitAction])

Transformations to apply to the source, serialized as a JSON string.

Transformations to apply to the source, serialized as a JSON string.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class MappingKitAction(id: Option[String], enabled: Boolean, trigger: String, fieldDirectives: Seq[MappingFieldDirective])

Describes how a destination object should be resolved by means of applying a set of directives.

Describes how a destination object should be resolved by means of applying a set of directives.

Value parameters

enabled

Whether this action has any effect.

id

ID to uniquely identify this action.

trigger

Condition which must be satisfied to apply the action. If this evaluates to false, the action is not applied, and the process attempts to apply the next action, if any.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait MappingTypeCSV

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Boolean.type
object Float.type
object Integer.type
object Json.type
object String.type
object MappingTypeCSV

MappingTypeCSV enumeration

MappingTypeCSV enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class MappingTypeCSVSerializer extends CustomSerializer[MappingTypeCSV]

Attributes

Supertypes
class CustomSerializer[MappingTypeCSV]
trait Serializer[MappingTypeCSV]
class Object
trait Matchable
class Any
sealed trait MethodType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object GET.type
object POST.type
object MethodType

HTTP method to be used for retrieving your data.

HTTP method to be used for retrieving your data.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
MethodType.type
class MethodTypeSerializer extends CustomSerializer[MethodType]

Attributes

Supertypes
class CustomSerializer[MethodType]
trait Serializer[MethodType]
class Object
trait Matchable
class Any
case class OnDemandDateUtilsInput(startDate: String, endDate: String, mapping: Option[MappingInput]) extends TaskInputTrait

Input for a manually-triggered task whose source is of type bigquery and for which extracted data spans a given time range.

Input for a manually-triggered task whose source is of type bigquery and for which extracted data spans a given time range.

Value parameters

endDate

Latest date in RFC3339 format of the extracted data from Big Query.

startDate

Earliest date in RFC3339 format of the extracted data from Big Query.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TaskInput
class Object
trait Matchable
class Any
Show all
case class OnDemandTrigger(`type`: OnDemandTriggerType, lastRun: Option[String]) extends TriggerTrait

Trigger information for manually-triggered tasks.

Trigger information for manually-triggered tasks.

Value parameters

lastRun

The last time the scheduled task ran in RFC3339 format.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TriggerTrait
trait Trigger
class Object
trait Matchable
class Any
Show all
case class OnDemandTriggerInput(`type`: OnDemandTriggerType) extends TaskCreateTriggerTrait

Trigger information for manually-triggered tasks.

Trigger information for manually-triggered tasks.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait OnDemandTriggerType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object OnDemand.type
object OnDemandTriggerType

Task is run manually, with the /run endpoint.

Task is run manually, with the /run endpoint.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class OnDemandTriggerTypeSerializer extends CustomSerializer[OnDemandTriggerType]

Attributes

Supertypes
class CustomSerializer[OnDemandTriggerType]
trait Serializer[OnDemandTriggerType]
class Object
trait Matchable
class Any
sealed trait OrderKeys

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Asc.type
object Desc.type
object OrderKeys

Ascending or descending sort order.

Ascending or descending sort order.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
OrderKeys.type
class OrderKeysSerializer extends CustomSerializer[OrderKeys]

Attributes

Supertypes
class CustomSerializer[OrderKeys]
trait Serializer[OrderKeys]
class Object
trait Matchable
class Any
case class Pagination(nbPages: Int, page: Int, nbItems: Int, itemsPerPage: Int)

Paginated API response.

Paginated API response.

Value parameters

itemsPerPage

Number of items per page.

nbItems

Number of items in the API response.

nbPages

Number of pages in the API response.

page

Page of the API response to retrieve.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait Platform extends PlatformWithNoneTrait

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Bigcommerce.type
object Commercetools.type
object Shopify.type
object Platform

Name of an ecommerce platform with which to authenticate. This determines which authentication type you can select.

Name of an ecommerce platform with which to authenticate. This determines which authentication type you can select.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Platform.type
sealed trait PlatformNone extends PlatformWithNoneTrait

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object None.type
object PlatformNone

Authentication resource not tied to any ecommerce platform, used for filtering.

Authentication resource not tied to any ecommerce platform, used for filtering.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class PlatformNoneSerializer extends CustomSerializer[PlatformNone]

Attributes

Supertypes
class CustomSerializer[PlatformNone]
trait Serializer[PlatformNone]
class Object
trait Matchable
class Any
class PlatformSerializer extends CustomSerializer[Platform]

Attributes

Supertypes
class CustomSerializer[Platform]
trait Serializer[Platform]
class Object
trait Matchable
class Any
sealed trait PlatformWithNone

PlatformWithNone

PlatformWithNone

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Platform
object Bigcommerce.type
object Commercetools.type
object Shopify.type
trait PlatformNone
object None.type
Show all
object PlatformWithNone

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object PlatformWithNoneSerializer extends Serializer[PlatformWithNone]

Attributes

Supertypes
trait Serializer[PlatformWithNone]
class Object
trait Matchable
class Any
Self type
trait PlatformWithNoneTrait extends PlatformWithNone

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Platform
object Bigcommerce.type
object Commercetools.type
object Shopify.type
trait PlatformNone
object None.type
Show all
sealed trait RecordType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Product.type
object Variant.type
object RecordType

Record type for ecommerce sources.

Record type for ecommerce sources.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
RecordType.type
class RecordTypeSerializer extends CustomSerializer[RecordType]

Attributes

Supertypes
class CustomSerializer[RecordType]
trait Serializer[RecordType]
class Object
trait Matchable
class Any
case class Run(runID: String, appID: String, taskID: String, status: RunStatus, progress: Option[RunProgress], outcome: Option[RunOutcome], failureThreshold: Option[Int], reason: Option[String], reasonCode: Option[RunReasonCode], `type`: RunType, createdAt: String, startedAt: Option[String], finishedAt: Option[String])

Run

Run

Value parameters

createdAt

Date of creation in RFC3339 format.

failureThreshold

Maximum accepted percentage of failures for a task run to finish successfully.

finishedAt

Date of finish in RFC3339 format.

reason

More information about the task run's outcome.

runID

Universally unique identifier (UUID) of a task run.

startedAt

Date of start in RFC3339 format.

taskID

Universally unique identifier (UUID) of a task.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class RunListResponse(runs: Seq[Run], pagination: Pagination, window: Window)

RunListResponse

RunListResponse

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait RunOutcome

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Failure.type
object Processing.type
object Success.type
object RunOutcome

Task run outcome.

Task run outcome.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
RunOutcome.type
class RunOutcomeSerializer extends CustomSerializer[RunOutcome]

Attributes

Supertypes
class CustomSerializer[RunOutcome]
trait Serializer[RunOutcome]
class Object
trait Matchable
class Any
case class RunProgress(expectedNbOfEvents: Option[Int], receivedNbOfEvents: Option[Int])

RunProgress

RunProgress

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait RunReasonCode

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Blocking.type
object Critical.type
object Discarded.type
object Internal.type
object NoEvents.type
object Ok.type
object TooManyErrors.type
Show all
object RunReasonCode

A code for the task run's outcome. A readable description of the code is included in the reason response property.

A code for the task run's outcome. A readable description of the code is included in the reason response property.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class RunReasonCodeSerializer extends CustomSerializer[RunReasonCode]

Attributes

Supertypes
class CustomSerializer[RunReasonCode]
trait Serializer[RunReasonCode]
class Object
trait Matchable
class Any
case class RunResponse(runID: String, createdAt: String)

API response for running a task.

API response for running a task.

Value parameters

createdAt

Date of creation in RFC3339 format.

runID

Universally unique identifier (UUID) of a task run.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait RunSortKeys

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CreatedAt.type
object Status.type
object UpdatedAt.type
object RunSortKeys

Property by which to sort the list of task runs.

Property by which to sort the list of task runs.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class RunSortKeysSerializer extends CustomSerializer[RunSortKeys]

Attributes

Supertypes
class CustomSerializer[RunSortKeys]
trait Serializer[RunSortKeys]
class Object
trait Matchable
class Any
sealed trait RunStatus

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Created.type
object Finished.type
object Idled.type
object Skipped.type
object Started.type
object RunStatus

Task run status.

Task run status.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
RunStatus.type
class RunStatusSerializer extends CustomSerializer[RunStatus]

Attributes

Supertypes
class CustomSerializer[RunStatus]
trait Serializer[RunStatus]
class Object
trait Matchable
class Any
sealed trait RunType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Discover.type
object Reindex.type
object Update.type
object RunType

Task run type.

Task run type.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
RunType.type
class RunTypeSerializer extends CustomSerializer[RunType]

Attributes

Supertypes
class CustomSerializer[RunType]
trait Serializer[RunType]
class Object
trait Matchable
class Any
case class ScheduleDateUtilsInput(timeframe: Int, mapping: Option[MappingInput]) extends TaskInputTrait

Input for scheduled tasks whose source is of type bigquery and for which extracted data spans a fixed number of days.

Input for scheduled tasks whose source is of type bigquery and for which extracted data spans a fixed number of days.

Value parameters

timeframe

Number of days in the past until the current day for which to extract Big Query data.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TaskInput
class Object
trait Matchable
class Any
Show all
case class ScheduleTrigger(`type`: ScheduleTriggerType, cron: String, lastRun: Option[String], nextRun: String) extends TriggerTrait

Trigger information for scheduled tasks.

Trigger information for scheduled tasks.

Value parameters

cron

Cron expression for the task's schedule.

lastRun

The last time the scheduled task ran in RFC3339 format.

nextRun

The next scheduled run of the task in RFC3339 format.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TriggerTrait
trait Trigger
class Object
trait Matchable
class Any
Show all
case class ScheduleTriggerInput(`type`: ScheduleTriggerType, cron: String) extends TaskCreateTriggerTrait

Trigger input for scheduled tasks.

Trigger input for scheduled tasks.

Value parameters

cron

Cron expression for the task's schedule.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait ScheduleTriggerType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Schedule.type
object ScheduleTriggerType

Task runs on a schedule.

Task runs on a schedule.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class ScheduleTriggerTypeSerializer extends CustomSerializer[ScheduleTriggerType]

Attributes

Supertypes
class CustomSerializer[ScheduleTriggerType]
trait Serializer[ScheduleTriggerType]
class Object
trait Matchable
class Any
case class ShopifyInput(metafields: Seq[ShopifyMetafield], market: ShopifyMarket) extends TaskInputTrait

Represents the required elements of the task input when using a shopify source.

Represents the required elements of the task input when using a shopify source.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TaskInput
class Object
trait Matchable
class Any
Show all
case class ShopifyMarket(countries: Seq[String], currencies: Seq[String], locales: Seq[String])

Represents a market in Shopify.

Represents a market in Shopify.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ShopifyMetafield(namespace: String, key: String, value: String)

Represents a metafield in Shopify.

Represents a metafield in Shopify.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Source(sourceID: String, `type`: SourceType, name: String, input: SourceInput, authenticationID: Option[String], createdAt: String, updatedAt: Option[String])

Source

Source

Value parameters

authenticationID

Universally unique identifier (UUID) of an authentication resource.

createdAt

Date of creation in RFC3339 format.

sourceID

Universally uniqud identifier (UUID) of a source.

updatedAt

Date of last update in RFC3339 format.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class SourceBigCommerce(storeHash: String, channel: Option[BigCommerceChannel], customFields: Option[Seq[String]], productMetafields: Option[Seq[BigCommerceMetafield]], variantMetafields: Option[Seq[BigCommerceMetafield]]) extends SourceInputTrait

SourceBigCommerce

SourceBigCommerce

Value parameters

storeHash

Store hash identifying your BigCommerce store.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait SourceInput
class Object
trait Matchable
class Any
Show all
case class SourceBigQuery(projectID: String, datasetID: String, dataType: Option[BigQueryDataType], table: Option[String], tablePrefix: Option[String], customSQLRequest: Option[String], uniqueIDColumn: Option[String]) extends SourceInputTrait, SourceUpdateInputTrait

SourceBigQuery

SourceBigQuery

Value parameters

customSQLRequest

Custom SQL request to extract data from the BigQuery table.

datasetID

Dataset ID of the BigQuery source.

projectID

Project ID of the BigQuery source.

table

Table name for the BigQuery export.

tablePrefix

Table prefix for a Google Analytics 4 data export to BigQuery.

uniqueIDColumn

Name of a column that contains a unique ID which will be used as objectID in Algolia.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait SourceInput
class Object
trait Matchable
class Any
Show all
case class SourceCSV(url: String, uniqueIDColumn: Option[String], mapping: Option[Map[String, MappingTypeCSV]], method: Option[MethodType], delimiter: Option[String]) extends SourceInputTrait, SourceUpdateInputTrait

SourceCSV

SourceCSV

Value parameters

delimiter

The character used to split the value on each line, default to a comma (\r, \n, 0xFFFD, and space are forbidden).

mapping

Key-value pairs of column names and their expected types.

uniqueIDColumn

Name of a column that contains a unique ID which will be used as objectID in Algolia.

url

URL of the file.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait SourceInput
class Object
trait Matchable
class Any
Show all
case class SourceCommercetools(storeKeys: Option[Seq[String]], locales: Option[Seq[String]], url: String, projectKey: String, fallbackIsInStockValue: Option[Boolean], customFields: Option[CommercetoolsCustomFields]) extends SourceInputTrait

SourceCommercetools

SourceCommercetools

Value parameters

fallbackIsInStockValue

Whether a fallback value is stored in the Algolia record if there's no inventory information about the product.

locales

Locales for your commercetools stores.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait SourceInput
class Object
trait Matchable
class Any
Show all
case class SourceCreate(`type`: SourceType, name: String, input: SourceInput, authenticationID: Option[String])

SourceCreate

SourceCreate

Value parameters

authenticationID

Universally unique identifier (UUID) of an authentication resource.

name

Descriptive name of the source.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class SourceCreateResponse(sourceID: String, name: String, createdAt: String)

SourceCreateResponse

SourceCreateResponse

Value parameters

createdAt

Date of creation in RFC3339 format.

name

Descriptive name of the source.

sourceID

Universally uniqud identifier (UUID) of a source.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class SourceDocker(imageType: DockerImageType, registry: DockerRegistry, image: String, version: Option[String], configuration: Any) extends SourceInputTrait

SourceDocker

SourceDocker

Value parameters

configuration

Configuration of the spec.

image

Docker image name.

version

Docker image version.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait SourceInput
class Object
trait Matchable
class Any
Show all
case class SourceGA4BigQueryExport(projectID: String, datasetID: String, tablePrefix: String) extends SourceInputTrait, SourceUpdateInputTrait

SourceGA4BigQueryExport

SourceGA4BigQueryExport

Value parameters

datasetID

BigQuery dataset ID that the BigQuery export writes to.

projectID

GCP project ID that the BigQuery export writes to.

tablePrefix

Prefix of the tables that the BigQuery Export writes to.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait SourceInput
class Object
trait Matchable
class Any
Show all
sealed trait SourceInput

SourceInput

SourceInput

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class SourceCSV
class SourceDocker
class SourceJSON
Show all
object SourceInput

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object SourceInputSerializer extends Serializer[SourceInput]

Attributes

Supertypes
trait Serializer[SourceInput]
class Object
trait Matchable
class Any
Self type
trait SourceInputTrait extends SourceInput

Attributes

Supertypes
trait SourceInput
class Object
trait Matchable
class Any
Known subtypes
class SourceCSV
class SourceDocker
class SourceJSON
Show all
case class SourceJSON(url: String, uniqueIDColumn: Option[String], method: Option[MethodType]) extends SourceInputTrait, SourceUpdateInputTrait

SourceJSON

SourceJSON

Value parameters

uniqueIDColumn

Name of a column that contains a unique ID which will be used as objectID in Algolia.

url

URL of the file.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait SourceInput
class Object
trait Matchable
class Any
Show all
case class SourceSearch(sourceIDs: Seq[String])

SourceSearch

SourceSearch

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class SourceShopify(collectionIDIndexing: Option[Boolean], increaseProductCollectionLimit: Option[Boolean], defaultPriceRatioAsOne: Option[Boolean], excludeOOSVariantsForPriceAtTRS: Option[Boolean], includeVariantsInventory: Option[Boolean], hasCollectionSearchPage: Option[Boolean], productNamedTags: Option[Boolean], shopURL: String) extends SourceInputTrait

SourceShopify

SourceShopify

Value parameters

collectionIDIndexing

Whether to index collection IDs. If your store has has_collection_search_page set to true, collection IDs will be indexed even if collectionIDIndexing is false.

defaultPriceRatioAsOne

Whether to set the default price ratio to 1 if no sale price is present. The price ratio is determined by the ratio: sale_price / regular_price. If no sale price is present, the price ratio would be 0. If defaultPriceRatioAsOne is true, the price ratio is indexed as 1 instead.

excludeOOSVariantsForPriceAtTRS

Whether to exclude out-of-stock variants when determining the max_variant_price and min_variant_price attributes.

hasCollectionSearchPage

Whether to include collection IDs and handles in the product records.

includeVariantsInventory

Whether to include an inventory with every variant for every product record.

increaseProductCollectionLimit

Whether to increase the number of indexed collections per product. If true, Algolia indexes 200 collections per product. If false, 100 collections per product are indexed.

productNamedTags

Whether to convert tags on products to named tags. To learn more, see Named tags.

shopURL

URL of the Shopify store.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait SourceInput
class Object
trait Matchable
class Any
Show all
case class SourceShopifyBase(shopURL: String)

SourceShopifyBase

SourceShopifyBase

Value parameters

shopURL

URL of the Shopify store.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait SourceSortKeys

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CreatedAt.type
object Name.type
object Type.type
object UpdatedAt.type
object SourceSortKeys

Property by which to sort the list of sources.

Property by which to sort the list of sources.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class SourceSortKeysSerializer extends CustomSerializer[SourceSortKeys]

Attributes

Supertypes
class CustomSerializer[SourceSortKeys]
trait Serializer[SourceSortKeys]
class Object
trait Matchable
class Any
sealed trait SourceType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Bigcommerce.type
object Bigquery.type
object Commercetools.type
object Csv.type
object Docker.type
object Ga4BigqueryExport.type
object Json.type
object Sfcc.type
object Shopify.type
Show all
object SourceType

SourceType enumeration

SourceType enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
SourceType.type
class SourceTypeSerializer extends CustomSerializer[SourceType]

Attributes

Supertypes
class CustomSerializer[SourceType]
trait Serializer[SourceType]
class Object
trait Matchable
class Any
case class SourceUpdate(name: Option[String], input: Option[SourceUpdateInput], authenticationID: Option[String])

SourceUpdate

SourceUpdate

Value parameters

authenticationID

Universally unique identifier (UUID) of an authentication resource.

name

Descriptive name of the source.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class SourceUpdateCommercetools(storeKeys: Option[Seq[String]], locales: Option[Seq[String]], url: Option[String], fallbackIsInStockValue: Option[Boolean], customFields: Option[CommercetoolsCustomFields]) extends SourceUpdateInputTrait

SourceUpdateCommercetools

SourceUpdateCommercetools

Value parameters

fallbackIsInStockValue

Whether a fallback value is stored in the Algolia record if there's no inventory information about the product.

locales

Locales for your commercetools stores.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class SourceUpdateDocker(registry: Option[DockerRegistry], image: Option[String], version: Option[String], configuration: Any) extends SourceUpdateInputTrait

SourceUpdateDocker

SourceUpdateDocker

Value parameters

configuration

Configuration of the spec.

image

Docker image name.

version

Docker image version.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait SourceUpdateInput

SourceUpdateInput

SourceUpdateInput

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class SourceCSV
class SourceJSON
Show all
object SourceUpdateInput

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object SourceUpdateInputSerializer extends Serializer[SourceUpdateInput]

Attributes

Supertypes
trait Serializer[SourceUpdateInput]
class Object
trait Matchable
class Any
Self type
trait SourceUpdateInputTrait extends SourceUpdateInput

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class SourceCSV
class SourceJSON
Show all
case class SourceUpdateResponse(sourceID: String, name: String, updatedAt: String)

SourceUpdateResponse

SourceUpdateResponse

Value parameters

name

Descriptive name of the source.

sourceID

Universally uniqud identifier (UUID) of a source.

updatedAt

Date of last update in RFC3339 format.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class SourceUpdateShopify(collectionIDIndexing: Option[Boolean], increaseProductCollectionLimit: Option[Boolean], defaultPriceRatioAsOne: Option[Boolean], excludeOOSVariantsForPriceAtTRS: Option[Boolean], includeVariantsInventory: Option[Boolean], hasCollectionSearchPage: Option[Boolean], productNamedTags: Option[Boolean]) extends SourceUpdateInputTrait

SourceUpdateShopify

SourceUpdateShopify

Value parameters

collectionIDIndexing

Whether to index collection IDs. If your store has has_collection_search_page set to true, collection IDs will be indexed even if collectionIDIndexing is false.

defaultPriceRatioAsOne

Whether to set the default price ratio to 1 if no sale price is present. The price ratio is determined by the ratio: sale_price / regular_price. If no sale price is present, the price ratio would be 0. If defaultPriceRatioAsOne is true, the price ratio is indexed as 1 instead.

excludeOOSVariantsForPriceAtTRS

Whether to exclude out-of-stock variants when determining the max_variant_price and min_variant_price attributes.

hasCollectionSearchPage

Whether to include collection IDs and handles in the product records.

includeVariantsInventory

Whether to include an inventory with every variant for every product record.

increaseProductCollectionLimit

Whether to increase the number of indexed collections per product. If true, Algolia indexes 200 collections per product. If false, 100 collections per product are indexed.

productNamedTags

Whether to convert tags on products to named tags. To learn more, see Named tags.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class StreamingTrigger(`type`: StreamingTriggerType) extends TriggerTrait, TaskCreateTriggerTrait

Trigger input for continuously running tasks.

Trigger input for continuously running tasks.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TriggerTrait
trait Trigger
class Object
trait Matchable
class Any
Show all
sealed trait StreamingTriggerType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Streaming.type
object StreamingTriggerType

Task runs continuously.

Task runs continuously.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class StreamingTriggerTypeSerializer extends CustomSerializer[StreamingTriggerType]

Attributes

Supertypes
class CustomSerializer[StreamingTriggerType]
trait Serializer[StreamingTriggerType]
class Object
trait Matchable
class Any
case class StreamingUtilsInput(mapping: MappingInput) extends TaskInputTrait

Input for a streaming task whose source is of type ga4BigqueryExport and for which extracted data is continuously streamed.

Input for a streaming task whose source is of type ga4BigqueryExport and for which extracted data is continuously streamed.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TaskInput
class Object
trait Matchable
class Any
Show all
case class SubscriptionTrigger(`type`: SubscriptionTriggerType) extends TriggerTrait, TaskCreateTriggerTrait

Trigger input for subscription tasks.

Trigger input for subscription tasks.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TriggerTrait
trait Trigger
class Object
trait Matchable
class Any
Show all
sealed trait SubscriptionTriggerType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Subscription.type
object SubscriptionTriggerType

Task runs after receiving subscribed event.

Task runs after receiving subscribed event.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class SubscriptionTriggerTypeSerializer extends CustomSerializer[SubscriptionTriggerType]

Attributes

Supertypes
class CustomSerializer[SubscriptionTriggerType]
trait Serializer[SubscriptionTriggerType]
class Object
trait Matchable
class Any
case class Task(taskID: String, sourceID: String, destinationID: String, trigger: Trigger, input: Option[TaskInput], enabled: Boolean, failureThreshold: Option[Int], action: ActionType, createdAt: String, updatedAt: Option[String])

Task

Task

Value parameters

createdAt

Date of creation in RFC3339 format.

destinationID

Universally unique identifier (UUID) of a destination resource.

enabled

Whether the task is enabled.

failureThreshold

Maximum accepted percentage of failures for a task run to finish successfully.

sourceID

Universally uniqud identifier (UUID) of a source.

taskID

Universally unique identifier (UUID) of a task.

updatedAt

Date of last update in RFC3339 format.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TaskCreate(sourceID: String, destinationID: String, trigger: TaskCreateTrigger, action: ActionType, enabled: Option[Boolean], failureThreshold: Option[Int], input: Option[TaskInput])

API request body for creating a task.

API request body for creating a task.

Value parameters

destinationID

Universally unique identifier (UUID) of a destination resource.

enabled

Whether the task is enabled.

failureThreshold

Maximum accepted percentage of failures for a task run to finish successfully.

sourceID

Universally uniqud identifier (UUID) of a source.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TaskCreateResponse(taskID: String, createdAt: String)

API response for creating a task.

API response for creating a task.

Value parameters

createdAt

Date of creation in RFC3339 format.

taskID

Universally unique identifier (UUID) of a task.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait TaskCreateTrigger

TaskCreateTrigger

TaskCreateTrigger

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object TaskCreateTrigger

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object TaskCreateTriggerSerializer extends Serializer[TaskCreateTrigger]

Attributes

Supertypes
trait Serializer[TaskCreateTrigger]
class Object
trait Matchable
class Any
Self type
trait TaskCreateTriggerTrait extends TaskCreateTrigger

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
sealed trait TaskInput

Configuration of the task, depending on its type.

Configuration of the task, depending on its type.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ShopifyInput
object TaskInput

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
TaskInput.type
object TaskInputSerializer extends Serializer[TaskInput]

Attributes

Supertypes
trait Serializer[TaskInput]
class Object
trait Matchable
class Any
Self type
trait TaskInputTrait extends TaskInput

Attributes

Supertypes
trait TaskInput
class Object
trait Matchable
class Any
Known subtypes
class ShopifyInput
case class TaskSearch(taskIDs: Seq[String])

TaskSearch

TaskSearch

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait TaskSortKeys

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Action.type
object CreatedAt.type
object Enabled.type
object TriggerType.type
object UpdatedAt.type
object TaskSortKeys

Property by which to sort the list of tasks.

Property by which to sort the list of tasks.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class TaskSortKeysSerializer extends CustomSerializer[TaskSortKeys]

Attributes

Supertypes
class CustomSerializer[TaskSortKeys]
trait Serializer[TaskSortKeys]
class Object
trait Matchable
class Any
case class TaskUpdate(destinationID: Option[String], trigger: Option[TriggerUpdateInput], input: Option[TaskInput], enabled: Option[Boolean], failureThreshold: Option[Int])

API request body for updating a task.

API request body for updating a task.

Value parameters

destinationID

Universally unique identifier (UUID) of a destination resource.

enabled

Whether the task is enabled.

failureThreshold

Maximum accepted percentage of failures for a task run to finish successfully.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TaskUpdateResponse(taskID: String, updatedAt: String)

API response for updating a task.

API response for updating a task.

Value parameters

taskID

Universally unique identifier (UUID) of a task.

updatedAt

Date of last update in RFC3339 format.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait Trigger

Trigger that runs the task.

Trigger that runs the task.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait TriggerTrait
object Trigger

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Trigger.type
object TriggerSerializer extends Serializer[Trigger]

Attributes

Supertypes
trait Serializer[Trigger]
class Object
trait Matchable
class Any
Self type
trait TriggerTrait extends Trigger

Attributes

Supertypes
trait Trigger
class Object
trait Matchable
class Any
Known subtypes
sealed trait TriggerType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object OnDemand.type
object Schedule.type
object Streaming.type
object Subscription.type
object TriggerType

Task trigger, describing when a task should run. - onDemand. Manually trigger the task with the /run endpoint. - schedule. Regularly trigger the task on a cron schedule. - subscription. Trigger the task after an event is received, such as, a webhook. - streaming. Run the task continuously.

Task trigger, describing when a task should run. - onDemand. Manually trigger the task with the /run endpoint. - schedule. Regularly trigger the task on a cron schedule. - subscription. Trigger the task after an event is received, such as, a webhook. - streaming. Run the task continuously.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class TriggerTypeSerializer extends CustomSerializer[TriggerType]

Attributes

Supertypes
class CustomSerializer[TriggerType]
trait Serializer[TriggerType]
class Object
trait Matchable
class Any
case class TriggerUpdateInput(cron: String)

Trigger for a task update.

Trigger for a task update.

Value parameters

cron

Cron expression for the task's schedule.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Window(startDate: String, endDate: String)

Time window by which to filter the observability data.

Time window by which to filter the observability data.

Value parameters

endDate

Date in RFC3339 format representing the newest data in the time window.

startDate

Date in RFC3339 format representing the oldest data in the time window.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Generated with