@arrowsphere/api-client 3.172.0 → 3.173.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.173.0] - 2025.02.13
+
+### Updated
+- [campaign] add program dependencies to allow subscription
+
+## [3.172.1] - 2025.02.12
+
+### Updated
+- [campaign] update field dateAgg to DateAggType instead of DateAggType[] in CategoryType schema
+
 ## [3.172.0] - 2025.02.11
 
 ### Updated

package/build/campaign/entities/campaign/aggregation/category.d.ts

@@ -5,13 +5,13 @@ export declare enum CategoryEnumFields {
     COLUMN_NAME = "name"
 }
 export declare type CategoryType = {
-    [CategoryEnumFields.COLUMN_DATE_AGG]: DateAggType[];
+    [CategoryEnumFields.COLUMN_DATE_AGG]: DateAggType;
     [CategoryEnumFields.COLUMN_NAME]: string;
 };
 export declare class Category extends AbstractEntity<CategoryType> {
     #private;
     constructor(data: CategoryType);
-    get dateAgg(): DateAgg[];
+    get dateAgg(): DateAgg;
     get name(): string;
     toJSON(): CategoryType;
 }

package/build/campaign/entities/campaign/aggregation/category.js

@@ -25,7 +25,7 @@ class Category extends abstractEntity_1.AbstractEntity {
         super(data);
         _Category_dateAgg.set(this, void 0);
         _Category_name.set(this, void 0);
-        __classPrivateFieldSet(this, _Category_dateAgg, data.dateAgg.map((dateAgg) => new dateAgg_1.DateAgg(dateAgg)), "f");
+        __classPrivateFieldSet(this, _Category_dateAgg, new dateAgg_1.DateAgg(data.dateAgg), "f");
         __classPrivateFieldSet(this, _Category_name, data.name, "f");
     }
     get dateAgg() {
@@ -36,7 +36,7 @@ class Category extends abstractEntity_1.AbstractEntity {
     }
     toJSON() {
         return {
-            [CategoryEnumFields.COLUMN_DATE_AGG]: this.dateAgg.map((dateAgg) => dateAgg.toJSON()),
+            [CategoryEnumFields.COLUMN_DATE_AGG]: this.dateAgg.toJSON(),
             [CategoryEnumFields.COLUMN_NAME]: this.name,
         };
     }

package/build/graphqlApi/types/entities/program.d.ts

@@ -4,8 +4,13 @@ import { VendorsType } from './vendor';
 export declare type GraphqlApiProgramType = {
     id?: number;
     bypassReport?: number;
+    description?: string;
     internalName?: string;
+    introduction?: string;
+    levels?: ProgramLevelType[];
     name?: string;
+    subscriptionExtraFields?: SubscriptionExtraFieldType[];
+    url?: string;
     vendor?: VendorsType;
     type?: GraphqlApiProgramTypeType;
 };
@@ -20,6 +25,41 @@ export declare type GraphqlApiProgramLevelType = {
     internalName?: string;
     name?: string;
 };
+export declare type SubscriptionExtraFieldType = {
+    name?: string;
+    key?: string;
+    isMandatory?: boolean;
+    type?: string;
+    rule?: string;
+    description?: string;
+};
+export declare type ProgramLevelOptionGroupType = {
+    name?: string;
+    notAvailable?: boolean;
+    sku?: string;
+    programLevelOptions?: ProgramLevelOptionType[];
+};
+export declare type ProgramLevelOptionType = {
+    id?: number;
+    description?: string;
+    typeId?: number;
+};
+export declare type ProgramLevelType = {
+    internalName?: string;
+    name?: string;
+    benefits?: ProgramBenefitType[];
+    requirements?: ProgramRequirementType[];
+    programLevelOptionGroups?: ProgramLevelOptionGroupType[];
+};
+export declare type ProgramBenefitType = {
+    id?: number;
+    title?: string;
+    description?: string;
+};
+export declare type ProgramRequirementType = {
+    title?: string;
+    description?: string;
+};
 export declare type SubscribedProgramType = {
     id?: number;
     availabilityEndedAt?: string;

package/build/graphqlApi/types/entities/vendor.d.ts

@@ -1,10 +1,21 @@
+import { CountryType } from './country';
 export declare type VendorsType = {
     id?: number;
     identifier?: string;
     licenseUrl?: string;
+    location?: VendorLocationType;
     logoLarge?: string;
     logoSmall?: string;
     logoStandard?: string;
     name?: string;
     url?: string;
 };
+export declare type VendorLocationType = {
+    name?: string;
+    address1?: string;
+    address2?: string;
+    city?: string;
+    state?: string;
+    zipCode?: string;
+    country?: CountryType;
+};

package/build/graphqlApi/types/graphqlApiQueries.d.ts

@@ -3,7 +3,7 @@ import { ContactsType } from './entities/contact';
 import { ContinentType, CountryType } from './entities/country';
 import { LicenseBudgetType } from './entities/licenseBudget';
 import { PartnertagType } from './entities/partnertag';
-import { GraphqlApiProgramType, SubscribedProgramType } from './entities/program';
+import { GraphqlApiProgramType, ProgramLevelOptionGroupType, SubscribedProgramType } from './entities/program';
 import { QuoteType } from './entities/quote';
 import { GraphqlApiReportStatusType, GraphqlApiReportType } from './entities/report';
 import { SpecialPriceRateType } from './entities/specialPriceRate';
@@ -124,6 +124,7 @@ export declare enum SelectDataField {
     PARTNER = "partner",
     PARTNERTAG = "partnertag",
     PROGRAM = "program",
+    PROGRAM_LEVEL_OPTION_GROUP = "programLevelOptionGroup",
     QUOTE = "quote",
     REPORT = "report",
     REPORT_STATUS = "reportStatus",
@@ -150,6 +151,7 @@ export declare type SelectAllResponseDataType = {
     [SelectDataField.PARTNER]?: PartnerType[];
     [SelectDataField.PARTNERTAG]?: PartnertagType[];
     [SelectDataField.PROGRAM]?: GraphqlApiProgramType[];
+    [SelectDataField.PROGRAM_LEVEL_OPTION_GROUP]?: ProgramLevelOptionGroupType[];
     [SelectDataField.QUOTE]?: QuoteType[];
     [SelectDataField.REPORT]?: GraphqlApiReportType[];
     [SelectDataField.REPORT_STATUS]?: GraphqlApiReportStatusType[];
@@ -225,6 +227,7 @@ export declare type SelectOneResponseDataType = {
     [SelectDataField.PARTNER]?: PartnerType;
     [SelectDataField.PARTNERTAG]?: PartnertagType;
     [SelectDataField.PROGRAM]?: GraphqlApiProgramType;
+    [SelectDataField.PROGRAM_LEVEL_OPTION_GROUP]?: ProgramLevelOptionGroupType;
     [SelectDataField.QUOTE]?: QuoteType;
     [SelectDataField.REPORT]?: GraphqlApiReportType;
     [SelectDataField.REPORT_STATUS]?: GraphqlApiReportStatusType;

package/build/graphqlApi/types/graphqlApiQueries.js

@@ -99,6 +99,7 @@ var SelectDataField;
     SelectDataField["PARTNER"] = "partner";
     SelectDataField["PARTNERTAG"] = "partnertag";
     SelectDataField["PROGRAM"] = "program";
+    SelectDataField["PROGRAM_LEVEL_OPTION_GROUP"] = "programLevelOptionGroup";
     SelectDataField["QUOTE"] = "quote";
     SelectDataField["REPORT"] = "report";
     SelectDataField["REPORT_STATUS"] = "reportStatus";

package/build/graphqlApi/types/graphqlApiSchemas.d.ts

@@ -8,8 +8,7 @@ import { ContactsType } from './entities/contact';
 import { SubscriptionType } from './entities/subscription';
 import { SpecialPriceRateType } from './entities/specialPriceRate';
 import { OrderItemsType, OrdersType } from './entities/order';
-import { VendorsType } from './entities/vendor';
-import { GraphqlApiProgramType, SubscribedProgramType } from './entities/program';
+import { GraphqlApiProgramType, ProgramBenefitType, ProgramLevelType, ProgramRequirementType, ProgramLevelOptionGroupType, ProgramLevelOptionType, SubscribedProgramType, SubscriptionExtraFieldType } from './entities/program';
 import { LicenseBudgetNotificationType, LicenseBudgetType } from './entities/licenseBudget';
 import { UserHistoryType, UserType } from './entities/user';
 import { OrganizationUnitsType } from './entities/organizationUnit';
@@ -103,13 +102,30 @@ export declare type ErrorsSchema = Schema<ErrorsType, boolean>;
 export declare type LicenseBudgetNotificationSchema = Schema<LicenseBudgetNotificationType, boolean>;
 export declare type OrganizationUnitSchema = Schema<OrganizationUnitsType, boolean>;
 export declare type PageSchema = Schema<PageType, boolean>;
-export declare type GraphqlApiProgramSchema = Schema<GraphqlApiProgramType, boolean>;
+export declare type ProgramBenefitSchema = Schema<ProgramBenefitType, boolean>;
+export declare type ProgramLevelOptionSchema = Schema<ProgramLevelOptionType, boolean>;
+export declare type ProgramRequirementSchema = Schema<ProgramRequirementType, boolean>;
+export declare type ProgramLevelSchema = Schema<ProgramLevelType, boolean>;
+declare type MissingFieldsOfProgramLevelOptionGroupSchema = {
+    programLevelOptions?: ProgramLevelOptionSchema;
+};
+export declare type ProgramLevelOptionGroupSchema = Merge<Schema<ProgramLevelOptionGroupType, boolean>, MissingFieldsOfProgramLevelOptionGroupSchema>;
+export declare type SubscriptionExtraFieldSchema = Schema<SubscriptionExtraFieldType, boolean>;
+export declare type MissingFieldsOfLevelSchema = {
+    benefits?: ProgramBenefitSchema;
+    programLevelOptionGroups?: ProgramLevelOptionGroupSchema;
+    requirements?: ProgramRequirementSchema;
+};
+export declare type MissingFieldsOfProgramSchema = {
+    levels?: Merge<Schema<ProgramLevelSchema, boolean>, MissingFieldsOfLevelSchema>;
+    subscriptionExtraFields?: SubscriptionExtraFieldSchema;
+};
+export declare type GraphqlApiProgramSchema = Merge<Schema<GraphqlApiProgramType, boolean>, MissingFieldsOfProgramSchema>;
 export declare type ReportStatusSchema = Schema<GraphqlApiReportStatusType, boolean>;
 export declare type SpecialPriceRateSchema = Schema<SpecialPriceRateType, boolean>;
 export declare type SubscribedProgramSchema = Schema<SubscribedProgramType, boolean>;
 export declare type SubscriptionSchema = Schema<SubscriptionType, boolean>;
 export declare type UserHistorySchema = Schema<UserHistoryType, boolean>;
-export declare type VendorSchema = Schema<VendorsType, boolean>;
 export declare type WorkgroupSchema = Schema<WorkgroupType, boolean>;
 export declare type SelectAllResultSchema = {
     [SelectableField.DATA]?: SelectAllResponseDataSchema;
@@ -125,6 +141,7 @@ export declare type SelectAllResponseDataSchema = {
     [SelectDataField.PARTNER]?: PartnerSchema;
     [SelectDataField.PARTNERTAG]?: PartnertagSchema;
     [SelectDataField.PROGRAM]?: GraphqlApiProgramSchema;
+    [SelectDataField.PROGRAM_LEVEL_OPTION_GROUP]?: ProgramLevelOptionGroupSchema;
     [SelectDataField.QUOTE]?: QuoteSchema;
     [SelectDataField.REPORT]?: ReportSchema;
     [SelectDataField.REPORT_STATUS]?: ReportStatusSchema;

package/build/subscriptions/subscriptionsClient.d.ts

@@ -29,6 +29,16 @@ export declare type SubscriptionsListData = {
         previous: string;
     };
 };
+export declare type SubscriptionCreationData = {
+    name: string;
+    level: string;
+    sku: string;
+    extraInformation?: {
+        programs: {
+            [programName: string]: Record<string, string>;
+        };
+    };
+};
 export declare class SubscriptionsClient extends AbstractRestfulClient {
     /**
      * The base path of the API
@@ -62,4 +72,5 @@ export declare class SubscriptionsClient extends AbstractRestfulClient {
      *
      */
     list(postData?: SubscriptionsListPayload, perPage?: number, page?: number): Promise<SubscriptionsListResult>;
+    addSubscription(postData: SubscriptionCreationData): Promise<void>;
 }

package/build/subscriptions/subscriptionsClient.js

@@ -50,6 +50,9 @@ class SubscriptionsClient extends abstractRestfulClient_1.AbstractRestfulClient
         const response = await this.listRaw(postData);
         return new subscriptionsListResult_1.SubscriptionsListResult(response, this, postData);
     }
+    async addSubscription(postData) {
+        return this.post(postData);
+    }
 }
 exports.SubscriptionsClient = SubscriptionsClient;
 //# sourceMappingURL=subscriptionsClient.js.map

package/build/user/types/CompleteWhoAmICompany.d.ts

@@ -2,6 +2,7 @@ import { AbstractEntity } from '../../abstractEntity';
 export declare enum CompleteWhoAmICompanyFields {
     COLUMN_COMPANY_RESTRICTED = "companyRestricted",
     COLUMN_COUNTRY_CODE = "countryCode",
+    COLUMN_ERP_ID = "erpId",
     COLUMN_HAS_ACCESS_TO_XCM = "hasAccessToXcm",
     COLUMN_HAS_ACCESS_TO_XCP = "hasAccessToXcp",
     COLUMN_IS_PROTECTED = "isProtected",
@@ -18,6 +19,7 @@ export declare type CompanyUnit = {
 export declare type CompleteWhoAmICompanyData = {
     [CompleteWhoAmICompanyFields.COLUMN_COMPANY_RESTRICTED]: boolean;
     [CompleteWhoAmICompanyFields.COLUMN_COUNTRY_CODE]: string;
+    [CompleteWhoAmICompanyFields.COLUMN_ERP_ID]: string;
     [CompleteWhoAmICompanyFields.COLUMN_HAS_ACCESS_TO_XCM]: boolean;
     [CompleteWhoAmICompanyFields.COLUMN_HAS_ACCESS_TO_XCP]: boolean;
     [CompleteWhoAmICompanyFields.COLUMN_IS_PROTECTED]: boolean;
@@ -32,6 +34,7 @@ export declare class CompleteWhoAmICompany extends AbstractEntity<CompleteWhoAmI
     constructor(data: CompleteWhoAmICompanyData);
     get companyRestricted(): boolean;
     get countryCode(): string;
+    get erpId(): string;
     get hasAccessToXcm(): boolean;
     get hasAccessToXcp(): boolean;
     get isProtected(): boolean;

package/build/user/types/CompleteWhoAmICompany.js

@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _CompleteWhoAmICompany_companyRestricted, _CompleteWhoAmICompany_countryCode, _CompleteWhoAmICompany_hasAccessToXcm, _CompleteWhoAmICompany_hasAccessToXcp, _CompleteWhoAmICompany_isProtected, _CompleteWhoAmICompany_marketplace, _CompleteWhoAmICompany_name, _CompleteWhoAmICompany_reference, _CompleteWhoAmICompany_tags, _CompleteWhoAmICompany_unit;
+var _CompleteWhoAmICompany_companyRestricted, _CompleteWhoAmICompany_countryCode, _CompleteWhoAmICompany_erpId, _CompleteWhoAmICompany_hasAccessToXcm, _CompleteWhoAmICompany_hasAccessToXcp, _CompleteWhoAmICompany_isProtected, _CompleteWhoAmICompany_marketplace, _CompleteWhoAmICompany_name, _CompleteWhoAmICompany_reference, _CompleteWhoAmICompany_tags, _CompleteWhoAmICompany_unit;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CompleteWhoAmICompany = exports.CompleteWhoAmICompanyFields = void 0;
 const abstractEntity_1 = require("../../abstractEntity");
@@ -18,6 +18,7 @@ var CompleteWhoAmICompanyFields;
 (function (CompleteWhoAmICompanyFields) {
     CompleteWhoAmICompanyFields["COLUMN_COMPANY_RESTRICTED"] = "companyRestricted";
     CompleteWhoAmICompanyFields["COLUMN_COUNTRY_CODE"] = "countryCode";
+    CompleteWhoAmICompanyFields["COLUMN_ERP_ID"] = "erpId";
     CompleteWhoAmICompanyFields["COLUMN_HAS_ACCESS_TO_XCM"] = "hasAccessToXcm";
     CompleteWhoAmICompanyFields["COLUMN_HAS_ACCESS_TO_XCP"] = "hasAccessToXcp";
     CompleteWhoAmICompanyFields["COLUMN_IS_PROTECTED"] = "isProtected";
@@ -32,6 +33,7 @@ class CompleteWhoAmICompany extends abstractEntity_1.AbstractEntity {
         super(data);
         _CompleteWhoAmICompany_companyRestricted.set(this, void 0);
         _CompleteWhoAmICompany_countryCode.set(this, void 0);
+        _CompleteWhoAmICompany_erpId.set(this, void 0);
         _CompleteWhoAmICompany_hasAccessToXcm.set(this, void 0);
         _CompleteWhoAmICompany_hasAccessToXcp.set(this, void 0);
         _CompleteWhoAmICompany_isProtected.set(this, void 0);
@@ -42,6 +44,7 @@ class CompleteWhoAmICompany extends abstractEntity_1.AbstractEntity {
         _CompleteWhoAmICompany_unit.set(this, void 0);
         __classPrivateFieldSet(this, _CompleteWhoAmICompany_companyRestricted, data[CompleteWhoAmICompanyFields.COLUMN_COMPANY_RESTRICTED], "f");
         __classPrivateFieldSet(this, _CompleteWhoAmICompany_countryCode, data[CompleteWhoAmICompanyFields.COLUMN_COUNTRY_CODE], "f");
+        __classPrivateFieldSet(this, _CompleteWhoAmICompany_erpId, data[CompleteWhoAmICompanyFields.COLUMN_ERP_ID], "f");
         __classPrivateFieldSet(this, _CompleteWhoAmICompany_hasAccessToXcm, data[CompleteWhoAmICompanyFields.COLUMN_HAS_ACCESS_TO_XCM], "f");
         __classPrivateFieldSet(this, _CompleteWhoAmICompany_hasAccessToXcp, data[CompleteWhoAmICompanyFields.COLUMN_HAS_ACCESS_TO_XCP], "f");
         __classPrivateFieldSet(this, _CompleteWhoAmICompany_isProtected, data[CompleteWhoAmICompanyFields.COLUMN_IS_PROTECTED], "f");
@@ -57,6 +60,9 @@ class CompleteWhoAmICompany extends abstractEntity_1.AbstractEntity {
     get countryCode() {
         return __classPrivateFieldGet(this, _CompleteWhoAmICompany_countryCode, "f");
     }
+    get erpId() {
+        return __classPrivateFieldGet(this, _CompleteWhoAmICompany_erpId, "f");
+    }
     get hasAccessToXcm() {
         return __classPrivateFieldGet(this, _CompleteWhoAmICompany_hasAccessToXcm, "f");
     }
@@ -86,6 +92,7 @@ class CompleteWhoAmICompany extends abstractEntity_1.AbstractEntity {
             [CompleteWhoAmICompanyFields.COLUMN_COMPANY_RESTRICTED]: this
                 .companyRestricted,
             [CompleteWhoAmICompanyFields.COLUMN_COUNTRY_CODE]: this.countryCode,
+            [CompleteWhoAmICompanyFields.COLUMN_ERP_ID]: this.erpId,
             [CompleteWhoAmICompanyFields.COLUMN_HAS_ACCESS_TO_XCM]: this
                 .hasAccessToXcm,
             [CompleteWhoAmICompanyFields.COLUMN_HAS_ACCESS_TO_XCP]: this
@@ -100,5 +107,5 @@ class CompleteWhoAmICompany extends abstractEntity_1.AbstractEntity {
     }
 }
 exports.CompleteWhoAmICompany = CompleteWhoAmICompany;
-_CompleteWhoAmICompany_companyRestricted = new WeakMap(), _CompleteWhoAmICompany_countryCode = new WeakMap(), _CompleteWhoAmICompany_hasAccessToXcm = new WeakMap(), _CompleteWhoAmICompany_hasAccessToXcp = new WeakMap(), _CompleteWhoAmICompany_isProtected = new WeakMap(), _CompleteWhoAmICompany_marketplace = new WeakMap(), _CompleteWhoAmICompany_name = new WeakMap(), _CompleteWhoAmICompany_reference = new WeakMap(), _CompleteWhoAmICompany_tags = new WeakMap(), _CompleteWhoAmICompany_unit = new WeakMap();
+_CompleteWhoAmICompany_companyRestricted = new WeakMap(), _CompleteWhoAmICompany_countryCode = new WeakMap(), _CompleteWhoAmICompany_erpId = new WeakMap(), _CompleteWhoAmICompany_hasAccessToXcm = new WeakMap(), _CompleteWhoAmICompany_hasAccessToXcp = new WeakMap(), _CompleteWhoAmICompany_isProtected = new WeakMap(), _CompleteWhoAmICompany_marketplace = new WeakMap(), _CompleteWhoAmICompany_name = new WeakMap(), _CompleteWhoAmICompany_reference = new WeakMap(), _CompleteWhoAmICompany_tags = new WeakMap(), _CompleteWhoAmICompany_unit = new WeakMap();
 //# sourceMappingURL=CompleteWhoAmICompany.js.map

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/ArrowSphere/nodejs-api-client.git"
   },
-  "version": "3.172.0",
+  "version": "3.173.0",
   "description": "Node.js client for ArrowSphere's public API",
   "main": "build/index.js",
   "types": "build/index.d.ts",