@companieshouse/api-sdk-node 2.0.153 → 2.0.155

package/dist/client.d.ts

@@ -25,6 +25,7 @@ import RegisteredEmailAddressService from "./services/registered-email-address/s
 import { ClientType } from "./enums";
 import { PostcodeLookupService } from "./services/postcode-lookup";
 import PscVerificationService from "./services/psc-verification-link/service";
+import { AccountsFilingService } from "./services/accounts-filing";
 /**
  * ApiClient is the class that all service objects hang off.
  */
@@ -62,5 +63,6 @@ export default class ApiClient {
     readonly officerFiling: OfficerFilingService;
     readonly postCodeLookup: PostcodeLookupService;
     readonly pscVerificationService: PscVerificationService;
+    readonly accountsFilingService: AccountsFilingService;
     constructor(apiClient: IHttpClient, accountClient: IHttpClient);
 }

package/dist/client.js

@@ -28,6 +28,7 @@ const service_16 = __importDefault(require("./services/officer-filing/service"))
 const service_17 = __importDefault(require("./services/registered-email-address/service"));
 const postcode_lookup_1 = require("./services/postcode-lookup");
 const service_18 = __importDefault(require("./services/psc-verification-link/service"));
+const accounts_filing_1 = require("./services/accounts-filing");
 /**
  * ApiClient is the class that all service objects hang off.
  */
@@ -68,6 +69,7 @@ class ApiClient {
         this.registeredEmailAddressService = new service_17.default(apiClient);
         this.postCodeLookup = new postcode_lookup_1.PostcodeLookupService(apiClient);
         this.pscVerificationService = new service_18.default(apiClient);
+        this.accountsFilingService = new accounts_filing_1.AccountsFilingService(apiClient);
     }
 }
 exports.default = ApiClient;

package/dist/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;AACA,kFAAyE;AACzE,iFAAuE;AACvE,iFAAuE;AACvE,6EAA+D;AAC/D,wCAA0D;AAC1D,6CAO2B;AAC3B,iDAAqD;AACrD,wFAAoF;AACpF,4DAA+D;AAC/D,wFAA8E;AAC9E,4FAAsF;AACtF,yFAAgF;AAChF,mFAAyE;AACzE,2FAAwF;AACxF,8EAAgE;AAChE,yFAAoF;AACpF,8EAAiF;AACjF,oEAAqE;AACrE,8DAAwE;AACxE,mFAAmE;AACnE,sFAAyE;AACzE,iFAAqE;AACrE,2FAAwF;AAExF,gEAAmE;AACnE,wFAA8E;AAE9E;;GAEG;AACH,MAAqB,SAAS;IAiC5B,YAAsB,SAAsB,EAAW,aAA0B;QAA3D,cAAS,GAAT,SAAS,CAAa;QAAW,kBAAa,GAAb,aAAa,CAAa;QAC7E,iDAAiD;QACjD,IAAI,CAAC,mBAAmB,GAAG,IAAI,8BAAwB,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,IAAI,iBAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,oBAAoB,GAAG,IAAI,iBAA2B,CAAC,SAAS,CAAC,CAAC;QACvE,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,UAAU,GAAG,IAAI,iBAAiB,CAAC,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,oBAAoB,GAAG,IAAI,kBAA2B,CAAC,SAAS,CAAC,CAAC;QACvE,IAAI,CAAC,4BAA4B,GAAG,IAAI,qDAA4B,CAAC,SAAS,CAAC,CAAC;QAChF,IAAI,CAAC,WAAW,GAAG,IAAI,0BAAkB,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,eAAe,GAAG,IAAI,8BAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,MAAM,GAAG,IAAI,qBAAa,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,GAAG,IAAI,wBAAc,CAAC,SAAS,CAAC,CAAC,CAAC,6EAA6E;QAC3H,IAAI,CAAC,QAAQ,GAAG,IAAI,uBAAe,CAAC,SAAS,CAAC,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,IAAI,kBAAmB,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,GAAG,IAAI,oBAAY,CAAC,SAAS,CAAC,CAAC;QACzC,IAAI,CAAC,SAAS,GAAG,IAAI,kBAAgB,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,CAAC,aAAa,GAAG,IAAI,kBAAoB,CAAC,SAAS,CAAC,CAAC;QACzD,IAAI,CAAC,qBAAqB,GAAG,IAAI,gCAAqB,CAAC,SAAS,CAAC,CAAC;QAClE,IAAI,CAAC,GAAG,GAAG,IAAI,kBAAU,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,CAAC,kBAAkB,GAAG,IAAI,iBAAyB,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,IAAI,iBAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,cAAc,GAAG,IAAI,yCAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,iEAAiE;QACjE,4DAA4D;QAC5D,IAAI,CAAC,YAAY,GAAG,IAAI,mCAAmB,CAAC,aAAa,CAAC,CAAC;QAC3D,IAAI,CAAC,gBAAgB,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,oBAAoB,GAAG,IAAI,kBAA6B,CAAC,SAAS,CAAC,CAAC;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,6BAA6B,GAAG,IAAI,kBAA6B,CAAC,SAAS,CAAC,CAAC;QAClF,IAAI,CAAC,cAAc,GAAG,IAAI,uCAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,sBAAsB,GAAG,IAAI,kBAAsB,CAAC,SAAS,CAAC,CAAC;IACxE,CAAC;CACF;AApED,4BAoEC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;AACA,kFAAyE;AACzE,iFAAuE;AACvE,iFAAuE;AACvE,6EAA+D;AAC/D,wCAA0D;AAC1D,6CAO2B;AAC3B,iDAAqD;AACrD,wFAAoF;AACpF,4DAA+D;AAC/D,wFAA8E;AAC9E,4FAAsF;AACtF,yFAAgF;AAChF,mFAAyE;AACzE,2FAAwF;AACxF,8EAAgE;AAChE,yFAAoF;AACpF,8EAAiF;AACjF,oEAAqE;AACrE,8DAAwE;AACxE,mFAAmE;AACnE,sFAAyE;AACzE,iFAAqE;AACrE,2FAAwF;AAExF,gEAAmE;AACnE,wFAA8E;AAC9E,gEAAmE;AAEnE;;GAEG;AACH,MAAqB,SAAS;IAkC5B,YAAsB,SAAsB,EAAW,aAA0B;QAA3D,cAAS,GAAT,SAAS,CAAa;QAAW,kBAAa,GAAb,aAAa,CAAa;QAC7E,iDAAiD;QACjD,IAAI,CAAC,mBAAmB,GAAG,IAAI,8BAAwB,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,IAAI,iBAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,oBAAoB,GAAG,IAAI,iBAA2B,CAAC,SAAS,CAAC,CAAC;QACvE,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,UAAU,GAAG,IAAI,iBAAiB,CAAC,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,oBAAoB,GAAG,IAAI,kBAA2B,CAAC,SAAS,CAAC,CAAC;QACvE,IAAI,CAAC,4BAA4B,GAAG,IAAI,qDAA4B,CAAC,SAAS,CAAC,CAAC;QAChF,IAAI,CAAC,WAAW,GAAG,IAAI,0BAAkB,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,eAAe,GAAG,IAAI,8BAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,MAAM,GAAG,IAAI,qBAAa,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,GAAG,IAAI,wBAAc,CAAC,SAAS,CAAC,CAAC,CAAC,6EAA6E;QAC3H,IAAI,CAAC,QAAQ,GAAG,IAAI,uBAAe,CAAC,SAAS,CAAC,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,IAAI,kBAAmB,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,GAAG,IAAI,oBAAY,CAAC,SAAS,CAAC,CAAC;QACzC,IAAI,CAAC,SAAS,GAAG,IAAI,kBAAgB,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,CAAC,aAAa,GAAG,IAAI,kBAAoB,CAAC,SAAS,CAAC,CAAC;QACzD,IAAI,CAAC,qBAAqB,GAAG,IAAI,gCAAqB,CAAC,SAAS,CAAC,CAAC;QAClE,IAAI,CAAC,GAAG,GAAG,IAAI,kBAAU,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,CAAC,kBAAkB,GAAG,IAAI,iBAAyB,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,IAAI,iBAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,cAAc,GAAG,IAAI,yCAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,iEAAiE;QACjE,4DAA4D;QAC5D,IAAI,CAAC,YAAY,GAAG,IAAI,mCAAmB,CAAC,aAAa,CAAC,CAAC;QAC3D,IAAI,CAAC,gBAAgB,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,oBAAoB,GAAG,IAAI,kBAA6B,CAAC,SAAS,CAAC,CAAC;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,6BAA6B,GAAG,IAAI,kBAA6B,CAAC,SAAS,CAAC,CAAC;QAClF,IAAI,CAAC,cAAc,GAAG,IAAI,uCAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,sBAAsB,GAAG,IAAI,kBAAsB,CAAC,SAAS,CAAC,CAAC;QACpE,IAAI,CAAC,qBAAqB,GAAG,IAAI,uCAAqB,CAAC,SAAS,CAAC,CAAC;IACtE,CAAC;CACF;AAtED,4BAsEC"}

