@code.store/arcxp-sdk-ts 5.0.3 → 5.1.0

package/dist/api/developer-retail/index.d.ts

@@ -0,0 +1,26 @@
+import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
+import type { GetAllRetailCampaignCategoriesParams, GetAllRetailCampaignCategoriesResponse, GetAllRetailCampaignsParams, GetAllRetailCampaignsResponse, GetAllRetailConditionCategoriesParams, GetAllRetailConditionCategoriesResponse, GetAllRetailOfferAttributesParams, GetAllRetailOfferAttributesResponse, GetAllRetailOffersParams, GetAllRetailOffersResponse, GetAllRetailPricingRatesParams, GetAllRetailPricingRatesResponse, GetAllRetailPricingStrategiesParams, GetAllRetailPricingStrategiesResponse, GetAllRetailProductAttributesParams, GetAllRetailProductAttributesResponse, GetAllRetailProductsParams, GetAllRetailProductsResponse, GetRetailCampaignByIdParams, GetRetailCampaignByNameParams, GetRetailCampaignCategoryByIdParams, GetRetailOfferAttributeByIdParams, GetRetailOfferByIdParams, GetRetailPricingCycleParams, GetRetailPricingRateByIdParams, GetRetailPricingStrategyByIdParams, GetRetailProductAttributeByIdParams, GetRetailProductByIdParams, GetRetailProductByPriceCodeParams, GetRetailProductBySkuParams, RetailCampaign, RetailCampaignCategory, RetailOffer, RetailOfferAttribute, RetailPricingCycle, RetailPricingRate, RetailPricingStrategy, RetailProduct, RetailProductAttribute } from './types.js';
+export declare class ArcDeveloperRetail extends ArcAbstractAPI {
+    constructor(options: ArcAPIOptions);
+    getProductById(id: number, params?: GetRetailProductByIdParams): Promise<RetailProduct>;
+    getProductBySku(sku: string, params?: GetRetailProductBySkuParams): Promise<RetailProduct>;
+    getProductByPriceCode(priceCode: number, params?: GetRetailProductByPriceCodeParams): Promise<RetailProduct>;
+    getAllProducts(params?: GetAllRetailProductsParams): Promise<GetAllRetailProductsResponse>;
+    getPricingStrategyById(id: number, params?: GetRetailPricingStrategyByIdParams): Promise<RetailPricingStrategy>;
+    getAllPricingStrategies(params?: GetAllRetailPricingStrategiesParams): Promise<GetAllRetailPricingStrategiesResponse>;
+    getPricingRateById(id: number, params?: GetRetailPricingRateByIdParams): Promise<RetailPricingRate>;
+    getAllPricingRates(params?: GetAllRetailPricingRatesParams): Promise<GetAllRetailPricingRatesResponse>;
+    getPricingCycle(priceCode: number, cycleIndex: number, startDate: string, params?: GetRetailPricingCycleParams): Promise<RetailPricingCycle>;
+    getCampaignById(id: number, params?: GetRetailCampaignByIdParams): Promise<RetailCampaign>;
+    getCampaignByName(campaignName: string, params?: GetRetailCampaignByNameParams): Promise<RetailCampaign>;
+    getAllCampaigns(params?: GetAllRetailCampaignsParams): Promise<GetAllRetailCampaignsResponse>;
+    getCampaignCategoryById(id: number, params?: GetRetailCampaignCategoryByIdParams): Promise<RetailCampaignCategory>;
+    getAllCampaignCategories(params?: GetAllRetailCampaignCategoriesParams): Promise<GetAllRetailCampaignCategoriesResponse>;
+    getOfferById(id: number, params?: GetRetailOfferByIdParams): Promise<RetailOffer>;
+    getAllOffers(params?: GetAllRetailOffersParams): Promise<GetAllRetailOffersResponse>;
+    getOfferAttributeById(id: number, params?: GetRetailOfferAttributeByIdParams): Promise<RetailOfferAttribute>;
+    getAllOfferAttributes(params?: GetAllRetailOfferAttributesParams): Promise<GetAllRetailOfferAttributesResponse>;
+    getProductAttributeById(id: number, params?: GetRetailProductAttributeByIdParams): Promise<RetailProductAttribute>;
+    getAllProductAttributes(params?: GetAllRetailProductAttributesParams): Promise<GetAllRetailProductAttributesResponse>;
+    getAllConditionCategories(params?: GetAllRetailConditionCategoriesParams): Promise<GetAllRetailConditionCategoriesResponse>;
+}

