@spiffcommerce/core 25.1.4 → 26.0.0

package/dist/index.d.ts

@@ -2083,10 +2083,10 @@ declare const getWorkflow: (id: string, options?: GetWorkflowGraphqlOptions) =>
  */
 interface ClientOptions {
     /**
-     * When provided, the client will use the provided application key to
-     * authenticate with the SpiffCommerce API.
+     * The client will use the provided application key to
+     * authenticate with the SpiffCommerce API. This key can be generated and replaced in Spiffcommerce Hub.
      */
-    applicationKey?: string;
+    applicationKey: string;
 }
 interface GetBundleGraphqlAssetsOptions {
     metadata?: boolean;
@@ -2172,8 +2172,8 @@ interface ClientConfiguration {
     hubUrl: string;
     serverUrl: string;
     servicesApiUrl: string;
-    marketplaceThemeInstallId: string;
-    marketplaceThemeInstallConfigurationId: string;
+    marketplaceThemeInstallId?: string;
+    marketplaceThemeInstallConfigurationId?: string;
     bearerAuthenticationToken?: string;
 }
 /**
@@ -2182,20 +2182,12 @@ interface ClientConfiguration {
  */
 declare class SpiffCommerceClient {
     private options;
-    private initialized;
     private currencyCode?;
     private customer?;
     private activeIntegration?;
     private marketplaceThemeInstallId?;
     private marketplaceThemeInstallConfigurationId?;
-    /**
-     * @deprecated This object is passed to the WorkflowExperience constructor and is no longer needed on this object.
-     * Any functionality referencing this object will be removed in a future release.
-     */
-    private experienceOptions?;
     constructor(options: ClientOptions);
-    /** @deprecated Use `configure` instead */
-    configureUrls(hubUrl: string, serverUrl: string, servicesApiUrl: string): void;
     configure(configuration: ClientConfiguration): void;
     /**
      * @returns The asset manager allows for common operations related to assets
@@ -2309,13 +2301,11 @@ declare class SpiffCommerceClient {
     getBundleStakeholders(): Promise<BundleStakeholder[]>;
     /**
      * Creates a new instance of WorkflowExperience. A high level wrapper for workflows.
-     * @param workflowId The id of the workflow to be run. Deprecated: Provide options instead.
-     * @param workflowState An existing workflow state if available. Deprecated: Provide options instead.
-     * @param previewServiceConstructor A function called during initialization. Takes a class implementing ThreeDPreviewService in return.
      * @param options Options to configure loading the transaction and workflow.
+     * @param previewServiceConstructor A function called during initialization. Takes a class implementing ThreeDPreviewService in return.
      * @returns A workflow experience configured as requested.
      */
-    getWorkflowExperience(workflowId?: string, workflowState?: string, previewServiceConstructor?: (workflow: Workflow) => ThreeDPreviewService, options?: GetWorkflowOptions): Promise<WorkflowExperience>;
+    getWorkflowExperience(options: GetWorkflowOptions, previewServiceConstructor?: (workflow: Workflow) => ThreeDPreviewService): Promise<WorkflowExperience>;
     /**
      * Gets multiple workflow experiences at once.
      * @param optionsArray An array of options to configure loading the transactions and workflows.
@@ -2324,38 +2314,6 @@ declare class SpiffCommerceClient {
      * @returns An array of workflow experiences configured as requested.
      */
     getWorkflowExperiences(optionsArray: GetWorkflowOptions[], graphqlOptions?: GetWorkflowGraphqlOptions): Promise<WorkflowExperience[]>;
-    /**
-     * Initialize the client from an integration product.
-     * @param integrationProductId The integration product to use.
-     * @deprecated Use getWorkflowExperience to initialize the experience.
-     */
-    initFromIntegrationProduct(integrationProductId: string): Promise<void>;
-    /**
-     * Initialize the client from an existing transaction.
-     * @param transactionId The id of the transaction
-     * @returns A promise resolving at initialization completion.
-     * @deprecated Use getWorkflowExperience to initialize the experience.
-     */
-    initFromTransaction(transactionId: string, readOnly?: boolean): Promise<void>;
-    /**
-     * @deprecated Remove when the initFrom functions are removed.
-     */
-    private getWorkflowExperienceDeprecated;
-    /**
-     * @deprecated The value this returns will be changed whenever `getWorkflowExperience()` is called. Use `workflowExperience.getWorkflowManager().getPreviewService()` instead.
-     * @returns The preview service that was provided during construction.
-     */
-    getPreviewService(): ThreeDPreviewService | undefined;
-    /**
-     * @deprecated The value this returns will be changed whenever `getWorkflowExperience()` is called. Use `WorkflowManager.getProduct()` instead.
-     * @returns The product associated with this client.
-     */
-    getProduct(): Product;
-    /**
-     * @deprecated The value this returns will be changed whenever `getWorkflowExperience()` is called. Use `WorkflowManager.getTransaction()` instead.
-     * @returns The transaction associated with this client.
-     */
-    getTransaction(): Transaction;
     /**
      * A function used to synchronize transaction state with the server.
      * @param options New state details. To be spread into the query.