package/dist/config.d.ts

@@ -1,2 +1,3 @@
 export declare const API_URL: string;
 export declare const ACCOUNT_URL: string;
+export declare const REQUEST_ID_HEADER = "X-Request-Id";

package/dist/config.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ACCOUNT_URL = exports.API_URL = void 0;
+exports.REQUEST_ID_HEADER = exports.ACCOUNT_URL = exports.API_URL = void 0;
 exports.API_URL = process.env.API_URL || "https://api.companieshouse.gov.uk";
 exports.ACCOUNT_URL = process.env.ACCOUNT_URL || "https://account.companieshouse.gov.uk";
+// Header used to correlate logs between services.
+// This will be used as the context key for logging.
+exports.REQUEST_ID_HEADER = "X-Request-Id";
 //# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,mCAAmC,CAAC;AACrE,QAAA,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,uCAAuC,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,mCAAmC,CAAC;AACrE,QAAA,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,uCAAuC,CAAC;AAE9F,kDAAkD;AAClD,oDAAoD;AACvC,QAAA,iBAAiB,GAAG,cAAc,CAAC"}

package/dist/services/account-validator/types.d.ts

@@ -0,0 +1,29 @@
+import { PackageType } from "../accounts-filing/types";
+export interface AccountValidatorRequest {
+    fileName: string;
+    id: string;
+    packageType?: PackageType;
+}
+export interface Data {
+    balanceSheetDate: string;
+    accountsType: string;
+    companieshouseRegisteredNumber: string;
+}
+export interface ErrorMessage {
+    errorMessage: string;
+}
+export interface Result {
+    errorMessages: ErrorMessage[];
+    data: Data;
+    validationStatus: ValidationStatus;
+}
+export interface AccountValidatorResponse {
+    status: RequestStatus;
+    result: Result;
+    fileId: string;
+    fileName: string;
+}
+declare type RequestStatus = "complete" | "pending" | "error";
+declare type ValidationStatus = "OK" | "FAILED";
+export declare function isAccountValidatorResponse(object: any): object is AccountValidatorResponse;
+export {};

package/dist/services/account-validator/types.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAccountValidatorResponse = void 0;
+function isAccountValidatorResponse(object) {
+    if (typeof object.status !== "string" ||
+        typeof object.fileId !== "string" ||
+        typeof object.fileName !== "string") {
+        return false;
+    }
+    if (!["complete", "pending", "error"].includes(object.status)) {
+        return false;
+    }
+    if (typeof object.result !== "object" || object.result === null) {
+        return false;
+    }
+    const { errorMessages, data, validationStatus } = object.result;
+    if ((errorMessages !== undefined && !Array.isArray(errorMessages)) ||
+        typeof data !== "object" ||
+        typeof validationStatus !== "string") {
+        return false;
+    }
+    if (!["OK", "FAILED"].includes(validationStatus)) {
+        return false;
+    }
+    if (typeof data.balance_sheet_date !== "string" ||
+        typeof data.accounts_type !== "string" ||
+        typeof data.companieshouse_registered_number !== "string") {
+        return false;
+    }
+    for (const errorMessage of errorMessages !== null && errorMessages !== void 0 ? errorMessages : []) {
+        if (typeof errorMessage !== "object" || errorMessage === null) {
+            return false;
+        }
+        if (typeof errorMessage.errorMessage !== "string") {
+            return false;
+        }
+    }
+    return true;
+}
+exports.isAccountValidatorResponse = isAccountValidatorResponse;
+//# sourceMappingURL=types.js.map

package/dist/services/account-validator/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/account-validator/types.ts"],"names":[],"mappings":";;;AAkCA,SAAgB,0BAA0B,CAAE,MAAW;IACnD,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ;QACjC,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ;QACjC,OAAO,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE;QACrC,OAAO,KAAK,CAAC;KAChB;IAED,IAAI,CAAC,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;QAC3D,OAAO,KAAK,CAAC;KAChB;IAED,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,KAAK,IAAI,EAAE;QAC7D,OAAO,KAAK,CAAC;KAChB;IAED,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC;IAChE,IAAI,CAAC,aAAa,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9D,OAAO,IAAI,KAAK,QAAQ;QACxB,OAAO,gBAAgB,KAAK,QAAQ,EAAE;QACtC,OAAO,KAAK,CAAC;KAChB;IAED,IAAI,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE;QAC9C,OAAO,KAAK,CAAC;KAChB;IAED,IAAI,OAAO,IAAI,CAAC,kBAAkB,KAAK,QAAQ;QAC5C,OAAO,IAAI,CAAC,aAAa,KAAK,QAAQ;QACtC,OAAO,IAAI,CAAC,gCAAgC,KAAK,QAAQ,EAAE;QAC1D,OAAO,KAAK,CAAC;KAChB;IAED,KAAK,MAAM,YAAY,IAAI,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,EAAE,EAAE;QAC5C,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,KAAK,IAAI,EAAE;YAC3D,OAAO,KAAK,CAAC;SAChB;QACD,IAAI,OAAO,YAAY,CAAC,YAAY,KAAK,QAAQ,EAAE;YAC/C,OAAO,KAAK,CAAC;SAChB;KACJ;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AA1CD,gEA0CC"}

package/dist/services/accounts-filing/index.d.ts

@@ -0,0 +1 @@
+export { AccountsFilingService } from "./service";

package/dist/services/accounts-filing/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountsFilingService = void 0;
+var service_1 = require("./service");
+Object.defineProperty(exports, "AccountsFilingService", { enumerable: true, get: function () { return service_1.AccountsFilingService; } });
+//# sourceMappingURL=index.js.map

package/dist/services/accounts-filing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/accounts-filing/index.ts"],"names":[],"mappings":";;;AAAA,qCAAkD;AAAzC,gHAAA,qBAAqB,OAAA"}

package/dist/services/accounts-filing/service.d.ts

