@arrowsphere/api-client 3.167.1 → 3.168.0-rc.bdj-2

package/CHANGELOG.md

@@ -3,11 +3,6 @@
 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.167.1] - 2025.02.05
-
-### Fixed
-- [campaign] update CampaignInputType schema add field Banner and remove field Banners
-
 ## [3.167.0] - 2025.02.04
 
 ### Added

package/build/campaign/campaignClient.d.ts

@@ -22,7 +22,7 @@ export declare enum CampaignInputFields {
     COLUMN_RULES = "rules",
     COLUMN_START_DATE = "startDate",
     COLUMN_END_DATE = "endDate",
-    COLUMN_BANNER = "banner",
+    COLUMN_BANNERS = "banners",
     COLUMN_LANDING_PAGE = "landingPage"
 }
 export declare enum RulesInputFields {
@@ -41,19 +41,19 @@ export declare type RulesInputType = {
     [RulesInputFields.COLUMN_RESELLERS]?: string[];
     [RulesInputFields.COLUMN_END_CUSTOMERS]?: string[];
 };
-export declare enum BannerInputFields {
+export declare enum BannersInputFields {
     COLUMN_TYPE = "type",
     COLUMN_BUTTON_PLACEMENT = "buttonPlacement",
     COLUMN_BUTTON_TEXT = "buttonText",
     COLUMN_TEXT = "text",
     COLUMN_TEXT_COLOR = "textColor"
 }
-export declare type BannerInputType = {
-    [BannerInputFields.COLUMN_TYPE]?: string;
-    [BannerInputFields.COLUMN_BUTTON_PLACEMENT]?: string;
-    [BannerInputFields.COLUMN_BUTTON_TEXT]?: string;
-    [BannerInputFields.COLUMN_TEXT]?: string;
-    [BannerInputFields.COLUMN_TEXT_COLOR]?: string;
+export declare type BannersInputType = {
+    [BannersInputFields.COLUMN_TYPE]?: string;
+    [BannersInputFields.COLUMN_BUTTON_PLACEMENT]?: string;
+    [BannersInputFields.COLUMN_BUTTON_TEXT]?: string;
+    [BannersInputFields.COLUMN_TEXT]?: string;
+    [BannersInputFields.COLUMN_TEXT_COLOR]?: string;
 };
 export declare enum LandingPageHeaderInputFields {
     COLUMN_BACKGROUND_COLOR = "backgroundColor",
@@ -119,7 +119,7 @@ export declare type CampaignInputType = {
     [CampaignInputFields.COLUMN_RULES]?: RulesInputType;
     [CampaignInputFields.COLUMN_START_DATE]?: string;
     [CampaignInputFields.COLUMN_END_DATE]?: string;
-    [CampaignInputFields.COLUMN_BANNER]?: BannerInputType;
+    [CampaignInputFields.COLUMN_BANNERS]?: BannersInputType[];
     [CampaignInputFields.COLUMN_LANDING_PAGE]?: LandingPageInputType;
 };
 export declare type PostEmailCampaignMetadataType = {

package/build/campaign/campaignClient.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CampaignClient = exports.LandingPageInputFields = exports.LandingPageFooterInputFields = exports.LandingPageBodyInputFields = exports.LandingPageHeaderInputFields = exports.BannerInputFields = exports.RulesInputFields = exports.CampaignInputFields = exports.PostEmailCampaignFields = void 0;
+exports.CampaignClient = exports.LandingPageInputFields = exports.LandingPageFooterInputFields = exports.LandingPageBodyInputFields = exports.LandingPageHeaderInputFields = exports.BannersInputFields = exports.RulesInputFields = exports.CampaignInputFields = exports.PostEmailCampaignFields = void 0;
 const abstractRestfulClient_1 = require("../abstractRestfulClient");
 const getResult_1 = require("../getResult");
 const campaign_1 = require("./entities/campaign/campaign");
@@ -23,7 +23,7 @@ var CampaignInputFields;
     CampaignInputFields["COLUMN_RULES"] = "rules";
     CampaignInputFields["COLUMN_START_DATE"] = "startDate";
     CampaignInputFields["COLUMN_END_DATE"] = "endDate";
-    CampaignInputFields["COLUMN_BANNER"] = "banner";
+    CampaignInputFields["COLUMN_BANNERS"] = "banners";
     CampaignInputFields["COLUMN_LANDING_PAGE"] = "landingPage";
 })(CampaignInputFields = exports.CampaignInputFields || (exports.CampaignInputFields = {}));
 var RulesInputFields;
@@ -35,14 +35,14 @@ var RulesInputFields;
     RulesInputFields["COLUMN_RESELLERS"] = "resellers";
     RulesInputFields["COLUMN_END_CUSTOMERS"] = "endCustomers";
 })(RulesInputFields = exports.RulesInputFields || (exports.RulesInputFields = {}));
-var BannerInputFields;
-(function (BannerInputFields) {
-    BannerInputFields["COLUMN_TYPE"] = "type";
-    BannerInputFields["COLUMN_BUTTON_PLACEMENT"] = "buttonPlacement";
-    BannerInputFields["COLUMN_BUTTON_TEXT"] = "buttonText";
-    BannerInputFields["COLUMN_TEXT"] = "text";
-    BannerInputFields["COLUMN_TEXT_COLOR"] = "textColor";
-})(BannerInputFields = exports.BannerInputFields || (exports.BannerInputFields = {}));
+var BannersInputFields;
+(function (BannersInputFields) {
+    BannersInputFields["COLUMN_TYPE"] = "type";
+    BannersInputFields["COLUMN_BUTTON_PLACEMENT"] = "buttonPlacement";
+    BannersInputFields["COLUMN_BUTTON_TEXT"] = "buttonText";
+    BannersInputFields["COLUMN_TEXT"] = "text";
+    BannersInputFields["COLUMN_TEXT_COLOR"] = "textColor";
+})(BannersInputFields = exports.BannersInputFields || (exports.BannersInputFields = {}));
 var LandingPageHeaderInputFields;
 (function (LandingPageHeaderInputFields) {
     LandingPageHeaderInputFields["COLUMN_BACKGROUND_COLOR"] = "backgroundColor";

package/build/graphqlApi/graphqlApiClient.d.ts

@@ -1,7 +1,7 @@
 import { AbstractGraphQLClient } from '../abstractGraphQLClient';
 import { ArrowCompanyType, EndCustomerType, PartnerType } from './types/entities/company';
-import { InputPaginationType, SelectAllQueryType, SelectAllResultType, SelectOneQueryType, SelectOneResultType } from './types/graphqlApiQueries';
-import { ArrowCompanySchema, EndCustomerSchema, PartnerSchema, SelectOneResponseDataSchema } from './types/graphqlApiSchemas';
+import { GetLocalContactResultType, GetSpecialPriceRatesHistoryResultType, InputPaginationType, InputSearchFilterType, QueryVariablesType, SelectAllQueryType, SelectAllResultType, SelectOneQueryType, SelectOneResultType } from './types/graphqlApiQueries';
+import { ArrowCompanySchema, ContactsSchema, EndCustomerSchema, PageSchema, PartnerSchema, SelectOneResponseDataSchema, SpecialPriceRateSchema } from './types/graphqlApiSchemas';
 export declare class GraphqlApiClient extends AbstractGraphQLClient {
     /**
      * The Path of graphql catalog API
@@ -10,8 +10,10 @@ export declare class GraphqlApiClient extends AbstractGraphQLClient {
     find<GraphQLResponseTypes>(request: string): Promise<GraphQLResponseTypes | null>;
     selectAll(query: SelectAllQueryType): Promise<SelectAllResultType | null>;
     selectOne(query: SelectOneQueryType): Promise<SelectOneResultType | null>;
-    findOneById<T>(id: number, fieldSchema: SelectOneResponseDataSchema, pagination?: InputPaginationType): Promise<T | null>;
+    findOneById<T>(id: number, fieldSchema: SelectOneResponseDataSchema, pagination?: InputPaginationType, filters?: InputSearchFilterType, exclusionFilters?: InputSearchFilterType): Promise<T | null>;
     findEndCustomerById(id: number, fields: EndCustomerSchema, pagination?: InputPaginationType): Promise<EndCustomerType | null>;
     findPartnerById(id: number, fields: PartnerSchema, pagination?: InputPaginationType): Promise<PartnerType | null>;
     findArrowCompanyById(id: number, fields: ArrowCompanySchema, pagination?: InputPaginationType): Promise<ArrowCompanyType | null>;
+    getLocalContact(programInternalName: string, partnerId: number, fieldSchema: ContactsSchema): Promise<GetLocalContactResultType | null>;
+    getSpecialPriceRatesHistory(licenseId: number, fieldSchema: SpecialPriceRateSchema, pagination?: PageSchema, additionalParams?: QueryVariablesType): Promise<GetSpecialPriceRatesHistoryResultType | null>;
 }

package/build/graphqlApi/graphqlApiClient.js

@@ -30,27 +30,17 @@ class GraphqlApiClient extends abstractGraphQLClient_1.AbstractGraphQLClient {
         const result = await this.find(queryStr);
         return result;
     }
-    async findOneById(id, fieldSchema, pagination) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
+    async findOneById(id, fieldSchema, pagination, filters, exclusionFilters) {
+        var _a, _b, _c, _d, _e;
         const keys = Object.keys(fieldSchema);
         if (keys.length === 0) {
             return null;
         }
         const type = keys[0];
         const queryArguments = {
-            [graphqlApiQueries_1.QueryVariablesField.FILTERS]: {
-                [graphqlApiQueries_1.InputSearchFilterField.GROUPS]: [
-                    {
-                        [graphqlApiQueries_1.InputFiltersField.ITEMS]: [
-                            {
-                                [graphqlApiQueries_1.InputFilterValueField.NAME]: 'id',
-                                [graphqlApiQueries_1.InputFilterValueField.OPERATOR]: graphqlApiQueries_1.ComparisonOperator.EQUALS,
-                                [graphqlApiQueries_1.InputFilterValueField.VALUE]: [`${id}`],
-                            },
-                        ],
-                    },
-                ],
-            },
+            id,
+            filters,
+            exclusionFilters,
         };
         if ((pagination === null || pagination === void 0 ? void 0 : pagination[graphqlApiQueries_1.InputPaginationField.PER_PAGE]) ||
             (pagination === null || pagination === void 0 ? void 0 : pagination[graphqlApiQueries_1.InputPaginationField.PAGE])) {
@@ -65,7 +55,7 @@ class GraphqlApiClient extends abstractGraphQLClient_1.AbstractGraphQLClient {
             }
         }
         const query = {
-            [graphqlApiQueries_1.Queries.SELECT_ONE]: {
+            [graphqlApiQueries_1.Queries.SELECT_ONE_BY_ID]: {
                 __args: queryArguments,
                 [graphqlApiQueries_1.SelectableField.DATA]: fieldSchema,
                 [graphqlApiQueries_1.SelectableField.ERRORS]: {
@@ -75,10 +65,10 @@ class GraphqlApiClient extends abstractGraphQLClient_1.AbstractGraphQLClient {
         };
         const queryStr = this.stringifyQuery(query);
         const result = await this.find(queryStr);
-        if ((_d = (_c = (_b = result === null || result === void 0 ? void 0 : result[graphqlApiQueries_1.Queries.SELECT_ONE]) === null || _b === void 0 ? void 0 : _b[graphqlApiQueries_1.SelectableField.ERRORS]) === null || _c === void 0 ? void 0 : _c[graphqlApiQueries_1.ErrorsField.MESSAGE]) === null || _d === void 0 ? void 0 : _d.length) {
-            throw new Error((_f = (_e = result === null || result === void 0 ? void 0 : result[graphqlApiQueries_1.Queries.SELECT_ONE]) === null || _e === void 0 ? void 0 : _e[graphqlApiQueries_1.SelectableField.ERRORS]) === null || _f === void 0 ? void 0 : _f[graphqlApiQueries_1.ErrorsField.MESSAGE]);
+        if ((_c = (_b = result === null || result === void 0 ? void 0 : result[graphqlApiQueries_1.Queries.SELECT_ONE_BY_ID][graphqlApiQueries_1.SelectableField.ERRORS]) === null || _b === void 0 ? void 0 : _b[graphqlApiQueries_1.ErrorsField.MESSAGE]) === null || _c === void 0 ? void 0 : _c.length) {
+            throw new Error((_d = result === null || result === void 0 ? void 0 : result[graphqlApiQueries_1.Queries.SELECT_ONE_BY_ID][graphqlApiQueries_1.SelectableField.ERRORS]) === null || _d === void 0 ? void 0 : _d[graphqlApiQueries_1.ErrorsField.MESSAGE]);
         }
-        return (_h = (_g = result === null || result === void 0 ? void 0 : result[graphqlApiQueries_1.Queries.SELECT_ONE]) === null || _g === void 0 ? void 0 : _g[graphqlApiQueries_1.SelectableField.DATA]) === null || _h === void 0 ? void 0 : _h[type];
+        return (_e = result === null || result === void 0 ? void 0 : result[graphqlApiQueries_1.Queries.SELECT_ONE_BY_ID][graphqlApiQueries_1.SelectableField.DATA]) === null || _e === void 0 ? void 0 : _e[type];
     }
     async findEndCustomerById(id, fields, pagination) {
         return await this.findOneById(id, {
@@ -95,6 +85,41 @@ class GraphqlApiClient extends abstractGraphQLClient_1.AbstractGraphQLClient {
             [graphqlApiQueries_1.SelectDataField.ARROW_COMPANY]: fields,
         }, pagination);
     }
+    async getLocalContact(programInternalName, partnerId, fieldSchema) {
+        const query = {
+            [graphqlApiQueries_1.Queries.GET_LOCAL_CONTACT]: {
+                __args: {
+                    programInternalName,
+                    partnerId,
+                },
+                [graphqlApiQueries_1.SelectableField.DATA]: {
+                    contact: fieldSchema,
+                },
+                [graphqlApiQueries_1.SelectableField.ERRORS]: {
+                    [graphqlApiQueries_1.ErrorsField.MESSAGE]: true,
+                },
+            },
+        };
+        return await this.find(this.stringifyQuery(query));
+    }
+    async getSpecialPriceRatesHistory(licenseId, fieldSchema, pagination, additionalParams) {
+        const query = {
+            [graphqlApiQueries_1.Queries.GET_SPECIAL_PRICE_RATES_HISTORY]: {
+                __args: {
+                    licenseId,
+                    ...additionalParams,
+                },
+                [graphqlApiQueries_1.SelectableField.DATA]: {
+                    specialPriceRate: fieldSchema,
+                },
+                [graphqlApiQueries_1.SelectableField.ERRORS]: {
+                    [graphqlApiQueries_1.ErrorsField.MESSAGE]: true,
+                },
+                [graphqlApiQueries_1.SelectableField.PAGINATION]: pagination,
+            },
+        };
+        return await this.find(this.stringifyQuery(query));
+    }
 }
 exports.GraphqlApiClient = GraphqlApiClient;
 //# sourceMappingURL=graphqlApiClient.js.map

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

@@ -1,13 +1,15 @@
 import { ArrowCompanyType, EndCustomerType, PartnerType } from './entities/company';
+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 { QuoteType } from './entities/quote';
+import { SpecialPriceRateType } from './entities/specialPriceRate';
 import { SubscriptionType } from './entities/subscription';
 import { UserHistoryType, UserType } from './entities/user';
 import { WorkgroupType } from './entities/workgroup';
-import { ErrorsSchema, PageSchema, SelectAllResponseDataSchema, SelectOneResponseDataSchema } from './graphqlApiSchemas';
+import { ContactsSchema, ErrorsSchema, PageSchema, SelectAllResponseDataSchema, SelectOneResponseDataSchema, SpecialPriceRateSchema } from './graphqlApiSchemas';
 /**
  * For field __args
  */
@@ -113,6 +115,7 @@ export declare enum SelectableField {
 }
 export declare enum SelectDataField {
     ARROW_COMPANY = "arrowCompany",
+    CONTACT = "contact",
     CONTINENT = "continent",
     COUNTRY = "country",
     END_CUSTOMER = "endCustomer",
@@ -121,6 +124,7 @@ export declare enum SelectDataField {
     PARTNERTAG = "partnertag",
     PROGRAM = "program",
     QUOTE = "quote",
+    SPECIAL_PRICE_RATE = "specialPriceRate",
     SUBSCRIBED_PROGRAM = "subscribedProgram",
     SUBSCRIPTION = "subscription",
     USER = "user",
@@ -183,6 +187,29 @@ export declare type SelectOneResultType = {
         [SelectableField.PAGINATION]?: PageType;
     };
 };
+export declare type SelectOneByIdResultType = {
+    [Queries.SELECT_ONE_BY_ID]: {
+        [SelectableField.DATA]?: SelectOneResponseDataType;
+        [SelectableField.ERRORS]?: ErrorsType;
+        [SelectableField.PAGINATION]?: PageType;
+    };
+};
+export declare type GetLocalContactResultType = {
+    [Queries.GET_LOCAL_CONTACT]: {
+        [SelectableField.DATA]?: {
+            [SelectDataField.CONTACT]: ContactsType;
+        };
+        [SelectableField.ERRORS]?: ErrorsType;
+    };
+};
+export declare type GetSpecialPriceRatesHistoryResultType = {
+    [Queries.GET_SPECIAL_PRICE_RATES_HISTORY]: {
+        [SelectableField.DATA]?: {
+            [SelectDataField.SPECIAL_PRICE_RATE]: SpecialPriceRateType;
+        };
+        [SelectableField.ERRORS]?: ErrorsType;
+    };
+};
 export declare type SelectOneResponseDataType = {
     [SelectDataField.ARROW_COMPANY]?: ArrowCompanyType;
     [SelectDataField.CONTINENT]?: ContinentType;
@@ -217,10 +244,27 @@ export declare type QueryVariablesType = {
     [QueryVariablesField.SORT]?: InputSortFilterType[];
     [QueryVariablesField.OPTIONS]?: InputQueryOptionsType;
 };
+export declare type SelectOneByIdQueryVariablesType = {
+    id: number;
+    [QueryVariablesField.EXCLUSION_FILTERS]?: InputSearchFilterType;
+    [QueryVariablesField.FILTERS]?: InputSearchFilterType;
+    [QueryVariablesField.PAGINATION]?: InputPaginationType;
+};
 export declare enum Queries {
     SELECT_ALL = "selectAll",
-    SELECT_ONE = "selectOne"
+    SELECT_ONE = "selectOne",
+    SELECT_ONE_BY_ID = "selectOneById",
+    GET_LOCAL_CONTACT = "getLocalContact",
+    GET_SPECIAL_PRICE_RATES_HISTORY = "getSpecialPriceRatesHistory"
 }
+export declare type SelectAllQueryType = {
+    [Queries.SELECT_ALL]: {
+        __args?: QueryVariablesType;
+        [SelectableField.DATA]: SelectAllResponseDataSchema;
+        [SelectableField.ERRORS]?: ErrorsSchema;
+        [SelectableField.PAGINATION]?: PageSchema;
+    };
+};
 export declare type SelectOneQueryType = {
     [Queries.SELECT_ONE]: {
         __args?: QueryVariablesType;
@@ -229,10 +273,34 @@ export declare type SelectOneQueryType = {
         [SelectableField.PAGINATION]?: PageSchema;
     };
 };
-export declare type SelectAllQueryType = {
-    [Queries.SELECT_ALL]: {
-        __args?: QueryVariablesType;
-        [SelectableField.DATA]: SelectAllResponseDataSchema;
+export declare type SelectOneByIdQueryType = {
+    [Queries.SELECT_ONE_BY_ID]: {
+        __args: SelectOneByIdQueryVariablesType;
+        [SelectableField.DATA]: SelectOneResponseDataSchema;
+        [SelectableField.ERRORS]?: ErrorsSchema;
+        [SelectableField.PAGINATION]?: PageSchema;
+    };
+};
+export declare type GetLocalContactQueryType = {
+    [Queries.GET_LOCAL_CONTACT]: {
+        __args: {
+            programInternalName: string;
+            partnerId: number;
+        };
+        [SelectableField.DATA]: {
+            [SelectDataField.CONTACT]: ContactsSchema;
+        };
+        [SelectableField.ERRORS]?: ErrorsSchema;
+    };
+};
+export declare type GetSpecialPriceRatesHistoryQueryType = {
+    [Queries.GET_SPECIAL_PRICE_RATES_HISTORY]: {
+        __args: {
+            licenseId: number;
+        } & QueryVariablesType;
+        [SelectableField.DATA]: {
+            [SelectDataField.SPECIAL_PRICE_RATE]: SpecialPriceRateSchema;
+        };
         [SelectableField.ERRORS]?: ErrorsSchema;
         [SelectableField.PAGINATION]?: PageSchema;
     };

package/build/graphqlApi/types/graphqlApiQueries.js

@@ -91,6 +91,7 @@ var SelectableField;
 var SelectDataField;
 (function (SelectDataField) {
     SelectDataField["ARROW_COMPANY"] = "arrowCompany";
+    SelectDataField["CONTACT"] = "contact";
     SelectDataField["CONTINENT"] = "continent";
     SelectDataField["COUNTRY"] = "country";
     SelectDataField["END_CUSTOMER"] = "endCustomer";
@@ -99,6 +100,7 @@ var SelectDataField;
     SelectDataField["PARTNERTAG"] = "partnertag";
     SelectDataField["PROGRAM"] = "program";
     SelectDataField["QUOTE"] = "quote";
+    SelectDataField["SPECIAL_PRICE_RATE"] = "specialPriceRate";
     SelectDataField["SUBSCRIBED_PROGRAM"] = "subscribedProgram";
     SelectDataField["SUBSCRIPTION"] = "subscription";
     SelectDataField["USER"] = "user";
@@ -134,5 +136,8 @@ var Queries;
 (function (Queries) {
     Queries["SELECT_ALL"] = "selectAll";
     Queries["SELECT_ONE"] = "selectOne";
+    Queries["SELECT_ONE_BY_ID"] = "selectOneById";
+    Queries["GET_LOCAL_CONTACT"] = "getLocalContact";
+    Queries["GET_SPECIAL_PRICE_RATES_HISTORY"] = "getSpecialPriceRatesHistory";
 })(Queries = exports.Queries || (exports.Queries = {}));
 //# sourceMappingURL=graphqlApiQueries.js.map

package/package.json

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