@arrowsphere/api-client 3.39.0 → 3.40.0-rc-jpb.1

package/CHANGELOG.md

@@ -3,6 +3,15 @@
 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.40.0] - 2023-06-20
+
+### Changed
+
+- Refactor find products by query
+- Add find one priceBand by query
+- Add find one product by query
+- Add fetch promotions
+
 ## [3.39.0] - 2023-06-20
 
 ### Changed

package/build/catalog/catalogGraphQLClient.d.ts

@@ -1,6 +1,6 @@
 import { AbstractGraphQLClient } from '../abstractGraphQLClient';
-import { GetProductsType } from './types/catalogGraphQLTypes';
-import { CatalogQuery } from './types/catalogGraphQLQueries';
+import { GetPriceBandType, GetProductsType, GetProductType } from './types/catalogGraphQLTypes';
+import { CatalogQueries, CatalogQuery } from './types/catalogGraphQLQueries';
 export declare class CatalogGraphQLClient extends AbstractGraphQLClient {
     /**
      * The base path of the API
@@ -11,5 +11,12 @@ export declare class CatalogGraphQLClient extends AbstractGraphQLClient {
      */
     private GRAPHQL;
     find(request: string): Promise<GetProductsType>;
+    /**
+     * @deprecated
+     * Prefer using findProductsByQuery instead.
+     */
     findByQuery(query: CatalogQuery): Promise<GetProductsType | null>;
+    findProductsByQuery(query: Pick<CatalogQueries, 'getProducts'>): Promise<GetProductsType | null>;
+    findOneProductByQuery(query: Pick<CatalogQueries, 'product'>): Promise<GetProductType | null>;
+    findOnePriceBandByQuery(query: Pick<CatalogQueries, 'priceBand'>): Promise<GetPriceBandType | null>;
 }

package/build/catalog/catalogGraphQLClient.js

@@ -18,6 +18,10 @@ class CatalogGraphQLClient extends abstractGraphQLClient_1.AbstractGraphQLClient
         this.path = this.GRAPHQL;
         return await this.post(request);
     }
+    /**
+     * @deprecated
+     * Prefer using findProductsByQuery instead.
+     */
     async findByQuery(query) {
         const queryStr = this.stringifyQuery(query);
         try {
@@ -32,6 +36,50 @@ class CatalogGraphQLClient extends abstractGraphQLClient_1.AbstractGraphQLClient
         }
         return null;
     }
+    async findProductsByQuery(query) {
+        const queryStr = this.stringifyQuery(query);
+        try {
+            return await this.find(queryStr);
+        }
+        catch (error) {
+            const exception = this.mapToPublicApiException(error);
+            const { mustRetry } = await this.handleError(exception);
+            if (mustRetry) {
+                return await this.find(queryStr);
+            }
+        }
+        return null;
+    }
+    async findOneProductByQuery(query) {
+        this.path = this.GRAPHQL;
+        const queryStr = this.stringifyQuery(query);
+        try {
+            return await this.post(queryStr);
+        }
+        catch (error) {
+            const exception = this.mapToPublicApiException(error);
+            const { mustRetry } = await this.handleError(exception);
+            if (mustRetry) {
+                return await this.post(queryStr);
+            }
+        }
+        return null;
+    }
+    async findOnePriceBandByQuery(query) {
+        this.path = this.GRAPHQL;
+        const queryStr = this.stringifyQuery(query);
+        try {
+            return await this.post(queryStr);
+        }
+        catch (error) {
+            const exception = this.mapToPublicApiException(error);
+            const { mustRetry } = await this.handleError(exception);
+            if (mustRetry) {
+                return await this.post(queryStr);
+            }
+        }
+        return null;
+    }
 }
 exports.CatalogGraphQLClient = CatalogGraphQLClient;
 //# sourceMappingURL=catalogGraphQLClient.js.map

package/build/catalog/types/FindOneProductQueryOutput.d.ts