@@ -0,0 +1,117 @@
+import { IHttpClient } from "../../http";
+import Resource, { ApiErrorResponse } from "../resource";
+import { AccountsFilingValidationRequest, AccountsFileValidationResponse, AccountsFilingCompanyResponse, PackageType, ConfirmCompanyRequest } from "./types";
+import { Result } from "../result";
+/**
+ * A service class for managing communications with the accounts filing API.
+ * This class serves as the interface for various interactions with the accounts filing system.
+ * Currently, it includes functionality to check the validation status of an accounts file,
+ * but it is designed to accommodate additional features and communications with the accounts filing API
+ * as they are implemented.
+ *
+ * The service handles various HTTP response scenarios, providing appropriate
+ * responses based on the different statuses encountered during the file validation process
+ * or other interactions with the accounts filing API.
+ */
+export declare class AccountsFilingService {
+    private readonly client;
+    /**
+     * Constructs an AccountsFilingService instance.
+     * @param client - The HTTP client for making requests.
+     */
+    constructor(client: IHttpClient);
+    /**
+     * This service will submit the required input from the web to confirm the company.
+     * @param companyNumber The company number
+     * @param transactionId The transaction Id
+     * @returns the company response.
+     */
+    confirmCompany(companyNumber: string, transactionId: string, confirmCompanyRequest: ConfirmCompanyRequest, requestId?: string): Promise<Resource<AccountsFilingCompanyResponse>>;
+    /**
+     * Checks the validation status of an accounts file.
+     * Calls the accounts filing api, which in turn calls the accounts validation service.
+     * @param fileValidationRequest - The request details for file validation.
+     * @returns A promise that resolves to the validation response or an error.
+     */
+    checkAccountsFileValidationStatus(fileValidationRequest: AccountsFilingValidationRequest): Promise<Resource<AccountsFileValidationResponse> | ApiErrorResponse>;
+    /**
+     * Initiates an HTTP GET request to retrieve the status of a file validation process.
+     * This method queries the server for the current validation status of a specific file
+     * associated with an accounts filing and transaction ID.
+     *
+     * @param fileValidationRequest - An object containing the identifiers needed to locate the file.
+     *        This includes the file ID, accounts filing ID, and transaction ID.
+     * @returns A promise that resolves to the HTTP response from the server. The response includes
+     *          the current status of the file validation process.
+     * @throws Will throw an error if the HTTP request fails.
+     */
+    private getFileValidationRequest;
+    /**
+     * Processes the HTTP response from the file validation request.
+     * This method examines the HTTP status code of the response and delegates
+     * to the appropriate handler based on the status code.
+     *
+     * @param response - The HttpResponse object received from the file validation request.
+     *        It includes the status code and the response data from the server.
+     * @param fileId - The unique identifier of the file whose validation status is being checked.
+     * @returns Depending on the response status, this method can return:
+     *          - The result of the handleOkResponse method if the status is HTTP_STATUS_OK (200),
+     *            indicating a successful response from the server.
+     *          - The result of the fileNotFoundResponse method if the status is HTTP_STATUS_NOT_FOUND (404),
+     *            indicating that the file was not found on the server.
+     *          - The result of the handleUnexpectedStatus method for any other unexpected status codes,
+     *            handling any unforeseen responses.
+     */
+    private processResponse;
+    /**
+     * Handles unexpected HTTP response statuses received from the file validation request.
+     * This method is used as a catch-all for any HTTP status codes that are not specifically
+     * handled in the processResponse method. It constructs a standardized error response
+     * which can be used to notify the caller of an unexpected condition.
+     *
+     * @param response - The HttpResponse object received from the file validation request.
+     *        This includes the status code and any associated response data.
+     * @returns An ApiErrorResponse object that encapsulates the unexpected status code and
+     *          a descriptive error message. This response can be used to inform the user
+     *          or calling function about the unexpected server behavior.
+     */
+    private handleUnexpectedStatus;
+    /**
+     * Handles the OK response received from the file validation request.
+     * This method checks if the response body conforms to the AccountValidatorResponse structure.
+     * If it does, the method returns a successful response, otherwise, it delegates to
+     * the invalidResponseType method for further handling.
+     *
+     * @param response - The HttpResponse object received, expected with a status of HTTP_STATUS_OK.
+     * @param fileId - The unique identifier of the file whose validation status is being checked.
+     * @returns An object with the HTTP status code and the validated response body,
+     *          or the result of the invalidResponseType method in case of an incorrect response type.
+     */
+    private handleOkResponse;
+    /**
+     * Generates a standardized error response for the scenario where the requested file is not found.
+     *
+     * @param fileId - The unique identifier of the file that was not found.
+     * @returns An ApiErrorResponse object with the HTTP status of NOT FOUND and an error message.
+     */
+    private fileNotFoundResponse;
+    /**
+     * Constructs an error response for situations where the file validation response is not of the expected type.
+     *
+     * @param fileId - The unique identifier of the file for which the validation response is incorrect.
+     * @param response - The original HttpResponse object received from the file validation request.
+     * @returns An ApiErrorResponse object encapsulating the actual HTTP status and a descriptive error message,
+     *          including the response received for debugging purposes.
+     */
+    private invalidResponseType;
+    /**
+     * Generic error handling method to capture and process exceptions or errors encountered during
+     * the file validation request process. Converts unhandled errors into a standardized API error response.
+     *
+     * @param error - The error or exception caught during the execution of the file validation request.
+     * @returns An ApiErrorResponse object with the status of INTERNAL_SERVER_ERROR for unhandled errors,
+     *          or the original ApiErrorResponse if the error is already in this format.
+     */
+    private handleError;
+    setPackageType(transactionId: string, accountsFilingId: string, packageType: PackageType, requestId?: string): Promise<Result<void, Error>>;
+}

package/dist/services/accounts-filing/service.js