package/dist/api/developer-retail/types.d.ts

@@ -0,0 +1,259 @@
+export type PaginatedResponse<T> = {
+    result: T[];
+    lastPage: number;
+    page: number;
+    size: number;
+    sort: string;
+    sortDirection: string;
+    totalCount: number;
+};
+export type PaginationParams = {
+    page?: number;
+    size?: number;
+    sort?: string;
+    sortDirection?: 'ASC' | 'DESC';
+    search?: string;
+};
+export type RetailProductAttribute = {
+    id: number;
+    name: string;
+    value: string;
+};
+export type RetailProduct = {
+    createdOn?: string;
+    createdBy?: string;
+    modifiedOn?: string;
+    modifiedBy?: string;
+    id: number;
+    sku: string;
+    active: boolean;
+    gift: boolean;
+    taxInclusive: boolean;
+    description: string;
+    shortDescription: string;
+    image: string;
+    imageAction?: string;
+    name: string;
+    thumbnail: string;
+    maxSubscriptionAssociations?: number;
+    attributes: RetailProductAttribute[];
+    publishedOfferCount: number;
+    publishedOnOffer: boolean;
+    type: 'Subscription' | 'Physical' | 'Override' | 'Event';
+    defaultSwgProduct: boolean;
+    onHand: number;
+    productTaxCode?: string;
+    productURL?: string;
+    redirectURLs?: string[];
+};
+export type GetRetailProductByIdParams = {
+    site?: string;
+};
+export type GetRetailProductBySkuParams = {
+    site?: string;
+};
+export type GetRetailProductByPriceCodeParams = {
+    site?: string;
+};
+export type GetAllRetailProductsParams = PaginationParams & {
+    site?: string;
+};
+export type GetAllRetailProductsResponse = PaginatedResponse<RetailProduct[]>;
+export type RetailPricingRate = {
+    createdOn?: string;
+    createdBy?: string;
+    modifiedOn?: string;
+    modifiedBy?: string;
+    id: number;
+    amount: number;
+    billingCount: number;
+    billingFrequency: 'Day' | 'Week' | 'Month' | 'Year' | 'OneTime' | 'Hour';
+    durationCount: number;
+    duration: 'Week' | 'Month' | 'Year' | 'UntilCancelled' | 'Day' | 'Hour';
+    taxInclusive: boolean;
+};
+export type RetailPricingStrategy = {
+    createdOn?: string;
+    createdBy?: string;
+    modifiedOn?: string;
+    modifiedBy?: string;
+    id: number;
+    priceCode: string;
+    name: string;
+    description: string;
+    productId?: number;
+    active: boolean;
+    gift: boolean;
+    summary: string;
+    currencyCode: string;
+    currencyDisplayFormat: string;
+    currencyLocale: string;
+    rates: RetailPricingRate[];
+    publishedOffers?: Record<string, string>;
+    taxInclusive: boolean;
+    pricingRates: RetailPricingRate[];
+    changeEligible: boolean;
+};
+export type GetRetailPricingStrategyByIdParams = {
+    site?: string;
+};
+export type GetAllRetailPricingStrategiesParams = PaginationParams & {
+    site?: string;
+};
+export type GetAllRetailPricingStrategiesResponse = PaginatedResponse<RetailPricingStrategy[]>;
+export type GetRetailPricingRateByIdParams = {
+    site?: string;
+};
+export type GetAllRetailPricingRatesParams = PaginationParams & {
+    site?: string;
+};
+export type GetAllRetailPricingRatesResponse = PaginatedResponse<RetailPricingRate[]>;
+export type RetailPricingCycle = {
+    timeUMType: string;
+    timeQty: number;
+    price: number;
+    finalPayment: boolean;
+    paymentDate: string;
+    gift: boolean;
+    durationType: string;
+    durationQty: number;
+    currency: string;
+};
+export type GetRetailPricingCycleParams = {
+    site?: string;
+};
+export type RetailCampaignCategory = {
+    createdOn?: string;
+    createdBy?: string;
+    modifiedOn?: string;
+    modifiedBy?: string;
+    id: number;
+    name: string;
+    level: number;
+    inUse: boolean;
+    children?: RetailCampaignCategory[];
+};
+export type RetailCampaign = {
+    createdOn?: string;
+    createdBy?: string;
+    modifiedOn?: string;
+    modifiedBy?: string;
+    id: number;
+    canRenew: boolean;
+    canRestart: boolean;
+    canStart: boolean;
+    name: string;
+    validFrom: string;
+    validUntil: string;
+    publishedOffers?: Record<string, string>;
+    publishedProducts?: Record<string, string>;
+    publishedPrices?: Record<string, string>;
+    campaignCategory?: RetailCampaignCategory;
+    campaignCategories?: RetailCampaignCategory[];
+    offerId?: number;
+};
+export type GetRetailCampaignByIdParams = {
+    site?: string;
+};
+export type GetRetailCampaignByNameParams = {
+    site?: string;
+};
+export type GetAllRetailCampaignsParams = PaginationParams & {
+    site?: string;
+};
+export type GetAllRetailCampaignsResponse = PaginatedResponse<RetailCampaign[]>;
+export type GetRetailCampaignCategoryByIdParams = {
+    site?: string;
+};
+export type GetAllRetailCampaignCategoriesParams = PaginationParams & {
+    site?: string;
+};
+export type GetAllRetailCampaignCategoriesResponse = PaginatedResponse<RetailCampaignCategory[]>;
+export type RetailOfferAttribute = {
+    id: number;
+    name: string;
+    value: string;
+};
+export type RetailOfferProduct = {
+    createdOn?: string;
+    createdBy?: string;
+    modifiedOn?: string;
+    modifiedBy?: string;
+    product: RetailProduct;
+    productOverride: RetailProduct;
+    pricingStrategies: RetailPricingStrategy[];
+};
+export type RetailOffer = {
+    createdOn?: string;
+    createdBy?: string;
+    modifiedOn?: string;
+    modifiedBy?: string;
+    id: number;
+    name: string;
+    active: boolean;
+    isDefault: boolean;
+    disclaimerText: string;
+    largeImage: string;
+    mediumImage: string;
+    smallImage: string;
+    pageSubTitle: string;
+    pageTitle: string;
+    published: boolean;
+    publishedOn?: string;
+    templateName: string;
+    publishedBy?: number;
+    validFrom: string;
+    validUntil: string;
+    products: RetailOfferProduct[];
+    campaigns: RetailCampaign[];
+    attributes: RetailOfferAttribute[];
+};
+export type GetRetailOfferByIdParams = {
+    site?: string;
+};
+export type GetAllRetailOffersParams = PaginationParams & {
+    site?: string;
+};
+export type GetAllRetailOffersResponse = PaginatedResponse<RetailOffer[]>;
+export type GetRetailOfferAttributeByIdParams = {
+    site?: string;
+};
+export type GetAllRetailOfferAttributesParams = PaginationParams & {
+    site?: string;
+};
+export type GetAllRetailOfferAttributesResponse = PaginatedResponse<RetailOfferAttribute[]>;
+export type GetRetailProductAttributeByIdParams = {
+    site?: string;
+};
+export type GetAllRetailProductAttributesParams = PaginationParams & {
+    site?: string;
+};
+export type GetAllRetailProductAttributesResponse = PaginatedResponse<RetailProductAttribute[]>;
+export type RetailConditionValue = {
+    createdBy: number;
+    createdOn: string;
+    deletedOn: string;
+    modifiedBy: number;
+    modifiedOn: string;
+    createdName: string;
+    modifiedName: string;
+    externalID: number;
+    id: number;
+    value: string;
+    tenantID: number;
+};
+export type RetailConditionCategory = {
+    createdOn?: string;
+    createdBy?: string;
+    modifiedOn?: string;
+    modifiedBy?: string;
+    id: number;
+    conditionType: 'CONTENT' | 'AUDIENCE' | 'ENTITLEMENT';
+    name: string;
+    values: RetailConditionValue[];
+    tenantID: number;
+};
+export type GetAllRetailConditionCategoriesParams = PaginationParams & {
+    site?: string;
+};
+export type GetAllRetailConditionCategoriesResponse = PaginatedResponse<RetailConditionCategory[]>;