@@ -0,0 +1,7 @@
+import { PriceBandType, ProductType } from './catalogGraphQLTypes';
+export declare type FindOneProductQueryOutput = {
+    product: ProductType;
+};
+export declare type FindOnePriceBandQueryOutput = {
+    priceBand: PriceBandType;
+};

package/build/catalog/types/FindOneProductQueryOutput.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=FindOneProductQueryOutput.js.map

package/build/catalog/types/catalogGraphQLQueries.d.ts

@@ -1,12 +1,31 @@
-import { QueryArguments } from './queryArguments';
-import { FiltersSchema, PaginationSchema, ProductSchema } from './catalogGraphQLSchemas';
+import { QueryPriceBandArguments, QueryProductArguments } from './queryProductArguments';
+import { FiltersSchema, PaginationSchema, PriceBandSchema, ProductSchema } from './catalogGraphQLSchemas';
+import { Merge } from 'type-fest';
+/**
+ * @deprecated
+ * Prefer using CatalogQueries instead.
+ */
 export declare type CatalogQuery = {
     getProducts: GetPaginatedProductsQuery;
 };
+/**
+ * Represent the Catalog Schema of Public API
+ */
+export declare type CatalogQueries = {
+    getProducts?: GetPaginatedProductsQuery;
+    priceBand?: GetPriceBandQuery;
+    product?: GetProductQuery;
+};
 export declare type GetPaginatedProductsQuery = {
-    __args: QueryArguments;
+    __args: QueryProductArguments;
     filters?: FiltersSchema;
     pagination?: PaginationSchema;
     products?: ProductSchema;
     topOffers?: ProductSchema;
 };
+export declare type GetProductQuery = Merge<{
+    __args: QueryProductArguments;
+}, ProductSchema>;
+export declare type GetPriceBandQuery = Merge<{
+    __args: QueryPriceBandArguments;
+}, PriceBandSchema>;

package/build/catalog/types/catalogGraphQLSchemas.d.ts

@@ -1,9 +1,10 @@
-import { AttributeType, FiltersType, IdentifiersType, PaginationType, PriceBandType, PricesType, ProductType, RelatedOfferType } from './catalogGraphQLTypes';
+import { AttributeType, FiltersType, IdentifiersType, PaginationType, PriceBandType, PricesType, ProductType, PromotionType, RelatedOfferType } from './catalogGraphQLTypes';
 import { Merge, Schema } from 'type-fest';
 export declare type PaginationSchema = Schema<PaginationType, boolean>;
 export declare type FiltersSchema = Schema<FiltersType, boolean>;
 declare type IdentifiersSchema = Schema<IdentifiersType, boolean>;
 declare type RelatedOfferSchema = Schema<RelatedOfferType, boolean>;
+declare type PromotionSchema = Schema<PromotionType, boolean>;
 /**
  * Field of type array are not handled by Schema, they must be overwritten
  */
@@ -13,6 +14,7 @@ declare type MissingFieldsOfProductSchema = {
     conversionOfferPrimaries?: IdentifiersSchema;
     relatedOffers?: RelatedOfferSchema;
     priceBand?: PriceBandSchema;
+    promotions?: PromotionSchema;
 };
 export declare type ProductSchema = Merge<Schema<ProductType, boolean>, MissingFieldsOfProductSchema>;
 declare type AttributeSchema = Schema<AttributeType, boolean>;
