@wix/auto_sdk_crm_pipelines 1.0.7 → 1.0.9

package/build/cjs/index.typings.d.ts

@@ -56,6 +56,11 @@ interface Pipeline {
     stages?: Stage[];
     /** The final pipeline stage where cards receive a final outcome. */
     doneStage?: DoneStage;
+    /**
+     * The app that created this pipeline.
+     * @readonly
+     */
+    source?: PipelineSource;
     /** Extended fields data. */
     extendedFields?: ExtendedFields;
     /** Tags for organizing and categorizing pipelines. */
@@ -120,6 +125,14 @@ declare enum PipelineType {
 }
 /** @enumType */
 type PipelineTypeWithLiterals = PipelineType | 'GENERIC' | 'LEAD';
+interface PipelineSource {
+    /**
+     * ID of the app that created this pipeline.
+     * @format GUID
+     * @readonly
+     */
+    appId?: string | null;
+}
 interface ExtendedFields {
     /**
      * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
@@ -151,6 +164,10 @@ interface CreatePipelineResponse {
     /** Created pipeline. */
     pipeline?: Pipeline;
 }
+interface MaxPipelinesReachedError {
+    /** The maximum number of pipelines allowed. */
+    limit?: number;
+}
 interface GetPipelineRequest {
     /**
      * Pipeline ID to retrieve.
@@ -386,7 +403,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
     /** If present, indicates the action that triggered the event. */
     originatedFrom?: string | null;
     /**
-     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
      * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
      */
     entityEventSequence?: string | null;
@@ -511,6 +528,12 @@ interface AccountInfo {
     siteId?: string | null;
 }
 /** @docsIgnore */
+type CreatePipelineApplicationErrors = {
+    code?: 'MAX_PIPELINES_REACHED';
+    description?: string;
+    data?: MaxPipelinesReachedError;
+};
+/** @docsIgnore */
 type UpdatePipelineApplicationErrors = {
     code?: 'CANNOT_CHANGE_DURATION_ON_STAGE_WITH_CARDS';
     description?: string;
@@ -591,7 +614,7 @@ interface EventMetadata extends BaseEventMetadata {
     /** If present, indicates the action that triggered the event. */
     originatedFrom?: string | null;
     /**
-     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
      * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
      */
     entityEventSequence?: string | null;
@@ -678,7 +701,9 @@ declare function onPipelineUpdated(handler: (event: PipelineUpdatedEnvelope) =>
  * @returns Created pipeline.
  * @fqn wix.crm.pipelines.pipelines.v1.Pipelines.CreatePipeline
  */
-declare function createPipeline(pipeline: NonNullablePaths<Pipeline, `doneStage` | `doneStage.allowedOutcomes` | `doneStage.name` | `name` | `stages` | `stages.${number}.name`, 4>): Promise<NonNullablePaths<Pipeline, `stages` | `doneStage.allowedOutcomes` | `tags.privateTags.tagIds`, 4>>;
+declare function createPipeline(pipeline: NonNullablePaths<Pipeline, `doneStage` | `doneStage.allowedOutcomes` | `doneStage.name` | `name` | `stages` | `stages.${number}.name`, 4>): Promise<NonNullablePaths<Pipeline, `stages` | `doneStage.allowedOutcomes` | `tags.privateTags.tagIds`, 4> & {
+    __applicationErrorsType?: CreatePipelineApplicationErrors;
+}>;
 /**
  * Retrieves a pipeline by ID.
  * @param pipelineId - Pipeline ID to retrieve.
@@ -762,6 +787,11 @@ interface UpdatePipeline {
     stages?: Stage[];
     /** The final pipeline stage where cards receive a final outcome. */
     doneStage?: DoneStage;
+    /**
+     * The app that created this pipeline.
+     * @readonly
+     */
+    source?: PipelineSource;
     /** Extended fields data. */
     extendedFields?: ExtendedFields;
     /** Tags for organizing and categorizing pipelines. */
@@ -817,12 +847,12 @@ interface PipelinesQueryBuilder {
      * @param value - Value to compare against.
      * @documentationMaturity preview
      */
-    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => PipelinesQueryBuilder;
+    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'source.appId', value: any) => PipelinesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
      */
-    ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => PipelinesQueryBuilder;
+    ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'source.appId', value: any) => PipelinesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -849,7 +879,7 @@ interface PipelinesQueryBuilder {
      */
     startsWith: (propertyName: 'name', value: string) => PipelinesQueryBuilder;
     /** @documentationMaturity preview */
-    in: (propertyName: '_id' | 'name', value: any) => PipelinesQueryBuilder;
+    in: (propertyName: '_id' | 'name' | 'source.appId', value: any) => PipelinesQueryBuilder;
     /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
      * @documentationMaturity preview
      */
@@ -897,6 +927,11 @@ interface PipelineQuerySpec extends QuerySpec {
             fields: ['name'];
             operators: ['$eq', '$in', '$ne', '$nin', '$startsWith'];
             sort: 'ASC';
+        },
+        {
+            fields: ['source.appId'];
+            operators: ['$eq', '$in', '$ne', '$nin'];
+            sort: 'NONE';
         }
     ];
 }
@@ -1013,4 +1048,4 @@ interface BulkUpdatePipelineTagsByFilterOptions {
     returnEntity?: boolean;
 }
 
-export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkUpdatePipelineTagsApplicationErrors, type BulkUpdatePipelineTagsByFilterApplicationErrors, type BulkUpdatePipelineTagsByFilterOptions, type BulkUpdatePipelineTagsByFilterRequest, type BulkUpdatePipelineTagsByFilterResponse, type BulkUpdatePipelineTagsOptions, type BulkUpdatePipelineTagsRequest, type BulkUpdatePipelineTagsResponse, type BulkUpdatePipelineTagsResult, type CommonQueryWithEntityContext, type CreatePipelineRequest, type CreatePipelineResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeletePipelineApplicationErrors, type DeletePipelineRequest, type DeletePipelineResponse, type DomainEvent, type DomainEventBodyOneOf, type DoneStage, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GetPipelineRequest, type GetPipelineResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, Outcome, type OutcomeWithLiterals, type Pipeline, type PipelineCreatedEnvelope, type PipelineDeletedEnvelope, type PipelineQuery, type PipelineQuerySpec, PipelineType, type PipelineTypeWithLiterals, type PipelineUpdatedEnvelope, type PipelinesQueryBuilder, type PipelinesQueryResult, type PrivateTags, type QueryPipelinesRequest, type QueryPipelinesResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type Stage, type TagList, type UpdatePipeline, type UpdatePipelineApplicationErrors, type UpdatePipelineRequest, type UpdatePipelineResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkUpdatePipelineTags, bulkUpdatePipelineTagsByFilter, createPipeline, deletePipeline, getPipeline, onPipelineCreated, onPipelineDeleted, onPipelineUpdated, queryPipelines, typedQueryPipelines, updatePipeline, utils };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkUpdatePipelineTagsApplicationErrors, type BulkUpdatePipelineTagsByFilterApplicationErrors, type BulkUpdatePipelineTagsByFilterOptions, type BulkUpdatePipelineTagsByFilterRequest, type BulkUpdatePipelineTagsByFilterResponse, type BulkUpdatePipelineTagsOptions, type BulkUpdatePipelineTagsRequest, type BulkUpdatePipelineTagsResponse, type BulkUpdatePipelineTagsResult, type CommonQueryWithEntityContext, type CreatePipelineApplicationErrors, type CreatePipelineRequest, type CreatePipelineResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeletePipelineApplicationErrors, type DeletePipelineRequest, type DeletePipelineResponse, type DomainEvent, type DomainEventBodyOneOf, type DoneStage, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GetPipelineRequest, type GetPipelineResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MaxPipelinesReachedError, type MessageEnvelope, Outcome, type OutcomeWithLiterals, type Pipeline, type PipelineCreatedEnvelope, type PipelineDeletedEnvelope, type PipelineQuery, type PipelineQuerySpec, type PipelineSource, PipelineType, type PipelineTypeWithLiterals, type PipelineUpdatedEnvelope, type PipelinesQueryBuilder, type PipelinesQueryResult, type PrivateTags, type QueryPipelinesRequest, type QueryPipelinesResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type Stage, type TagList, type UpdatePipeline, type UpdatePipelineApplicationErrors, type UpdatePipelineRequest, type UpdatePipelineResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkUpdatePipelineTags, bulkUpdatePipelineTagsByFilter, createPipeline, deletePipeline, getPipeline, onPipelineCreated, onPipelineDeleted, onPipelineUpdated, queryPipelines, typedQueryPipelines, updatePipeline, utils };