@wix/auto_sdk_automations_action-catalog 1.0.18 → 1.0.20

package/build/es/index.typings.d.mts

@@ -97,15 +97,24 @@ interface GenericOptions {
     /** UI schema. */
     uiSchema?: Record<string, any> | null;
 }
+declare enum IntegrationType {
+    UNKNOWN_INTEGRATION_TYPE = "UNKNOWN_INTEGRATION_TYPE",
+    /** Integration with Wix API methods */
+    WIX_API = "WIX_API"
+}
+/** @enumType */
+type IntegrationTypeWithLiterals = IntegrationType | 'UNKNOWN_INTEGRATION_TYPE' | 'WIX_API';
 declare enum SourceType {
     UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
     /** The input/output schemas are constructed by developers in Dev Center using the self-service flow */
     DEV_CENTER = "DEV_CENTER",
     /** The input/output schemas are derived from an existing Wix API through the API-to-Action feature */
-    WIX_API = "WIX_API"
+    WIX_API = "WIX_API",
+    /** The action invokes external API methods based on configuration */
+    INTEGRATION = "INTEGRATION"
 }
 /** @enumType */
-type SourceTypeWithLiterals = SourceType | 'UNKNOWN_SOURCE_TYPE' | 'DEV_CENTER' | 'WIX_API';
+type SourceTypeWithLiterals = SourceType | 'UNKNOWN_SOURCE_TYPE' | 'DEV_CENTER' | 'WIX_API' | 'INTEGRATION';
 interface WixApiOptions {
     /**
      * Service entity fqdn
@@ -126,6 +135,10 @@ interface WixApiOptions {
      */
     methodName?: string;
 }