@@ -0,0 +1,291 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountsFilingService = void 0;
+const types_1 = require("../../services/account-validator/types");
+const mapping_1 = __importDefault(require("../../mapping/mapping"));
+const result_1 = require("../result");
+const util_1 = require("../../util");
+const HTTP_STATUS_OK = 200;
+const HTTP_STATUS_NOT_FOUND = 404;
+const HTTP_STATUS_INTERNAL_SERVER_ERROR = 500;
+/**
+ * A service class for managing communications with the accounts filing API.
+ * This class serves as the interface for various interactions with the accounts filing system.
+ * Currently, it includes functionality to check the validation status of an accounts file,
+ * but it is designed to accommodate additional features and communications with the accounts filing API
+ * as they are implemented.
+ *
+ * The service handles various HTTP response scenarios, providing appropriate
+ * responses based on the different statuses encountered during the file validation process
+ * or other interactions with the accounts filing API.
+ */
+class AccountsFilingService {
+    /**
+     * Constructs an AccountsFilingService instance.
+     * @param client - The HTTP client for making requests.
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * This service will submit the required input from the web to confirm the company.
+     * @param companyNumber The company number
+     * @param transactionId The transaction Id
+     * @returns the company response.
+     */
+    confirmCompany(companyNumber, transactionId, confirmCompanyRequest, requestId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = `/transactions/${transactionId}/accounts-filing/company/${companyNumber}/confirm`;
+            const headers = util_1.addRequestIdHeader(requestId);
+            const resp = yield this.client.httpPut(url, confirmCompanyRequest, headers);
+            const resource = {
+                httpStatusCode: resp.status
+            };
+            if (resp.error) {
+                return resource;
+            }
+            const body = resp.body;
+            resource.resource = mapping_1.default.camelCaseKeys(body);
+            return resource;
+        });
+    }
+    /**
+     * Checks the validation status of an accounts file.
+     * Calls the accounts filing api, which in turn calls the accounts validation service.
+     * @param fileValidationRequest - The request details for file validation.
+     * @returns A promise that resolves to the validation response or an error.
+     */
+    checkAccountsFileValidationStatus(fileValidationRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.getFileValidationRequest(fileValidationRequest);
+                return this.processResponse(response, fileValidationRequest.fileId);
+            }
+            catch (error) {
+                return this.handleError(error);
+            }
+        });
+    }
+    /**
+     * Initiates an HTTP GET request to retrieve the status of a file validation process.
+     * This method queries the server for the current validation status of a specific file
+     * associated with an accounts filing and transaction ID.
+     *
+     * @param fileValidationRequest - An object containing the identifiers needed to locate the file.
+     *        This includes the file ID, accounts filing ID, and transaction ID.
+     * @returns A promise that resolves to the HTTP response from the server. The response includes
+     *          the current status of the file validation process.
+     * @throws Will throw an error if the HTTP request fails.
+     */
+    getFileValidationRequest(fileValidationRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { fileId, accountsFilingId, transactionId } = fileValidationRequest;
+            return yield this.client.httpGet(`/transactions/${transactionId}/accounts-filing/${accountsFilingId}/file/${fileId}/status`);
+        });
+    }
+    /**
+     * Processes the HTTP response from the file validation request.
+     * This method examines the HTTP status code of the response and delegates
+     * to the appropriate handler based on the status code.
+     *
+     * @param response - The HttpResponse object received from the file validation request.
+     *        It includes the status code and the response data from the server.
+     * @param fileId - The unique identifier of the file whose validation status is being checked.
+     * @returns Depending on the response status, this method can return:
+     *          - The result of the handleOkResponse method if the status is HTTP_STATUS_OK (200),
+     *            indicating a successful response from the server.
+     *          - The result of the fileNotFoundResponse method if the status is HTTP_STATUS_NOT_FOUND (404),
+     *            indicating that the file was not found on the server.
+     *          - The result of the handleUnexpectedStatus method for any other unexpected status codes,
+     *            handling any unforeseen responses.
+     */
+    processResponse(response, fileId) {
+        switch (response.status) {
+            case HTTP_STATUS_OK:
+                return this.handleOkResponse(response, fileId);
+            case HTTP_STATUS_NOT_FOUND:
+                return this.fileNotFoundResponse(fileId);
+            default:
+                return this.handleUnexpectedStatus(response);
+        }
+    }
+    /**
+     * Handles unexpected HTTP response statuses received from the file validation request.
+     * This method is used as a catch-all for any HTTP status codes that are not specifically
+     * handled in the processResponse method. It constructs a standardized error response
+     * which can be used to notify the caller of an unexpected condition.
+     *
+     * @param response - The HttpResponse object received from the file validation request.
+     *        This includes the status code and any associated response data.
+     * @returns An ApiErrorResponse object that encapsulates the unexpected status code and
+     *          a descriptive error message. This response can be used to inform the user
+     *          or calling function about the unexpected server behavior.
+     */
+    handleUnexpectedStatus(response) {
+        return {
+            httpStatusCode: response.status,
+            errors: [{
+                    error: `Unexpected server response: Status Code ${response.status}`
+                }]
+        };
+    }
+    /**
+     * Handles the OK response received from the file validation request.
+     * This method checks if the response body conforms to the AccountValidatorResponse structure.
+     * If it does, the method returns a successful response, otherwise, it delegates to
+     * the invalidResponseType method for further handling.
+     *
+     * @param response - The HttpResponse object received, expected with a status of HTTP_STATUS_OK.
+     * @param fileId - The unique identifier of the file whose validation status is being checked.
+     * @returns An object with the HTTP status code and the validated response body,
+     *          or the result of the invalidResponseType method in case of an incorrect response type.
+     */
+    handleOkResponse(response, fileId) {
+        if (types_1.isAccountValidatorResponse(response.body)) {
+            return {
+                httpStatusCode: response.status,
+                resource: response.body
+            };
+        }
+        return this.invalidResponseType(fileId, response);
+    }
+    /**
+     * Generates a standardized error response for the scenario where the requested file is not found.
+     *
+     * @param fileId - The unique identifier of the file that was not found.
+     * @returns An ApiErrorResponse object with the HTTP status of NOT FOUND and an error message.
+     */
+    fileNotFoundResponse(fileId) {
+        return {
+            httpStatusCode: HTTP_STATUS_NOT_FOUND,
+            errors: [{ error: `File with ID [${fileId}] not found.` }]
+        };
+    }
+    /**
+     * Constructs an error response for situations where the file validation response is not of the expected type.
+     *
+     * @param fileId - The unique identifier of the file for which the validation response is incorrect.
+     * @param response - The original HttpResponse object received from the file validation request.
+     * @returns An ApiErrorResponse object encapsulating the actual HTTP status and a descriptive error message,
+     *          including the response received for debugging purposes.
+     */
+    invalidResponseType(fileId, response) {
+        return {
+            httpStatusCode: response.status,
+            errors: [{
+                    error: `File validation response for file [${fileId}] is not the correct type. Response: ${JSON.stringify(response.body, null, 2)}`
+                }]
+        };
+    }
+    /**
+     * Generic error handling method to capture and process exceptions or errors encountered during
+     * the file validation request process. Converts unhandled errors into a standardized API error response.
+     *
+     * @param error - The error or exception caught during the execution of the file validation request.
+     * @returns An ApiErrorResponse object with the status of INTERNAL_SERVER_ERROR for unhandled errors,
+     *          or the original ApiErrorResponse if the error is already in this format.
+     */
+    handleError(error) {
+        if (isApiErrorResponse(error)) {
+            return error;
+        }
+        return {
+            httpStatusCode: HTTP_STATUS_INTERNAL_SERVER_ERROR,
+            errors: [{ error: "Internal Server Error" }]
+        };
+    }
+    setPackageType(transactionId, accountsFilingId, packageType, requestId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = `/transactions/${transactionId}/accounts-filing/${accountsFilingId}`;
+            const packageTypeRequest = {
+                packageType: packageType
+            };
+            const requestBody = mapping_1.default.snakeCaseKeys(packageTypeRequest);
+            const headers = util_1.addRequestIdHeader(requestId);
+            const resp = yield this.client.httpPut(url, requestBody, headers);
+            // Needed due to javascripts switch block scoping rules
+            let errorMessage = "";
+            switch (resp.status) {
+                case 204:
+                    return new result_1.Success(undefined);
+                case 404:
+                    // The api only checks to see if a transaction with the given id exists. No such test is performed for the accountsFilingId.
+                    errorMessage = `No transaction with id [${transactionId}] found`;
+                    return new result_1.Failure(new Error(errorMessage));
+                default:
+                    var errorMessageData = {
+                        httpStatusCode: resp.status,
+                        transactionId,
+                        accountsFilingId,
+                        responseBody: resp.body
+                    };
+                    errorMessage = `An unknown error occured when setting accounts filing package type. ${JSON.stringify(errorMessageData, null, 2)}`;
+                    return new result_1.Failure(new Error(errorMessage));
+            }
+        });
+    }
+}
+exports.AccountsFilingService = AccountsFilingService;
+/**
+ * Type guard function to check if a given object conforms to the ApiErrorResponse interface.
+ * This function performs structural validation by checking the existence and types of certain properties
+ * expected in a standard ApiErrorResponse. It is used to determine if an arbitrary object can be treated
+ * as an ApiErrorResponse, typically in error handling scenarios.
+ *
+ * @param object - The object to be checked. It can be any type, as the function will verify its structure.
+ * @returns A boolean value indicating whether the object is an ApiErrorResponse. Returns true if the object
+ *          has the expected structure of an ApiErrorResponse, false otherwise.
+ *
+ * The function checks for the following properties:
+ * - httpStatusCode: Must exist and be of type number.
+ * - errors: Must exist and be an array. Each item in the array must be an object with specific properties
+ *   like 'error', 'errorValues', 'location', 'locationType', and 'type', each with appropriate types.
+ */
+function isApiErrorResponse(object) {
+    if (object.hasOwnProperty("httpStatusCode") &&
+        typeof object.httpStatusCode !== "number") {
+        return false;
+    }
+    if (object.hasOwnProperty("errors")) {
+        if (!Array.isArray(object.errors)) {
+            return false;
+        }
+        for (const error of object.errors) {
+            if (typeof error !== "object" || error === null) {
+                return false;
+            }
+            if (error.hasOwnProperty("error") && typeof error.error !== "string") {
+                return false;
+            }
+            if (error.hasOwnProperty("errorValues") &&
+                typeof error.errorValues !== "object") {
+                return false;
+            }
+            if (error.hasOwnProperty("location") &&
+                typeof error.location !== "string") {
+                return false;
+            }
+            if (error.hasOwnProperty("locationType") &&
+                typeof error.locationType !== "string") {
+                return false;
+            }
+            if (error.hasOwnProperty("type") && typeof error.type !== "string") {
+                return false;
+            }
+        }
+    }
+    return true;
+}
+//# sourceMappingURL=service.js.map

