@adobe-commerce/aio-toolkit 1.0.4 → 1.0.6

package/dist/index.d.ts

@@ -231,6 +231,46 @@ declare class WebhookActionResponse {
     static remove(path: string): WebhookActionRemoveResponse;
 }
 
+interface ImsTokenResult {
+    token: string | null;
+    expire_in: number;
+}
+
+declare class ImsToken {
+    private readonly clientId;
+    private readonly clientSecret;
+    private readonly technicalAccountId;
+    private readonly technicalAccountEmail;
+    private readonly imsOrgId;
+    private readonly scopes;
+    private readonly customLogger;
+    private state;
+    private readonly tokenContext;
+    private readonly key;
+    constructor(clientId: string, clientSecret: string, technicalAccountId: string, technicalAccountEmail: string, imsOrgId: string, scopes: Array<string>, logger?: any, cacheKey?: string, tokenContext?: string);
+    execute(): Promise<string | null>;
+    getImsToken(): Promise<ImsTokenResult | null>;
+    setValue(result: ImsTokenResult): Promise<boolean>;
+    getValue(): Promise<string | null>;
+    getState(): Promise<any>;
+}
+
+declare class RuntimeApiGatewayService {
+    private static readonly BASE_URL;
+    private readonly namespace;
+    private readonly imsOrgId;
+    private readonly imsToken;
+    private readonly restClient;
+    private readonly customLogger;
+    constructor(clientId: string, clientSecret: string, technicalAccountId: string, technicalAccountEmail: string, imsOrgId: string, scopes: Array<string>, namespace: string, logger?: any);
+    private buildEndpoint;
+    private getAuthenticatedHeaders;
+    get(endpoint: string, additionalHeaders?: Record<string, string>): Promise<any>;
+    post(endpoint: string, payload: any, additionalHeaders?: Record<string, string>): Promise<any>;
+    put(endpoint: string, payload: any, additionalHeaders?: Record<string, string>): Promise<any>;
+    delete(endpoint: string, additionalHeaders?: Record<string, string>): Promise<any>;
+}
+
 interface BearerTokenInfo {
     token: string | null;
     tokenLength: number;
@@ -443,22 +483,23 @@ declare class InfiniteLoopBreaker {
     private static fingerPrint;
 }
 
-declare class AdobeAuth {
-    static getToken(clientId: string, clientSecret: string, technicalAccountId: string, technicalAccountEmail: string, imsOrgId: string, scopes: string[], currentContext?: string): Promise<string>;
-}
-
 interface Connection {
     extend: (client: Got) => Promise<Got>;
 }
 interface ExtendedRequestError extends RequestError {
     responseBody?: any;
 }
+interface HttpsOptions {
+    rejectUnauthorized?: boolean;
+    [key: string]: any;
+}
 
 declare class AdobeCommerceClient {
     private baseUrl;
     private connection;
     private logger;
-    constructor(baseUrl: string, connection: Connection, logger?: any);
+    private httpsOptions;
+    constructor(baseUrl: string, connection: Connection, logger?: any, httpsOptions?: HttpsOptions);
     get(endpoint: string, headers?: Record<string, string>): Promise<any>;
     post(endpoint: string, headers?: Record<string, string>, payload?: any): Promise<any>;
     put(endpoint: string, headers?: Record<string, string>, payload?: any): Promise<any>;
@@ -467,6 +508,120 @@ declare class AdobeCommerceClient {
     private getHttpClient;
 }
 
+declare const IoEventsGlobals: {
+    readonly BASE_URL: "https://api.adobe.io";
+    readonly STATUS_CODES: {
+        readonly OK: 200;
+        readonly BAD_REQUEST: 400;
+        readonly UNAUTHORIZED: 401;
+        readonly FORBIDDEN: 403;
+        readonly NOT_FOUND: 404;
+        readonly REQUEST_TIMEOUT: 408;
+        readonly TIMEOUT: 408;
+        readonly CONFLICT: 409;
+        readonly INTERNAL_SERVER_ERROR: 500;
+    };
+    readonly HEADERS: {
+        readonly CONFLICTING_ID: "x-conflicting-id";
+    };
+};
+interface HALLink {
+    href: string;
+    templated?: boolean;
+    type?: string;
+    title?: string;
+}
+interface IOEventsError {
+    error?: string;
+    message?: string;
+    error_code?: string;
+    details?: string;
+}
+declare class IOEventsApiError extends Error {
+    readonly statusCode: number;
+    readonly errorCode: string | undefined;
+    readonly details: string | undefined;
+    constructor(message: string, statusCode: number, errorCode?: string, details?: string);
+}
+
+interface Provider {
+    id: string;
+    label: string;
+    description: string;
+    source: string;
+    docs_url?: string;
+    provider_metadata: string;
+    instance_id?: string;
+    event_delivery_format: string;
+    publisher: string;
+    _links?: {
+        'rel:eventmetadata'?: HALLink;
+        'rel:update'?: HALLink;
+        self?: HALLink;
+    };
+}
+
+interface OnboardCommerceConfig {
+    adobeCommerceClient: AdobeCommerceClient;
+    merchantId: string;
+    environmentId: string;
+    logger?: any;
+}
+interface CommerceEventField {
+    name: string;
+}
+interface CommerceEvent {
+    name: string;
+    fields: CommerceEventField[];
+}
+interface CommerceEventConfig {
+    event: CommerceEvent;
+}
+interface WorkspaceConfig {
+    project: {
+        id: string;
+        name: string;
+        title: string;
+        org: {
+            id: string;
+            name: string;
+            ims_org_id: string;
+        };
+        workspace: {
+            id: string;
+            name: string;
+            title: string;
+            action_url: string;
+            app_url: string;
+            details?: any;
+        };
+    };
+}
+interface OnboardCommerceResult {
+    success: boolean;
+    message: string;
+    error?: string;
+}
+
+declare class OnboardCommerce {
+    private readonly adobeCommerceClient;
+    private readonly merchantId;
+    private readonly environmentId;
+    private readonly customLogger;
+    private readonly configureProvider;
+    private readonly eventSubscriptionService;
+    private readonly eventService;
+    constructor(adobeCommerceClient: AdobeCommerceClient, merchantId: string, environmentId: string, logger?: any);
+    process(provider: Provider, workspaceConfig: WorkspaceConfig, commerceEventsConfig?: CommerceEventConfig[]): Promise<any>;
+    private filterEventsBySubscriptionStatus;
+    private prepareEventPayload;
+    private logEventSubscriptionSummary;
+}
+
+declare class AdobeAuth {
+    static getToken(clientId: string, clientSecret: string, technicalAccountId: string, technicalAccountEmail: string, imsOrgId: string, scopes: string[], currentContext?: string): Promise<string>;
+}
+
 declare class BasicAuthConnection implements Connection {
     private baseUrl;
     private username;
@@ -521,17 +676,6 @@ declare class GenerateBasicAuthToken {
     getState(): Promise<any>;
 }
 
-interface ShippingCarrierData {
-    code: string;
-    title?: string;
-    stores?: string[];
-    countries?: string[];
-    sort_order?: number;
-    active?: boolean;
-    tracking_available?: boolean;
-    shipping_labels_available?: boolean;
-}
-
 interface ShippingCarrierMethodAdditionalData {
     key: string;
     value: any;
@@ -545,6 +689,17 @@ interface ShippingCarrierMethodData {
     additional_data: ShippingCarrierMethodAdditionalData[];
 }
 
+interface ShippingCarrierData {
+    code: string;
+    title?: string;
+    stores?: string[];
+    countries?: string[];
+    sort_order?: number;
+    active?: boolean;
+    tracking_available?: boolean;
+    shipping_labels_available?: boolean;
+}
+
 declare class ShippingCarrierMethod {
     private methodData;
     constructor(carrierCode: string, method: string);
@@ -572,8 +727,9 @@ declare class ShippingCarrier {
     setData(carrierData: ShippingCarrierData): this;
     addMethod(method: string, callback?: (builder: ShippingCarrierMethod) => void): this;
     removeMethod(method: string): this;
-    reset(code: string, callback?: (builder: ShippingCarrier) => void): this;
     getData(): ShippingCarrierData;
+    getAddedMethods(): ShippingCarrierMethodData[];
+    getRemovedMethods(): string[];
 }
 
 declare class ShippingCarrierResponse {
@@ -591,59 +747,6 @@ interface AdobeIMSConfig {
     scopes: string[];
 }
 
-declare const IoEventsGlobals: {
-    readonly BASE_URL: "https://api.adobe.io";
-    readonly STATUS_CODES: {
-        readonly OK: 200;
-        readonly BAD_REQUEST: 400;
-        readonly UNAUTHORIZED: 401;
-        readonly FORBIDDEN: 403;
-        readonly NOT_FOUND: 404;
-        readonly REQUEST_TIMEOUT: 408;
-        readonly TIMEOUT: 408;
-        readonly CONFLICT: 409;
-        readonly INTERNAL_SERVER_ERROR: 500;
-    };
-    readonly HEADERS: {
-        readonly CONFLICTING_ID: "x-conflicting-id";
-    };
-};
-interface HALLink {
-    href: string;
-    templated?: boolean;
-    type?: string;
-    title?: string;
-}
-interface IOEventsError {
-    error?: string;
-    message?: string;
-    error_code?: string;
-    details?: string;
-}
-declare class IOEventsApiError extends Error {
-    readonly statusCode: number;
-    readonly errorCode: string | undefined;
-    readonly details: string | undefined;
-    constructor(message: string, statusCode: number, errorCode?: string, details?: string);
-}
-
-interface Provider {
-    id: string;
-    label: string;
-    description: string;
-    source: string;
-    docs_url?: string;
-    provider_metadata: string;
-    instance_id?: string;
-    event_delivery_format: string;
-    publisher: string;
-    _links?: {
-        'rel:eventmetadata'?: HALLink;
-        'rel:update'?: HALLink;
-        self?: HALLink;
-    };
-}
-
 interface GetProviderQueryParams {
     eventmetadata?: boolean;
 }
@@ -815,4 +918,4 @@ declare class AdminUiSdk {
     getRegistration(): AdminUiSdkRegistration;
 }
 
-export { AdminUiSdk, type AdminUiSdkRegistration, AdobeAuth, AdobeCommerceClient, type AdobeIMSConfig, BasicAuthConnection, BearerToken, type BearerTokenInfo, type Connection, type CreateEventResult, CreateEvents, type CreateProviderParams, type CreateProviderResult, type CreateRegistrationResult, CreateRegistrations, type ErrorResponse, EventConsumerAction, type EventData, type EventMetadata, type EventMetadataInputModel, type EventMetadataListResponse, EventMetadataManager, type ExtendedRequestError, type FileMetadata, type FileRecord, FileRepository, GenerateBasicAuthToken, type GetProviderQueryParams, type GetRegistrationQueryParams, GraphQlAction, type HALLink, type Headers, HttpMethod, HttpStatus, IOEventsApiError, type IOEventsError, ImsConnection, InfiniteLoopBreaker, type InfiniteLoopData, IoEventsGlobals, type ListProvidersQueryParams, type ListRegistrationQueryParams, type MenuItem, Oauth1aConnection, OnboardEvents, type OnboardEventsInput, type OnboardEventsResponse, Openwhisk, OpenwhiskAction, type Page, Parameters, type Provider, type ProviderInputModel, ProviderManager, PublishEvent, type PublishEventResult, type Registration, type RegistrationCreateModel, type RegistrationListResponse, RegistrationManager, RestClient, RuntimeAction, RuntimeActionResponse, type RuntimeActionResponseType, ShippingCarrier, type ShippingCarrierData, ShippingCarrierMethod, type ShippingCarrierMethodAdditionalData, type ShippingCarrierMethodData, ShippingCarrierResponse, SignatureVerification, type SuccessResponse, type TokenResult, Validator, WebhookAction, type WebhookActionAddResponse, type WebhookActionExceptionResponse, WebhookActionOperation, type WebhookActionRemoveResponse, type WebhookActionReplaceResponse, WebhookActionResponse, type WebhookActionResponseType, type WebhookActionSuccessResponse };
+export { AdminUiSdk, type AdminUiSdkRegistration, AdobeAuth, AdobeCommerceClient, type AdobeIMSConfig, BasicAuthConnection, BearerToken, type BearerTokenInfo, type CommerceEvent, type CommerceEventConfig, type CommerceEventField, type Connection, type CreateEventResult, CreateEvents, type CreateProviderParams, type CreateProviderResult, type CreateRegistrationResult, CreateRegistrations, type ErrorResponse, EventConsumerAction, type EventData, type EventMetadata, type EventMetadataInputModel, type EventMetadataListResponse, EventMetadataManager, type ExtendedRequestError, type FileMetadata, type FileRecord, FileRepository, GenerateBasicAuthToken, type GetProviderQueryParams, type GetRegistrationQueryParams, GraphQlAction, type HALLink, type Headers, HttpMethod, HttpStatus, IOEventsApiError, type IOEventsError, ImsConnection, ImsToken, type ImsTokenResult, InfiniteLoopBreaker, type InfiniteLoopData, IoEventsGlobals, type ListProvidersQueryParams, type ListRegistrationQueryParams, type MenuItem, Oauth1aConnection, OnboardCommerce, type OnboardCommerceConfig, type OnboardCommerceResult, OnboardEvents, type OnboardEventsInput, type OnboardEventsResponse, OnboardEvents as OnboardIOEvents, Openwhisk, OpenwhiskAction, type Page, Parameters, type Provider, type ProviderInputModel, ProviderManager, PublishEvent, type PublishEventResult, type Registration, type RegistrationCreateModel, type RegistrationListResponse, RegistrationManager, RestClient, RuntimeAction, RuntimeActionResponse, type RuntimeActionResponseType, RuntimeApiGatewayService, ShippingCarrier, type ShippingCarrierData, ShippingCarrierMethod, type ShippingCarrierMethodAdditionalData, type ShippingCarrierMethodData, ShippingCarrierResponse, SignatureVerification, type SuccessResponse, type TokenResult, Validator, WebhookAction, type WebhookActionAddResponse, type WebhookActionExceptionResponse, WebhookActionOperation, type WebhookActionRemoveResponse, type WebhookActionReplaceResponse, WebhookActionResponse, type WebhookActionResponseType, type WebhookActionSuccessResponse, type WorkspaceConfig };