@spiffcommerce/core 19.0.0 → 19.1.1

package/dist/index.d.ts

@@ -595,7 +595,7 @@ interface Transaction {
     /**
      * The integration product related to this lineitem.
      */
-    integrationProduct?: IntegrationProduct;
+    integrationProduct?: IntegrationProductResource;
     /**
      * Whether this transaction has previously been ordered.
      */
@@ -645,7 +645,7 @@ interface Transaction {
  * An integration product represents the connection of a product in SpiffCommerce with
  * a product on a third party platform.
  */
-interface IntegrationProduct {
+interface IntegrationProductResource {
     /**
      * The ID of the IntegrationProduct entity. Used internally by SpiffCommerce.
      */
@@ -670,7 +670,7 @@ interface IntegrationProduct {
      * When the additionalExternalProductId is set, this is the IntegrationProduct that is associated with it.
      * If no Spiff product has been associated with the additionalExternalProductId, this will be null.
      */
-    additionalIntegrationProduct?: IntegrationProduct;
+    additionalIntegrationProduct?: IntegrationProductResource;
     /**
      * The product that this integration product is associated with.
      */
@@ -810,7 +810,7 @@ interface Product {
      * Configuration for conversion. Optional.
      */
     conversionConfiguration?: ConversionConfiguration;
-    integrationProducts?: IntegrationProduct[];
+    integrationProducts?: IntegrationProductResource[];
     productTags?: ProductTag[];
     /**
      * The SKU of the product in the merchant's store.
@@ -1667,7 +1667,7 @@ declare class CollectionProduct {
      * @param externalId An external integration ID to further filter by. Otherwise we return the first encountered.
      * @returns The integration if found. Throws an error if not found as this data is typically a neccesity.
      */
-    getIntegrationByType(type: IntegrationType, externalId?: string): IntegrationProduct;
+    getIntegrationByType(type: IntegrationType, externalId?: string): IntegrationProductResource;
     /**
      * A helper function for pulling the default workflow.
      */
@@ -1675,7 +1675,7 @@ declare class CollectionProduct {
     /**
      * A list of all integrations this product is connected to.
      */
-    getIntegrations(): IntegrationProduct[];
+    getIntegrations(): IntegrationProductResource[];
     /**
      * The raw product resource. This is generally not needed and should be avoided.
      */
@@ -2125,6 +2125,15 @@ declare class ObjectInput extends FlowExecutionInput {
     static validUUID(uuid: string): RegExpMatchArray | null;
 }
 
+declare class IntegrationProduct {
+    private readonly integrationProduct;
+    constructor(product: IntegrationProductResource);
+    getId(): string;
+    getResource(): IntegrationProductResource;
+    getBasePrice(): number;
+    getDefaultWorkflow(): ProductWorkflow;
+}
+
 declare const getWorkflows: (ids: string[], options?: GetWorkflowGraphqlOptions) => Promise<Workflow[]>;
 declare const getWorkflow: (id: string, options?: GetWorkflowGraphqlOptions) => Promise<Workflow>;
 /**
@@ -2340,6 +2349,8 @@ declare class SpiffCommerceClient {
      */
     private updateTransactionState;
     storeCustomer(customer: Customer): void;
+    getIntegrationProductById(integrationProductId: string): Promise<IntegrationProduct>;
+    getIntegrationProductFromExternalIds(externalIntegrationId: string, externalProductId: string): Promise<IntegrationProduct>;
 }
 
 declare class Configuration {
@@ -2914,4 +2925,4 @@ declare class PromiseCache {
 }
 declare const promiseCache: PromiseCache;
 
-export { AssetNotFoundError, Bundle, CollectionProduct, ColorOption, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FrameService, FrameStep, FrameStepHandle, FrameThresholdSettings, GetWorkflowOptions, GlobalPropertyHandle, IllustrationStepHandle, InformationMessageType, InformationResult, InformationStepHandle, IntegrationType, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, NodeType, ObjectInput, ObjectInputType, OptionNotFoundError, ParseError, PictureStepHandle, Product, ProductCameraRig, ProductCollection, ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, StepElements, StepHandle, TextStepHandle, TextStepStorage, Transaction, Transform, TransformCollection, UnhandledBehaviorError, Variant, Vector3, WorkflowExperience, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, createDesign, designService, digitalContentStepService, frameStepService, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, questionStepService, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };
+export { AssetNotFoundError, Bundle, CollectionProduct, ColorOption, ConversionConfiguration, ConversionData, ConversionDataType, ConversionLocation, Customer, CustomerDetailsInput, DesignCreationMessage, DesignCreationProgressUpdate, DesignInputStep, EditedSteps, FlowExecutionNodeResult, FlowExecutionResult, FlowService, FrameService, FrameStep, FrameStepHandle, FrameThresholdSettings, GetWorkflowOptions, GlobalPropertyHandle, IllustrationStepHandle, InformationMessageType, InformationResult, InformationStepHandle, IntegrationProduct, IntegrationType, LayoutNotFoundError, MandatorySteps, MaterialStepHandle, MisconfigurationError, MockWorkflowManager, ModelStepHandle, NodeType, ObjectInput, ObjectInputType, OptionNotFoundError, ParseError, PictureStepHandle, Product, ProductCameraRig, ProductCollection, ProductWorkflow, promiseCache as PromiseCache, PromiseQueue, QuestionStepHandle, QueueablePromise, RegionElement, RenderableScene, ResourceNotFoundError, SavedDesign, SelectionStorage, ShapeStepHandle, SilentIllustrationStepData, SpiffCommerceClient, Stakeholder, StakeholderType, StateMutationFunc, StepElements, StepHandle, TextStepHandle, TextStepStorage, Transaction, Transform, TransformCollection, UnhandledBehaviorError, Variant, Vector3, WorkflowExperience, WorkflowExperienceImpl, WorkflowManager, WorkflowMetadata, WorkflowScene, WorkflowSelections, WorkflowStorage, assetService, createDesign, designService, digitalContentStepService, frameStepService, generateCommands, generateStateFromDesignInputSteps, getBoundedOffsets, getWorkflow, getWorkflows, graphQlManager, illustrationStepService, materialStepService, modelStepService, moduleStepService, optionService, persistenceService, pictureStepService, questionStepService, shapeStepService, shortenUrl, spiffCoreConfiguration, stepAspectValuesToDesignInputSteps, textStepService, toast };