package/dist/services/accounts-filing/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/accounts-filing/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAEA,kEAAoF;AAEpF,oEAA4C;AAC5C,sCAAqD;AACrD,qCAAgD;AAEhD,MAAM,cAAc,GAAG,GAAG,CAAC;AAC3B,MAAM,qBAAqB,GAAG,GAAG,CAAC;AAClC,MAAM,iCAAiC,GAAG,GAAG,CAAC;AAE9C;;;;;;;;;;GAUG;AACH,MAAa,qBAAqB;IAC9B;;;OAGG;IACH,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAErD;;;;;OAKG;IACU,cAAc,CAAE,aAAqB,EAAE,aAAqB,EAAE,qBAA4C,EAAE,SAAkB;;YACvI,MAAM,GAAG,GAAG,iBAAiB,aAAa,4BAA4B,aAAa,UAAU,CAAC;YAC9F,MAAM,OAAO,GAAG,yBAAkB,CAAC,SAAS,CAAC,CAAC;YAC9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAC;YAE5E,MAAM,QAAQ,GAA4C;gBACtD,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,QAAQ,CAAC;aACnB;YAED,MAAM,IAAI,GAAG,IAAI,CAAC,IAAqC,CAAC;YAExD,QAAQ,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAAgC,IAAI,CAAC,CAAC;YAE/E,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAED;;;;;OAKG;IACG,iCAAiC,CACnC,qBAAsD;;YAEtD,IAAI;gBACA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,qBAAqB,CAAC,CAAC;gBAC5E,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,qBAAqB,CAAC,MAAM,CAAC,CAAC;aACvE;YAAC,OAAO,KAAK,EAAE;gBACZ,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;aAClC;QACL,CAAC;KAAA;IAED;;;;;;;;;;OAUG;IACW,wBAAwB,CAAE,qBAAsD;;YAC1F,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,aAAa,EAAE,GAAG,qBAAqB,CAAC;YAC1E,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAC5B,iBAAiB,aAAa,oBAAoB,gBAAgB,SAAS,MAAM,SAAS,CAC7F,CAAC;QACN,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACK,eAAe,CAAE,QAAsB,EAAE,MAAc;QAC3D,QAAQ,QAAQ,CAAC,MAAM,EAAE;YACzB,KAAK,cAAc;gBACf,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAEnD,KAAK,qBAAqB;gBACtB,OAAO,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;YAE7C;gBACI,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;SAChD;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACK,sBAAsB,CAAE,QAAsB;QAClD,OAAO;YACH,cAAc,EAAE,QAAQ,CAAC,MAAM;YAC/B,MAAM,EAAE,CAAC;oBACL,KAAK,EAAE,2CAA2C,QAAQ,CAAC,MAAM,EAAE;iBACtE,CAAC;SACL,CAAC;IACN,CAAC;IAED;;;;;;;;;;OAUG;IACK,gBAAgB,CAAE,QAAsB,EAAE,MAAc;QAC5D,IAAI,kCAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YAC3C,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,EAAE,QAAQ,CAAC,IAAI;aAC1B,CAAC;SACL;QAED,OAAO,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACK,oBAAoB,CAAE,MAAc;QACxC,OAAO;YACH,cAAc,EAAE,qBAAqB;YACrC,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,iBAAiB,MAAM,cAAc,EAAE,CAAC;SAC7D,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACK,mBAAmB,CAAE,MAAc,EAAE,QAAsB;QAC/D,OAAO;YACH,cAAc,EAAE,QAAQ,CAAC,MAAM;YAC/B,MAAM,EAAE,CAAC;oBACL,KAAK,EAAE,sCAAsC,MAAM,wCAAwC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE;iBACtI,CAAC;SACL,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACK,WAAW,CAAE,KAAU;QAC3B,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,KAAK,CAAC;SAChB;QAED,OAAO;YACH,cAAc,EAAE,iCAAiC;YACjD,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,uBAAuB,EAAE,CAAC;SAC/C,CAAC;IACN,CAAC;IAEY,cAAc,CAAE,aAAqB,EAAE,gBAAwB,EAAE,WAAwB,EAAE,SAAkB;;YACtH,MAAM,GAAG,GAAG,iBAAiB,aAAa,oBAAoB,gBAAgB,EAAE,CAAC;YAEjF,MAAM,kBAAkB,GAAuB;gBAC3C,WAAW,EAAE,WAAW;aAC3B,CAAA;YAED,MAAM,WAAW,GAAG,iBAAO,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;YAC9D,MAAM,OAAO,GAAG,yBAAkB,CAAC,SAAS,CAAC,CAAA;YAC7C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;YAElE,uDAAuD;YACvD,IAAI,YAAY,GAAG,EAAE,CAAC;YACtB,QAAQ,IAAI,CAAC,MAAM,EAAE;gBACrB,KAAK,GAAG;oBACJ,OAAO,IAAI,gBAAO,CAAC,SAAS,CAAC,CAAC;gBAClC,KAAK,GAAG;oBACJ,4HAA4H;oBAC5H,YAAY,GAAG,2BAA2B,aAAa,SAAS,CAAC;oBACjE,OAAO,IAAI,gBAAO,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;gBAChD;oBACI,IAAI,gBAAgB,GAAG;wBACnB,cAAc,EAAE,IAAI,CAAC,MAAM;wBAC3B,aAAa;wBACb,gBAAgB;wBAChB,YAAY,EAAE,IAAI,CAAC,IAAI;qBAC1B,CAAA;oBACD,YAAY,GAAG,uEAAuE,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;oBAClI,OAAO,IAAI,gBAAO,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;aAC/C;QACL,CAAC;KAAA;CACJ;AA5ND,sDA4NC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAS,kBAAkB,CAAE,MAAW;IACpC,IACI,MAAM,CAAC,cAAc,CAAC,gBAAgB,CAAC;QACvC,OAAO,MAAM,CAAC,cAAc,KAAK,QAAQ,EAC3C;QACE,OAAO,KAAK,CAAC;KAChB;IAED,IAAI,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;QACjC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;YAC/B,OAAO,KAAK,CAAC;SAChB;QAED,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE;YAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;gBAC7C,OAAO,KAAK,CAAC;aAChB;YAED,IAAI,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,EAAE;gBAClE,OAAO,KAAK,CAAC;aAChB;YACD,IACI,KAAK,CAAC,cAAc,CAAC,aAAa,CAAC;gBACnC,OAAO,KAAK,CAAC,WAAW,KAAK,QAAQ,EACvC;gBACE,OAAO,KAAK,CAAC;aAChB;YACD,IACI,KAAK,CAAC,cAAc,CAAC,UAAU,CAAC;gBAChC,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,EACpC;gBACE,OAAO,KAAK,CAAC;aAChB;YACD,IACI,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC;gBACpC,OAAO,KAAK,CAAC,YAAY,KAAK,QAAQ,EACxC;gBACE,OAAO,KAAK,CAAC;aAChB;YACD,IAAI,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;gBAChE,OAAO,KAAK,CAAC;aAChB;SACJ;KACJ;IAED,OAAO,IAAI,CAAC;AAChB,CAAC"}

package/dist/services/accounts-filing/types.d.ts

@@ -0,0 +1,21 @@
+import { AccountValidatorResponse } from "../account-validator/types";
+export declare type AccountsFileValidationResponse = AccountValidatorResponse;
+declare const packageTypes: readonly ["uksef", "cic", "welsh", "limited-partnership", "group-package-400", "group-package-401", "overseas", "audit-exempt-subsidiary", "filing-exempt-subsidiary"];
+declare type ElementType<T extends ReadonlyArray<unknown>> = T extends ReadonlyArray<infer ElementType> ? ElementType : never;
+export declare type PackageType = ElementType<typeof packageTypes>;
+export declare function isPackageType(o: any): o is PackageType;
+export interface AccountsFilingValidationRequest {
+    fileId: string;
+    accountsFilingId: string;
+    transactionId: string;
+}
+export interface AccountsFilingCompanyResponse {
+    accountsFilingId: string;
+}
+export interface PackageTypeRequest {
+    packageType: PackageType;
+}
+export interface ConfirmCompanyRequest {
+    companyName: String;
+}
+export {};

package/dist/services/accounts-filing/types.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPackageType = void 0;
+const packageTypes = [
+    "uksef",
+    "cic",
+    "welsh",
+    "limited-partnership",
+    "group-package-400",
+    "group-package-401",
+    "overseas",
+    "audit-exempt-subsidiary",
+    "filing-exempt-subsidiary"
+];
+function isPackageType(o) {
+    return packageTypes.includes(o);
+}
+exports.isPackageType = isPackageType;
+//# sourceMappingURL=types.js.map

package/dist/services/accounts-filing/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/accounts-filing/types.ts"],"names":[],"mappings":";;;AAIA,MAAM,YAAY,GAAG;IACjB,OAAO;IACP,KAAK;IACL,OAAO;IACP,qBAAqB;IACrB,mBAAmB;IACnB,mBAAmB;IACnB,UAAU;IACV,yBAAyB;IACzB,0BAA0B;CACpB,CAAC;AAUX,SAAgB,aAAa,CAAE,CAAM;IACjC,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC;AAFD,sCAEC"}

package/dist/services/psc-verification-link/service.d.ts