+interface IntegrationOptions {
+    /** The integration type */
+    integrationType?: IntegrationTypeWithLiterals;
+}
 interface Metadata {
     /** Whether the action is only shown to advanced mode users (Wix staff). */
     hidden?: boolean;
@@ -190,6 +203,8 @@ interface FocalPoint {
 interface Source extends SourceOptionsOneOf {
     /** Wix API options */
     wixApiOptions?: WixApiOptions;
+    /** Integration options */
+    integrationOptions?: IntegrationOptions;
     /** the source type */
     type?: SourceTypeWithLiterals;
 }
@@ -197,6 +212,8 @@ interface Source extends SourceOptionsOneOf {
 interface SourceOptionsOneOf {
     /** Wix API options */
     wixApiOptions?: WixApiOptions;
+    /** Integration options */
+    integrationOptions?: IntegrationOptions;
 }
 interface RetryExperimentCreation {
     /** action spec info */
@@ -332,13 +349,13 @@ interface GetActionDynamicInputSchemaResponse {
 }
 interface ResolveActionsRequest {
     /** Query options. */
-    query?: QueryV2;
+    query?: CommonQueryV2;
 }
-interface QueryV2 extends QueryV2PagingMethodOneOf {
+interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
     /** Paging options to limit and offset the number of items. */
-    paging?: Paging;
+    paging?: CommonPaging;
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
+    cursorPaging?: CommonCursorPaging;
     /**
      * Filter object.
      *
@@ -350,41 +367,41 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
      *
      * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
      */
-    sort?: Sorting[];
+    sort?: CommonSorting[];
     /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
     fields?: string[];
     /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
     fieldsets?: string[];
 }
 /** @oneof */
-interface QueryV2PagingMethodOneOf {
+interface CommonQueryV2PagingMethodOneOf {
     /** Paging options to limit and offset the number of items. */
-    paging?: Paging;
+    paging?: CommonPaging;
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
+    cursorPaging?: CommonCursorPaging;
 }
-interface Sorting {
+interface CommonSorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
      */
     fieldName?: string;
     /** Sort order. */
-    order?: SortOrderWithLiterals;
+    order?: CommonSortOrderWithLiterals;
 }
-declare enum SortOrder {
+declare enum CommonSortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
 /** @enumType */
-type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-interface Paging {
+type CommonSortOrderWithLiterals = CommonSortOrder | 'ASC' | 'DESC';
+interface CommonPaging {
     /** Number of items to load. */
     limit?: number | null;
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
-interface CursorPaging {
+interface CommonCursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -403,9 +420,9 @@ interface ResolveActionsResponse {
     /** Retrieved actions. */
     actions?: Action[];
     /** Paging metadata of the response. */
-    paging?: PagingMetadataV2;
+    paging?: CommonPagingMetadataV2;
 }
-interface PagingMetadataV2 {
+interface CommonPagingMetadataV2 {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Offset that was requested. */
@@ -415,9 +432,9 @@ interface PagingMetadataV2 {
     /** Flag that indicates the server failed to calculate the `total` field. */
     tooManyToCount?: boolean | null;
     /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
-    cursors?: Cursors;
+    cursors?: CommonCursors;
 }
-interface Cursors {
+interface CommonCursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -607,6 +624,116 @@ interface AdditionalInformationRequiredInfo {
      */
     feedback?: string;
 }
+interface QueryActionsRequest {
+    /** Query options. */
+    query?: QueryV2;
+}
+interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 4
+     */
+    sort?: Sorting[];
+    /**
+     * Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.
+     * @maxLength 200
+     * @maxSize 20
+     */
+    fields?: string[];
+    /**
+     * Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.
+     * @maxLength 200
+     * @maxSize 20
+     */
+    fieldsets?: string[];
+}
+/** @oneof */
+interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 500
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 64000
+     */
+    cursor?: string | null;
+}
+interface QueryActionsResponse {
+    /** Retrieved actions. */
+    actions?: Action[];
+    /** Paging metadata of the response. */
+    pagingMetadata?: PagingMetadataV2;
+}
+interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 64000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 64000
+     */
+    prev?: string | null;
+}
 interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
@@ -930,7 +1057,7 @@ interface GetActionDynamicInputSchemaOptions {
 declare function resolveActions(options?: ResolveActionsOptions): Promise<NonNullablePaths<ResolveActionsResponse, `actions` | `actions.${number}.appId` | `actions.${number}.actionKey` | `actions.${number}.implementedMethods.validateConfiguration` | `actions.${number}.implementedMethods.duplicateInputMapping` | `actions.${number}.implementedMethods.generateApplicationAutomationInputMapping` | `actions.${number}.implementedMethods.getQuotaInfo` | `actions.${number}.implementedMethods.onBeforeSave` | `actions.${number}.implementedMethods.onReset` | `actions.${number}.implementedMethods.generateActionInputMappingFromTemplate` | `actions.${number}.implementedMethods.onRemove` | `actions.${number}.implementedMethods.getDynamicInputSchema` | `actions.${number}.implementedMethods.mergeInputMappings` | `actions.${number}.implementedMethods.getDynamicOutputSchema` | `actions.${number}.implementedMethods.generateInputMappingFromIntent` | `actions.${number}.executionType` | `actions.${number}.interfaceConfiguration.type`, 5>>;
 interface ResolveActionsOptions {
     /** Query options. */
-    query?: QueryV2;
+    query?: CommonQueryV2;
 }
 /**
  * Get action input mapping copy
@@ -1003,4 +1130,4 @@ interface GetActionDynamicOutputSchemaOptions {
  */
 declare function bulkGetActionDynamicOutputSchemas(actionsInputMappings: ActionInputMappings[]): Promise<NonNullablePaths<BulkGetActionDynamicOutputSchemasResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
 
-export { type Action, type ActionEvent, type ActionInputMappings, type ActionSpecInfo, type AdditionalInformationRequiredInfo, type ApplicationError, type BulkActionMetadata, type BulkActionOutputSchemaResult, type BulkGetActionDynamicOutputSchemasRequest, type BulkGetActionDynamicOutputSchemasResponse, type CopyInputMappingOptions, type CopyInputMappingRequest, type CopyInputMappingResponse, type CreateActionOptions, type CreateActionRequest, type CreateActionResponse, type CursorPaging, type Cursors, type DeleteActionOptions, type DeleteActionRequest, type DeleteActionResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, ExecutionType, type ExecutionTypeWithLiterals, ExperimentActionType, type ExperimentActionTypeWithLiterals, type FocalPoint, type GenerateInputMappingFromIntentRequest, type GenerateInputMappingFromIntentResponse, type GenerateInputMappingFromIntentResponseStatusInfoOneOf, type GenericOptions, type GetActionDynamicInputSchemaOptions, type GetActionDynamicInputSchemaRequest, type GetActionDynamicInputSchemaResponse, type GetActionDynamicOutputSchemaOptions, type GetActionDynamicOutputSchemaRequest, type GetActionDynamicOutputSchemaResponse, type GetRuntimeActionIdentifiers, type GetRuntimeActionRequest, type GetRuntimeActionResponse, type IdentificationData, type IdentificationDataIdOneOf, type ImplementedMethods, type InputMappingGeneratedInfo, type InterfaceConfiguration, type InterfaceConfigurationOptionsOneOf, type ItemMetadata, type MessageEnvelope, type Metadata, type MigrateComponentToActionRequest, type MigrateComponentToActionResponse, type Paging, type PagingMetadataV2, type QueryV2, type QueryV2PagingMethodOneOf, type ResolveActionsOptions, type ResolveActionsRequest, type ResolveActionsResponse, type RestoreInfo, type RetryExperimentCreation, SortOrder, type SortOrderWithLiterals, type Sorting, type Source, type SourceOptionsOneOf, SourceType, type SourceTypeWithLiterals, Status, type StatusWithLiterals, Type, type TypeWithLiterals, type UpdateActionOptions, type UpdateActionRequest, type UpdateActionResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WidgetComponentOptions, type WixApiOptions, bulkGetActionDynamicOutputSchemas, copyInputMapping, createAction, deleteAction, getActionDynamicInputSchema, getActionDynamicOutputSchema, getRuntimeAction, resolveActions, updateAction };
+export { type Action, type ActionEvent, type ActionInputMappings, type ActionSpecInfo, type AdditionalInformationRequiredInfo, type ApplicationError, type BulkActionMetadata, type BulkActionOutputSchemaResult, type BulkGetActionDynamicOutputSchemasRequest, type BulkGetActionDynamicOutputSchemasResponse, type CommonCursorPaging, type CommonCursors, type CommonPaging, type CommonPagingMetadataV2, type CommonQueryV2, type CommonQueryV2PagingMethodOneOf, CommonSortOrder, type CommonSortOrderWithLiterals, type CommonSorting, type CopyInputMappingOptions, type CopyInputMappingRequest, type CopyInputMappingResponse, type CreateActionOptions, type CreateActionRequest, type CreateActionResponse, type CursorPaging, type Cursors, type DeleteActionOptions, type DeleteActionRequest, type DeleteActionResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, ExecutionType, type ExecutionTypeWithLiterals, ExperimentActionType, type ExperimentActionTypeWithLiterals, type FocalPoint, type GenerateInputMappingFromIntentRequest, type GenerateInputMappingFromIntentResponse, type GenerateInputMappingFromIntentResponseStatusInfoOneOf, type GenericOptions, type GetActionDynamicInputSchemaOptions, type GetActionDynamicInputSchemaRequest, type GetActionDynamicInputSchemaResponse, type GetActionDynamicOutputSchemaOptions, type GetActionDynamicOutputSchemaRequest, type GetActionDynamicOutputSchemaResponse, type GetRuntimeActionIdentifiers, type GetRuntimeActionRequest, type GetRuntimeActionResponse, type IdentificationData, type IdentificationDataIdOneOf, type ImplementedMethods, type InputMappingGeneratedInfo, type IntegrationOptions, IntegrationType, type IntegrationTypeWithLiterals, type InterfaceConfiguration, type InterfaceConfigurationOptionsOneOf, type ItemMetadata, type MessageEnvelope, type Metadata, type MigrateComponentToActionRequest, type MigrateComponentToActionResponse, type Paging, type PagingMetadataV2, type QueryActionsRequest, type QueryActionsResponse, type QueryV2, type QueryV2PagingMethodOneOf, type ResolveActionsOptions, type ResolveActionsRequest, type ResolveActionsResponse, type RestoreInfo, type RetryExperimentCreation, SortOrder, type SortOrderWithLiterals, type Sorting, type Source, type SourceOptionsOneOf, SourceType, type SourceTypeWithLiterals, Status, type StatusWithLiterals, Type, type TypeWithLiterals, type UpdateActionOptions, type UpdateActionRequest, type UpdateActionResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WidgetComponentOptions, type WixApiOptions, bulkGetActionDynamicOutputSchemas, copyInputMapping, createAction, deleteAction, getActionDynamicInputSchema, getActionDynamicOutputSchema, getRuntimeAction, resolveActions, updateAction };

package/build/es/index.typings.mjs

@@ -382,10 +382,16 @@ var Type = /* @__PURE__ */ ((Type2) => {
   Type2["GENERIC"] = "GENERIC";
   return Type2;
 })(Type || {});
+var IntegrationType = /* @__PURE__ */ ((IntegrationType2) => {
+  IntegrationType2["UNKNOWN_INTEGRATION_TYPE"] = "UNKNOWN_INTEGRATION_TYPE";
+  IntegrationType2["WIX_API"] = "WIX_API";
+  return IntegrationType2;
+})(IntegrationType || {});
 var SourceType = /* @__PURE__ */ ((SourceType2) => {
   SourceType2["UNKNOWN_SOURCE_TYPE"] = "UNKNOWN_SOURCE_TYPE";
   SourceType2["DEV_CENTER"] = "DEV_CENTER";
   SourceType2["WIX_API"] = "WIX_API";
+  SourceType2["INTEGRATION"] = "INTEGRATION";
   return SourceType2;
 })(SourceType || {});
 var ExecutionType = /* @__PURE__ */ ((ExecutionType2) => {
@@ -401,17 +407,22 @@ var ExperimentActionType = /* @__PURE__ */ ((ExperimentActionType2) => {
   ExperimentActionType2["DELETE_COMPONENT"] = "DELETE_COMPONENT";
   return ExperimentActionType2;
 })(ExperimentActionType || {});
-var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
-  SortOrder2["ASC"] = "ASC";
-  SortOrder2["DESC"] = "DESC";
-  return SortOrder2;
-})(SortOrder || {});
+var CommonSortOrder = /* @__PURE__ */ ((CommonSortOrder2) => {
+  CommonSortOrder2["ASC"] = "ASC";
+  CommonSortOrder2["DESC"] = "DESC";
+  return CommonSortOrder2;
+})(CommonSortOrder || {});
 var Status = /* @__PURE__ */ ((Status2) => {
   Status2["UNKNOWN_STATUS"] = "UNKNOWN_STATUS";
   Status2["INPUT_MAPPING_GENERATED"] = "INPUT_MAPPING_GENERATED";
   Status2["ADDITIONAL_INFORMATION_REQUIRED"] = "ADDITIONAL_INFORMATION_REQUIRED";
   return Status2;
 })(Status || {});
+var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
+  SortOrder2["ASC"] = "ASC";
+  SortOrder2["DESC"] = "DESC";
+  return SortOrder2;
+})(SortOrder || {});
 var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
   WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
   WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
@@ -731,8 +742,10 @@ async function bulkGetActionDynamicOutputSchemas2(actionsInputMappings) {
   }
 }
 export {
+  CommonSortOrder,
   ExecutionType,
   ExperimentActionType,
+  IntegrationType,
   SortOrder,
   SourceType,
   Status,