@arrowsphere/api-client 3.67.0 → 3.68.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 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.68.0] - 2023-11-21
+
+### Changed
+- [Well Architected] Add ExtraDataType to Checks
+- [Well Architected] Add Status type to Standard
+- [Well Architected] Pass a header with getVendorStatus for the register/check endpoint
+
+
 ## [3.67.0] - 2023-11-17
 
 ### Changed

package/build/abstractRestfulClient.d.ts

@@ -31,6 +31,39 @@ export declare type Options = {
     isAdmin?: boolean;
     returnAxiosData?: boolean;
 };
+export declare type RegisterCheckReturnSyncStatusError = {
+    statusCode?: number;
+    message?: string;
+};
+export declare type RegisterCheckReturnVendorStatus = {
+    code?: string;
+    message?: string;
+};
+export declare type RegisterCheckReturnSyncStatus = {
+    syncData?: string;
+    cost?: RegisterCheckReturnSyncStatusError;
+    security?: RegisterCheckReturnSyncStatusError;
+    sustainability?: RegisterCheckReturnSyncStatusError;
+};
+export declare type RegisterCheckReturnData = {
+    accountReference?: string;
+    creationDate?: string;
+    classification?: string;
+    customerReference?: string;
+    customerName?: string;
+    resellerReference?: string;
+    resellerName?: string;
+    subscriptionReference?: string;
+    marketplace?: string;
+    vendorSubscriptionId?: string;
+    vendorCode?: string;
+    syncStatus?: RegisterCheckReturnSyncStatus;
+    vendorStatus?: RegisterCheckReturnVendorStatus;
+};
+export declare type CheckStatusReturn = {
+    status?: number;
+    data?: RegisterCheckReturnData;
+};
 export declare type ConfigurationsClient = {
     [ParameterKeys.API_KEY]?: string;
     [ParameterKeys.URL]?: string;

package/build/wellArchitected/register/registerClient.d.ts

@@ -1,4 +1,4 @@
-import { AbstractRestfulClient, Parameters } from '../../abstractRestfulClient';
+import { AbstractRestfulClient, CheckStatusReturn, Parameters } from '../../abstractRestfulClient';
 import { GetResult } from '../../getResult';
 import { RegistrationLink } from './entity/registrationLink';
 export declare class WellArchitectedRegisterClient extends AbstractRestfulClient {
@@ -8,6 +8,6 @@ export declare class WellArchitectedRegisterClient extends AbstractRestfulClient
     protected basePath: string;
     register(subscriptionReference: string, parameters?: Parameters): Promise<GetResult<RegistrationLink>>;
     deregister(subscriptionReference: string, parameters?: Parameters): Promise<void>;
-    checkRegister(subscriptionReference: string, parameters?: Parameters): Promise<void>;
+    checkRegister(subscriptionReference: string, parameters?: Parameters, getVendorStatus?: boolean): Promise<CheckStatusReturn>;
     triggerAsynchronousUpdate(subscriptionReference: string, parameters?: Parameters): Promise<void>;
 }

package/build/wellArchitected/register/registerClient.js

@@ -20,8 +20,11 @@ class WellArchitectedRegisterClient extends abstractRestfulClient_1.AbstractRest
         this.path = `/${subscriptionReference}/deregister`;
         return await this.post(parameters);
     }
-    async checkRegister(subscriptionReference, parameters = {}) {
+    async checkRegister(subscriptionReference, parameters = {}, getVendorStatus) {
         this.path = `/${subscriptionReference}/register/check`;
+        if (getVendorStatus) {
+            this.setHeaders({ getVendorStatus: 'true' });
+        }
         return await this.get(parameters);
     }
     async triggerAsynchronousUpdate(subscriptionReference, parameters = {}) {

package/build/wellArchitected/types/wellArchitectedGraphQLTypes.d.ts

@@ -39,8 +39,18 @@ export declare type RegistrationType = {
     subscription?: SubscriptionRegistrationType;
     vendorCode?: string;
 };
+export declare type ExtraDataType = {
+    name?: string;
+    numberValue?: number;
+    value?: string;
+};
+export declare type StatusType = {
+    code: number;
+    message: string;
+};
 export declare type CheckType = {
     description?: string;
+    extraData?: ExtraDataType[];
     flagged?: number;
     group?: string;
     hasResources?: boolean;
@@ -60,6 +70,7 @@ export declare type StandardType = {
     passed?: number;
     reference?: string;
     score?: number;
+    status?: StatusType;
     total?: number;
 };
 export declare type AccountType = {
@@ -318,7 +329,9 @@ export declare type MarketplacesAggType = {
  */
 export declare type CheckByDateType = {
     date?: string;
+    extraData?: ExtraDataType[];
     flagged?: number;
+    group?: string;
     hasResources?: boolean;
     isFailed?: boolean;
     name?: string;

package/package.json

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