@@ -1,7 +1,7 @@
 import { PscVerification, PscVerificationResource } from "./types";
 import { IHttpClient } from "../../http";
 import Resource, { ApiErrorResponse } from "../resource";
-export default class {
+export default class PscVerificationService {
     private readonly client;
     constructor(client: IHttpClient);
     postPscVerification(transactionId: string, pscVerification: PscVerification): Promise<Resource<PscVerificationResource> | ApiErrorResponse>;

package/dist/services/psc-verification-link/service.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-class default_1 {
+class PscVerificationService {
     constructor(client) {
         this.client = client;
     }
@@ -35,5 +35,5 @@ class default_1 {
         resource.resource = body;
     }
 }
-exports.default = default_1;
+exports.default = PscVerificationService;
 //# sourceMappingURL=service.js.map

package/dist/services/psc-verification-link/service.js.map

@@ -1 +1 @@
-{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/psc-verification-link/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAOA;IACI,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAExC,mBAAmB,CAAE,aAAqB,EAAE,eAAgC;;YACrF,MAAM,GAAG,GAAG,iBAAiB,aAAa,gDAAgD,CAAC;YAC3F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;YAElE,IAAI,QAAQ,CAAC,KAAK,EAAE;gBAChB,OAAO;oBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;oBAC/B,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;iBAC3B,CAAA;aACJ;YAED,MAAM,QAAQ,GAAsC;gBAChD,cAAc,EAAE,QAAQ,CAAC,MAAM;aAClC,CAAC;YACF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAA+B,CAAA;YACrD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACtC,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEO,gBAAgB,CAAE,QAA2C,EAAE,IAA6B;QAChG,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;IAC7B,CAAC;CACJ;AAzBD,4BAyBC"}
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/psc-verification-link/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAOA,MAAqB,sBAAsB;IACvC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAExC,mBAAmB,CAAE,aAAqB,EAAE,eAAgC;;YACrF,MAAM,GAAG,GAAG,iBAAiB,aAAa,gDAAgD,CAAC;YAC3F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;YAElE,IAAI,QAAQ,CAAC,KAAK,EAAE;gBAChB,OAAO;oBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;oBAC/B,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;iBAC3B,CAAA;aACJ;YAED,MAAM,QAAQ,GAAsC;gBAChD,cAAc,EAAE,QAAQ,CAAC,MAAM;aAClC,CAAC;YACF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAA+B,CAAA;YACrD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACtC,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEO,gBAAgB,CAAE,QAA2C,EAAE,IAA6B;QAChG,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;IAC7B,CAAC;CACJ;AAzBD,yCAyBC"}

package/dist/services/psc-verification-link/types.d.ts

@@ -27,9 +27,9 @@ export interface VerificationDetails {
 }
 export interface PscVerification {
     company_number: string;
-    psc_appointment_id: string;
+    psc_appointment_id?: string;
     relevant_officer?: RelevantOfficer;
-    verification_details: VerificationDetails;
+    verification_details?: VerificationDetails;
 }
 export interface Links {
     self: string;

package/dist/services/transaction/service.d.ts

@@ -1,5 +1,5 @@
 import { IHttpClient } from "../../http";
-import { Transaction } from "./types";
+import { Transaction, TransactionResource } from "./types";
 import Resource, { ApiErrorResponse, ApiResponse } from "../resource";
 export default class TransactionService {
     private readonly client;
@@ -9,19 +9,28 @@ export default class TransactionService {
    *
    * @param transaction the transaction to create
    */
-    postTransaction(transaction: Transaction): Promise<Resource<Transaction> | ApiErrorResponse>;
+    postTransaction(transaction: Transaction, requestId?: string): Promise<Resource<Transaction> | ApiErrorResponse>;
     /**
      * Put a transaction
      *
-     * @param replacment transaction
+     * @param {Transaction} transaction The transaction object to be updated
+     * @param {string} [requestId] Optional unique identifier for the request used for correlating logs between services
+     * @returns {Promise<ApiResponse<Transaction> | ApiErrorResponse>} A promise resolving to the transaction update response
      */
-    putTransaction(transaction: Transaction): Promise<ApiResponse<Transaction> | ApiErrorResponse>;
+    putTransaction(transaction: Transaction, requestId?: string): Promise<ApiResponse<Transaction> | ApiErrorResponse>;
     private populateResource;
     /**
      * Get a transaction.
      *
      * @param transactionId the id of the transaction to retrieve
      */
-    getTransaction(transactionId: string): Promise<Resource<Transaction> | ApiErrorResponse>;
+    getTransaction(transactionId: string, requestId?: string): Promise<Resource<Transaction> | ApiErrorResponse>;
+    /**
+     * Patch a transaction.
+     *
+     * @param transactionId the ID of the transaction to update
+     * @param transactionResource the partial transaction resource with updates
+     */
+    patchTransaction(transactionId: string, transactionResource: Partial<TransactionResource>, requestId?: string): Promise<Resource<Transaction> | ApiErrorResponse>;
     private mapToResource;
 }

package/dist/services/transaction/service.js

@@ -9,6 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../../util");
 class TransactionService {
     constructor(client) {
         this.client = client;
@@ -18,14 +19,15 @@ class TransactionService {
    *
    * @param transaction the transaction to create
    */
-    postTransaction(transaction) {
+    postTransaction(transaction, requestId) {
         return __awaiter(this, void 0, void 0, function* () {
             let url = "/transactions";
             if (transaction.id) {
                 url += "/" + transaction.id;
             }
             const transactionResource = this.mapToResource(transaction);
-            const resp = yield this.client.httpPost(url, transactionResource);
+            const headers = util_1.addRequestIdHeader(requestId);
+            const resp = yield this.client.httpPost(url, transactionResource, headers);
             if (resp.error) {
                 return {
                     httpStatusCode: resp.status,
@@ -44,13 +46,16 @@ class TransactionService {
     /**
      * Put a transaction
      *
-     * @param replacment transaction
+     * @param {Transaction} transaction The transaction object to be updated
+     * @param {string} [requestId] Optional unique identifier for the request used for correlating logs between services
+     * @returns {Promise<ApiResponse<Transaction> | ApiErrorResponse>} A promise resolving to the transaction update response
      */
-    putTransaction(transaction) {
+    putTransaction(transaction, requestId) {
         return __awaiter(this, void 0, void 0, function* () {
             const url = "/transactions/" + transaction.id;
+            const headers = util_1.addRequestIdHeader(requestId);
             const transactionResource = this.mapToResource(transaction);
-            const resp = yield this.client.httpPut(url, transactionResource);
+            const resp = yield this.client.httpPut(url, transactionResource, headers);
             if (resp.error) {
                 return {
                     httpStatusCode: resp.status,
@@ -86,10 +91,11 @@ class TransactionService {
      *
      * @param transactionId the id of the transaction to retrieve
      */
-    getTransaction(transactionId) {
+    getTransaction(transactionId, requestId) {
         return __awaiter(this, void 0, void 0, function* () {
             const url = "/transactions/" + transactionId;
-            const resp = yield this.client.httpGet(url);
+            const headers = util_1.addRequestIdHeader(requestId);
+            const resp = yield this.client.httpGet(url, headers);
             if (resp.error) {
                 return {
                     httpStatusCode: resp.status,
@@ -119,6 +125,31 @@ class TransactionService {
             return resource;
         });
     }
+    /**
+     * Patch a transaction.
+     *
+     * @param transactionId the ID of the transaction to update
+     * @param transactionResource the partial transaction resource with updates
+     */
+    patchTransaction(transactionId, transactionResource, requestId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = `/transactions/${transactionId}`;
+            const headers = util_1.addRequestIdHeader(requestId);
+            const resp = yield this.client.httpPatch(url, transactionResource, headers);
+            if (resp.error) {
+                return {
+                    httpStatusCode: resp.status,
+                    errors: [resp.error]
+                };
+            }
+            const resource = {
+                httpStatusCode: resp.status
+            };
+            const body = resp.body;
+            this.populateResource(resource, body);
+            return resource;
+        });
+    }
     mapToResource(transaction) {
         return {
             company_name: transaction.companyName,

package/dist/services/transaction/service.js.map

@@ -1 +1 @@
-{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/transaction/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAIA,MAAqB,kBAAkB;IACnC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEtD;;;;KAIC;IACY,eAAe,CAAE,WAAwB;;YAClD,IAAI,GAAG,GAAG,eAAe,CAAA;YACzB,IAAI,WAAW,CAAC,EAAE,EAAE;gBAChB,GAAG,IAAI,GAAG,GAAG,WAAW,CAAC,EAAE,CAAA;aAC9B;YAED,MAAM,mBAAmB,GAAwB,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YAEjF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;YAElE,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO;oBACH,cAAc,EAAE,IAAI,CAAC,MAAM;oBAC3B,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;iBACvB,CAAC;aACL;YAED,MAAM,QAAQ,GAA0B;gBACpC,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,8CAA8C;YAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,IAA2B,CAAC;YAE9C,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAEtC,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAED;;;;OAIG;IACU,cAAc,CAAE,WAAwB;;YACjD,MAAM,GAAG,GAAG,gBAAgB,GAAG,WAAW,CAAC,EAAE,CAAA;YAE7C,MAAM,mBAAmB,GAAwB,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YACjF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;YAEjE,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO;oBACH,cAAc,EAAE,IAAI,CAAC,MAAM;oBAC3B,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;iBACvB,CAAC;aACL;YAED,MAAM,QAAQ,GAA6B;gBACvC,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEO,gBAAgB,CAAE,QAA8B,EAAE,IAAwB;QAC9E,QAAQ,CAAC,QAAQ,GAAG;YAChB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,YAAY;YAC9B,aAAa,EAAE,IAAI,CAAC,cAAc;YAClC,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;SAC5B,CAAC;IACN,CAAC;IAED;;;;OAIG;IACU,cAAc,CAAE,aAAqB;;YAC9C,MAAM,GAAG,GAAG,gBAAgB,GAAG,aAAa,CAAA;YAC5C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE5C,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO;oBACH,cAAc,EAAE,IAAI,CAAC,MAAM;oBAC3B,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;iBACvB,CAAC;aACL;YAED,MAAM,QAAQ,GAA0B;gBACpC,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,8CAA8C;YAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,IAA2B,CAAC;YAE9C,QAAQ,CAAC,QAAQ,GAAG;gBAChB,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,WAAW,EAAE,IAAI,CAAC,YAAY;gBAC9B,aAAa,EAAE,IAAI,CAAC,cAAc;gBAClC,SAAS,EAAE,IAAI,CAAC,UAAU;gBAC1B,SAAS,EAAE,IAAI,CAAC,UAAU;gBAC1B,SAAS,EAAE,IAAI,CAAC,UAAU;gBAC1B,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;aAC5B,CAAA;YACD,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEO,aAAa,CAAE,WAAuB;QAC1C,OAAO;YACH,YAAY,EAAE,WAAW,CAAC,WAAW;YACrC,cAAc,EAAE,WAAW,CAAC,aAAa;YACzC,UAAU,EAAE,WAAW,CAAC,SAAS;YACjC,UAAU,EAAE,WAAW,CAAC,SAAS;YACjC,WAAW,EAAE,WAAW,CAAC,WAAW;YACpC,IAAI,EAAE,WAAW,CAAC,IAAI;YACtB,EAAE,EAAE,WAAW,CAAC,EAAE;YAClB,IAAI,EAAE,WAAW,CAAC,IAAI;YACtB,KAAK,EAAE,WAAW,CAAC,KAAK;YACxB,SAAS,EAAE,WAAW,CAAC,SAAS;YAChC,SAAS,EAAE,WAAW,CAAC,SAAS;YAChC,MAAM,EAAE,WAAW,CAAC,MAAM;YAC1B,UAAU,EAAE,WAAW,CAAC,SAAS;SACpC,CAAA;IACL,CAAC;CACJ;AA3ID,qCA2IC"}
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/transaction/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAGA,qCAAgD;AAEhD,MAAqB,kBAAkB;IACnC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEtD;;;;KAIC;IACY,eAAe,CAAE,WAAwB,EAAE,SAAkB;;YACtE,IAAI,GAAG,GAAG,eAAe,CAAA;YACzB,IAAI,WAAW,CAAC,EAAE,EAAE;gBAChB,GAAG,IAAI,GAAG,GAAG,WAAW,CAAC,EAAE,CAAA;aAC9B;YAED,MAAM,mBAAmB,GAAwB,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YAEjF,MAAM,OAAO,GAAG,yBAAkB,CAAC,SAAS,CAAC,CAAC;YAC9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,mBAAmB,EAAE,OAAO,CAAC,CAAC;YAE3E,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO;oBACH,cAAc,EAAE,IAAI,CAAC,MAAM;oBAC3B,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;iBACvB,CAAC;aACL;YAED,MAAM,QAAQ,GAA0B;gBACpC,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,8CAA8C;YAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,IAA2B,CAAC;YAE9C,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAEtC,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAED;;;;;;OAMG;IACU,cAAc,CAAE,WAAwB,EAAE,SAAkB;;YACrE,MAAM,GAAG,GAAG,gBAAgB,GAAG,WAAW,CAAC,EAAE,CAAA;YAE7C,MAAM,OAAO,GAAG,yBAAkB,CAAC,SAAS,CAAC,CAAC;YAE9C,MAAM,mBAAmB,GAAwB,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YACjF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,mBAAmB,EAAE,OAAO,CAAC,CAAC;YAE1E,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO;oBACH,cAAc,EAAE,IAAI,CAAC,MAAM;oBAC3B,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;iBACvB,CAAC;aACL;YAED,MAAM,QAAQ,GAA6B;gBACvC,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEO,gBAAgB,CAAE,QAA8B,EAAE,IAAwB;QAC9E,QAAQ,CAAC,QAAQ,GAAG;YAChB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,YAAY;YAC9B,aAAa,EAAE,IAAI,CAAC,cAAc;YAClC,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;SAC5B,CAAC;IACN,CAAC;IAED;;;;OAIG;IACU,cAAc,CAAE,aAAqB,EAAE,SAAkB;;YAClE,MAAM,GAAG,GAAG,gBAAgB,GAAG,aAAa,CAAA;YAC5C,MAAM,OAAO,GAAG,yBAAkB,CAAC,SAAS,CAAC,CAAC;YAC9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YAErD,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO;oBACH,cAAc,EAAE,IAAI,CAAC,MAAM;oBAC3B,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;iBACvB,CAAC;aACL;YAED,MAAM,QAAQ,GAA0B;gBACpC,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,8CAA8C;YAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,IAA2B,CAAC;YAE9C,QAAQ,CAAC,QAAQ,GAAG;gBAChB,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,WAAW,EAAE,IAAI,CAAC,YAAY;gBAC9B,aAAa,EAAE,IAAI,CAAC,cAAc;gBAClC,SAAS,EAAE,IAAI,CAAC,UAAU;gBAC1B,SAAS,EAAE,IAAI,CAAC,UAAU;gBAC1B,SAAS,EAAE,IAAI,CAAC,UAAU;gBAC1B,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;aAC5B,CAAA;YACD,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAED;;;;;OAKG;IACU,gBAAgB,CAAE,aAAqB,EAAE,mBAAiD,EAAE,SAAkB;;YACvH,MAAM,GAAG,GAAG,iBAAiB,aAAa,EAAE,CAAC;YAC7C,MAAM,OAAO,GAAG,yBAAkB,CAAC,SAAS,CAAC,CAAC;YAC9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,mBAAmB,EAAE,OAAO,CAAC,CAAC;YAE5E,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO;oBACH,cAAc,EAAE,IAAI,CAAC,MAAM;oBAC3B,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;iBACvB,CAAC;aACL;YAED,MAAM,QAAQ,GAA0B;gBACpC,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,MAAM,IAAI,GAAG,IAAI,CAAC,IAA2B,CAAC;YAE9C,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAEtC,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEO,aAAa,CAAE,WAAuB;QAC1C,OAAO;YACH,YAAY,EAAE,WAAW,CAAC,WAAW;YACrC,cAAc,EAAE,WAAW,CAAC,aAAa;YACzC,UAAU,EAAE,WAAW,CAAC,SAAS;YACjC,UAAU,EAAE,WAAW,CAAC,SAAS;YACjC,WAAW,EAAE,WAAW,CAAC,WAAW;YACpC,IAAI,EAAE,WAAW,CAAC,IAAI;YACtB,EAAE,EAAE,WAAW,CAAC,EAAE;YAClB,IAAI,EAAE,WAAW,CAAC,IAAI;YACtB,KAAK,EAAE,WAAW,CAAC,KAAK;YACxB,SAAS,EAAE,WAAW,CAAC,SAAS;YAChC,SAAS,EAAE,WAAW,CAAC,SAAS;YAChC,MAAM,EAAE,WAAW,CAAC,MAAM;YAC1B,UAAU,EAAE,WAAW,CAAC,SAAS;SACpC,CAAA;IACL,CAAC;CACJ;AA9KD,qCA8KC"}

package/dist/util.d.ts

@@ -0,0 +1,14 @@
+import { Headers } from "./http";
+/**
+ * Adds a Request ID header to the existing headers, if the Request ID is provided.
+ *
+ * The Request ID header is utilised to correlate requests between services, allowing
+ * for easier tracking of how requests propagate through a system of microservices.
+ * It is also used as a context key for logger systems to maintain tracing information
+ * across service calls.
+ *
+ * @param {string | undefined} requestId The unique identifier for the request, used for tracing.
+ * @param {Headers} otherHeaders Existing set of headers to which the Request ID header will be added.
+ * @returns {Headers | undefined} A new headers object with the Request ID added, or undefined if no Request ID was provided.
+ */
+export declare function addRequestIdHeader(requestId?: string, otherHeaders?: Headers): Headers | undefined;

package/dist/util.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addRequestIdHeader = void 0;
+const config_1 = require("./config");
+/**
+ * Adds a Request ID header to the existing headers, if the Request ID is provided.
+ *
+ * The Request ID header is utilised to correlate requests between services, allowing
+ * for easier tracking of how requests propagate through a system of microservices.
+ * It is also used as a context key for logger systems to maintain tracing information
+ * across service calls.
+ *
+ * @param {string | undefined} requestId The unique identifier for the request, used for tracing.
+ * @param {Headers} otherHeaders Existing set of headers to which the Request ID header will be added.
+ * @returns {Headers | undefined} A new headers object with the Request ID added, or undefined if no Request ID was provided.
+ */
+function addRequestIdHeader(requestId, otherHeaders = {}) {
+    if (requestId === undefined) {
+        return undefined;
+    }
+    otherHeaders = otherHeaders !== undefined ? otherHeaders : {};
+    return Object.assign(Object.assign({}, otherHeaders), { [config_1.REQUEST_ID_HEADER]: requestId });
+}
+exports.addRequestIdHeader = addRequestIdHeader;
+//# sourceMappingURL=util.js.map

package/dist/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;AAAA,qCAA6C;AAG7C;;;;;;;;;;;GAWG;AACH,SAAgB,kBAAkB,CAAE,SAAkB,EAAE,eAAwB,EAAE;IAC9E,IAAI,SAAS,KAAK,SAAS,EAAE;QACzB,OAAO,SAAS,CAAA;KACnB;IAED,YAAY,GAAG,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAA;IAE7D,uCAAY,YAAY,KAAE,CAAC,0BAAiB,CAAC,EAAE,SAAS,IAAG;AAC/D,CAAC;AARD,gDAQC"}

package/package.json

@@ -1,58 +1,62 @@
 {
-  "name": "@companieshouse/api-sdk-node",
-  "version": "2.0.153",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "license": "MIT",
-  "scripts": {
-    "build": "tsc",
-    "test": "mocha",
-    "lint": "eslint 'src/*.ts' 'src/**/*.ts' 'test/**/*.ts'",
-    "lint:fix": "eslint 'src/*.ts' 'src/**/*.ts' 'test/**/*.ts' --fix",
-    "prepublishOnly": "[ ! -d node_modules ] && npm install; tsc",
-    "postpublish": "rm -rf dist",
-    "analyse-code": "sonar-scanner"
-  },
-  "dependencies": {
-    "axios": "^1.6.7",
-    "camelcase-keys": "~6.2.2",
-    "snakecase-keys": "~3.2.0",
-    "url-search-params-polyfill": "~8.1.1"
-  },
-  "devDependencies": {
-    "@types/axios": "^0.14.0",
-    "@types/chai": "^4.2.22",
-    "@types/chai-as-promised": "^7.1.4",
-    "@types/chai-http": "~4.2.0",
-    "@types/mocha": "~8.0.4",
-    "@types/node": "^14.14.45",
-    "@types/request": "^2.48.8",
-    "@types/request-promise-native": "^1.0.18",
-    "@types/sinon": "^9.0.11",
-    "@types/sinon-chai": "^3.2.8",
-    "@typescript-eslint/eslint-plugin": "^5.54.1",
-    "@typescript-eslint/parser": "^5.54.1",
-    "chai": "~4.2.0",
-    "chai-as-promised": "~7.1.1",
-    "chai-http": "~4.3.0",
-    "eslint": "^7.32.0",
-    "eslint-config-standard": "14.1.1",
-    "eslint-plugin-import": "2.23.0",
-    "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-promise": "6.0.0",
-    "eslint-plugin-standard": "5.0.0",
-    "mocha": "^9.2.0",
-    "nock": "^13.3.2",
-    "sinon": "^9.2.4",
-    "sinon-chai": "~3.5.0",
-    "sonarqube-scanner": "^2.8.1",
-    "ts-node": "9.1.1",
-    "typescript": "4.1.6"
-  },
-  "overrides": {
-    "semver": "7.5.2"
-  }
+    "name": "@companieshouse/api-sdk-node",
+    "version": "2.0.155",
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "license": "MIT",
+    "scripts": {
+        "build": "tsc",
+        "test": "mocha",
+        "test:coverage": "nyc --check-coverage --reporter=text-summary npm run test",
+        "coverage:report": "nyc --reporter=lcov --reporter=text npm run test",
+        "lint": "eslint 'src/*.ts' 'src/**/*.ts' 'test/**/*.ts'",
+        "lint:fix": "eslint 'src/*.ts' 'src/**/*.ts' 'test/**/*.ts' --fix",
+        "prepublishOnly": "[ ! -d node_modules ] && npm install; tsc",
+        "postpublish": "rm -rf dist",
+        "analyse-code": "sonar-scanner"
+    },
+    "dependencies": {
+        "axios": "^1.6.7",
+        "camelcase-keys": "~6.2.2",
+        "snakecase-keys": "~3.2.0",
+        "url-search-params-polyfill": "~8.1.1"
+    },
+    "devDependencies": {
+        "@istanbuljs/nyc-config-typescript": "^1.0.2",
+        "@types/axios": "^0.14.0",
+        "@types/chai": "^4.2.22",
+        "@types/chai-as-promised": "^7.1.4",
+        "@types/chai-http": "~4.2.0",
+        "@types/mocha": "~8.0.4",
+        "@types/node": "^14.14.45",
+        "@types/request": "^2.48.8",
+        "@types/request-promise-native": "^1.0.18",
+        "@types/sinon": "^9.0.11",
+        "@types/sinon-chai": "^3.2.8",
+        "@typescript-eslint/eslint-plugin": "^5.54.1",
+        "@typescript-eslint/parser": "^5.54.1",
+        "chai": "~4.2.0",
+        "chai-as-promised": "~7.1.1",
+        "chai-http": "~4.3.0",
+        "eslint": "^7.32.0",
+        "eslint-config-standard": "14.1.1",
+        "eslint-plugin-import": "2.23.0",
+        "eslint-plugin-node": "11.1.0",
+        "eslint-plugin-promise": "6.0.0",
+        "eslint-plugin-standard": "5.0.0",
+        "mocha": "^9.2.0",
+        "nock": "^13.3.2",
+        "nyc": "^15.1.0",
+        "sinon": "^9.2.4",
+        "sinon-chai": "~3.5.0",
+        "sonarqube-scanner": "^2.8.1",
+        "ts-node": "9.1.1",
+        "typescript": "4.1.6"
+    },
+    "overrides": {
+        "semver": "7.5.2"
+    }
 }