package/dist/api/identity/types.d.ts

@@ -195,8 +195,8 @@ export interface UserAddress {
      * @example 123 Main St.
      */
     line1?: string;
-    line2: string;
-    locality: string;
+    line2?: string;
+    locality?: string;
     region?: string;
     postal?: string;
     country?: string;

package/dist/api/index.d.ts

@@ -11,6 +11,7 @@ import { ArcMigrationCenter } from './migration-center/index.js';
 import { ArcProtoCenter } from './photo-center/index.js';
 import { ArcRedirect } from './redirect/index.js';
 import { ArcRetailEvents } from './retail-events/index.js';
+import { ArcDeveloperRetail } from './developer-retail/index.js';
 import { ArcSales } from './sales/index.js';
 import { ArcSigningService } from './signing-service/index.js';
 import { ArcSite } from './site/index.js';
@@ -33,6 +34,7 @@ export declare const ArcAPI: (options: ArcAPIOptions) => {
     Tags: ArcTags;
     ContentOps: ArcContentOps;
     RetailEvents: ArcRetailEvents;
+    DeveloperRetail: ArcDeveloperRetail;
     Custom: Custom;
 };
 export type ArcAPIType = ReturnType<typeof ArcAPI>;

package/dist/api/sales/types.d.ts

@@ -1,5 +1,6 @@
+import type { UserAttribute } from '../identity/types';
 export type MigrateBatchSubscriptionsPayload = {
-    subscriptions: (PaidSubscription | FreeSubscription)[];
+    subscriptions: (PaidSubscription | FreeSubscription | SharedSubscription | LinkedSubscription)[];
     payments: PaymentInfo[];
 };
 export type MigrateBatchSubscriptionsResponse = {
@@ -11,19 +12,14 @@ interface BaseSubscription {
     legacyID: string;
     ownerClientID: string;
     sku: string;
-    priceCode: string;
-    currentCycle: number;
-    nextEventDateUTC: string;
     paymentMethod?: Record<string, any>;
+    attributes?: UserAttribute[];
 }
 export interface PaidSubscription extends BaseSubscription {
-    legacyID: string;
-    ownerClientID: string;
-    sku: string;
+    type: 'paid';
     priceCode: string;
     currentCycle: number;
     nextEventDateUTC: string;
-    type: 'paid';
     paymentMethod: {
         providerID: number;
         token: string;
@@ -38,11 +34,28 @@ export interface PaidSubscription extends BaseSubscription {
         country: string;
     };
 }
+export interface LinkedSubscription extends BaseSubscription {
+    type: 'linked';
+    nextEventDateUTC?: string;
+    paymentMethod: {
+        providerID: number;
+        [key: string]: any;
+    };
+}
+export interface SharedSubscription extends BaseSubscription {
+    type: 'shared';
+    nextEventDateUTC?: string;
+    paymentMethod: {
+        providerID: number;
+        [key: string]: any;
+    };
+}
 export interface FreeSubscription extends BaseSubscription {
     type: 'free';
+    nextEventDateUTC?: string;
     paymentMethod: {
         providerID: number;
-        token: string;
+        [key: string]: any;
     };
 }
 export type PaymentInfo = {

package/dist/index.cjs

@@ -584,6 +584,128 @@ class ArcRetailEvents {
     }
 }
 
+class ArcDeveloperRetail extends ArcAbstractAPI {
+    constructor(options) {
+        super({ ...options, apiPath: 'retail/api/v1' });
+    }
+    // ============================================
+    // Product Methods
+    // ============================================
+    async getProductById(id, params) {
+        const { data } = await this.client.get(`/product/${id}`, { params });
+        return data;
+    }
+    async getProductBySku(sku, params) {
+        const { data } = await this.client.get(`/product/sku/${sku}`, { params });
+        return data;
+    }
+    async getProductByPriceCode(priceCode, params) {
+        const { data } = await this.client.get(`/product/pricecode/${priceCode}`, { params });
+        return data;
+    }
+    async getAllProducts(params) {
+        const { data } = await this.client.get('/product', { params });
+        return data;
+    }
+    // ============================================
+    // Pricing Strategy Methods
+    // ============================================
+    async getPricingStrategyById(id, params) {
+        const { data } = await this.client.get(`/pricing/strategy/${id}`, { params });
+        return data;
+    }
+    async getAllPricingStrategies(params) {
+        const { data } = await this.client.get('/pricing/strategy', { params });
+        return data;
+    }
+    // ============================================
+    // Pricing Rate Methods
+    // ============================================
+    async getPricingRateById(id, params) {
+        const { data } = await this.client.get(`/pricing/rate/${id}`, { params });
+        return data;
+    }
+    async getAllPricingRates(params) {
+        const { data } = await this.client.get('/pricing/rate', { params });
+        return data;
+    }
+    // ============================================
+    // Pricing Cycle Methods
+    // ============================================
+    async getPricingCycle(priceCode, cycleIndex, startDate, params) {
+        const { data } = await this.client.get(`/pricing/cycle/${priceCode}/${cycleIndex}/${startDate}`, {
+            params,
+        });
+        return data;
+    }
+    // ============================================
+    // Campaign Methods
+    // ============================================
+    async getCampaignById(id, params) {
+        const { data } = await this.client.get(`/campaign/${id}`, { params });
+        return data;
+    }
+    async getCampaignByName(campaignName, params) {
+        const { data } = await this.client.get(`/campaign/${campaignName}/get`, { params });
+        return data;
+    }
+    async getAllCampaigns(params) {
+        const { data } = await this.client.get('/campaign', { params });
+        return data;
+    }
+    // ============================================
+    // Campaign Category Methods
+    // ============================================
+    async getCampaignCategoryById(id, params) {
+        const { data } = await this.client.get(`/campaign/category/${id}`, { params });
+        return data;
+    }
+    async getAllCampaignCategories(params) {
+        const { data } = await this.client.get('/campaign/category', { params });
+        return data;
+    }
+    // ============================================
+    // Offer Methods
+    // ============================================
+    async getOfferById(id, params) {
+        const { data } = await this.client.get(`/offer/${id}`, { params });
+        return data;
+    }
+    async getAllOffers(params) {
+        const { data } = await this.client.get('/offer', { params });
+        return data;
+    }
+    // ============================================
+    // Offer Attribute Methods
+    // ============================================
+    async getOfferAttributeById(id, params) {
+        const { data } = await this.client.get(`/offer/attribute/${id}`, { params });
+        return data;
+    }
+    async getAllOfferAttributes(params) {
+        const { data } = await this.client.get('/offer/attribute', { params });
+        return data;
+    }
+    // ============================================
+    // Product Attribute Methods
+    // ============================================
+    async getProductAttributeById(id, params) {
+        const { data } = await this.client.get(`/product/attribute/${id}`, { params });
+        return data;
+    }
+    async getAllProductAttributes(params) {
+        const { data } = await this.client.get('/product/attribute', { params });
+        return data;
+    }
+    // ============================================
+    // Condition Category Methods
+    // ============================================
+    async getAllConditionCategories(params) {
+        const { data } = await this.client.get('/condition/categories', { params });
+        return data;
+    }
+}
+
 class ArcSales extends ArcAbstractAPI {
     constructor(options) {
         super({ ...options, apiPath: 'sales/api/v1' });
@@ -740,6 +862,7 @@ const ArcAPI = (options) => {
         Tags: new ArcTags(options),
         ContentOps: new ArcContentOps(options),
         RetailEvents: new ArcRetailEvents(options),
+        DeveloperRetail: new ArcDeveloperRetail(options),
         Custom: new Custom(options),
     };
     API.MigrationCenter.setMaxRPS(12);