@@ -20,7 +22,7 @@ declare type AttributeSchema = Schema<AttributeType, boolean>;
  * Field of type array are not handled by Schema, they must be overwritten
  */
 declare type MissingFieldsOfPriceBandSchema = {
-    attributes?: Array<AttributeSchema>;
+    attributes?: AttributeSchema;
 };
 /**
  * No type corresponding

package/build/catalog/types/catalogGraphQLTypes.d.ts

@@ -1,6 +1,12 @@
 export declare type GetProductsType = {
     getProducts?: PaginatedProductsType;
 };
+export declare type GetProductType = {
+    product?: ProductType;
+};
+export declare type GetPriceBandType = {
+    priceBand?: PriceBandType;
+};
 export declare type PaginatedProductsType = {
     filters?: Array<FiltersType>;
     pagination?: PaginationType;
@@ -40,6 +46,7 @@ export declare type ProductType = {
     baseOfferPrimaries?: Array<IdentifiersType>;
     assets?: AssetsType;
     environmentAvailability?: string;
+    promotions?: Array<PromotionType>;
     marketplace?: string;
     isEnabled?: boolean;
     isTrial?: boolean;
@@ -153,6 +160,8 @@ export declare type PriceBandType = {
     prices?: PricesType;
     saleConstraints?: PriceBandSaleConstraintsType;
     uom?: UomType;
+    promotionPrices?: PromotionPricesType;
+    vendor?: VendorType;
 };
 export declare type PriceBandActionFlagsType = {
     canBeCancelled?: boolean;
@@ -171,10 +180,10 @@ export declare type BillingType = {
     type?: string;
 };
 export declare type DynamicAttributesType = {
-    diskSize?: string;
-    ram?: string;
     region?: string;
     vCpu?: string;
+    ram?: string;
+    diskSize?: string;
     reservationsAutofitGroup?: string;
     acu?: string;
     marketSegment?: string;
@@ -200,6 +209,7 @@ export declare type PricesType = {
     buy?: string;
     sell?: string;
     public?: string;
+    vendorPricingSource?: VendorPricingSourceType;
 };
 export declare type PriceBandSaleConstraintsType = {
     availableDate?: string;
@@ -222,3 +232,32 @@ export declare type OfferResellersType = {
 export declare type ResellerType = {
     xspRef?: string;
 };
+export declare type PromotionPricesType = {
+    promotionId?: string;
+    prices?: PricesType;
+};
+export declare type VendorPricingSourceType = {
+    currency?: string;
+    changeRate?: number;
+    prices?: PricesType;
+};
+export declare type PromotionType = {
+    promotionId?: string;
+    vendorSku?: string;
+    marketplace?: string;
+    name?: string;
+    description?: string;
+    isAutoApplicable?: boolean;
+    startDate?: string;
+    endDate?: string;
+    promotionType?: string;
+    pricingType?: string;
+    pricingValue?: number;
+    billing?: BillingType;
+    minQuantity?: number;
+    maxQuantity?: number;
+    currency?: string;
+    applicableUntil?: string;
+    applicableFor?: number;
+    checkEligibility?: boolean;
+};

package/build/catalog/types/{queryArguments.d.ts → queryProductArguments.d.ts}

@@ -1,14 +1,35 @@
 /**
  * For field __args
  */
-export declare type QueryArguments = {
+export declare type QueryProductArguments = {
     paginate?: PaginateArgument;
     searchBody: SearchBodyArgument;
 };
+/**
+ * For field __args
+ */
+export declare type QueryPriceBandArguments = {
+    paginate?: PaginateArgument;
+    searchBody: SearchBodyPriceBandsArgument;
+};
 export declare type PaginateArgument = {
     page: number;
     perPage: number;
 };
+export declare type SearchBodyPriceBandsArgument = {
+    keywords?: string;
+    filters?: SearchFilterArgument[];
+    exclusionFilters?: SearchFilterArgument[];
+    sort?: SortArgument;
+    highlight?: boolean;
+    aggregatorFilter?: string[];
+    marketplace?: string;
+    resellerRef?: string;
+    endCustomerRef?: string;
+    restricted?: boolean;
+    getFamilies?: boolean;
+    quantity?: number;
+};
 export declare type SearchBodyArgument = {
     aggregatorFilter?: string[];
     endCustomerRef?: string;

package/build/catalog/types/{queryArguments.js → queryProductArguments.js}

@@ -7,4 +7,4 @@ var OperatorArgument;
     OperatorArgument["AND"] = "AND";
     OperatorArgument["BETWEEN"] = "BETWEEN";
 })(OperatorArgument = exports.OperatorArgument || (exports.OperatorArgument = {}));
-//# sourceMappingURL=queryArguments.js.map
+//# sourceMappingURL=queryProductArguments.js.map

package/package.json

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