candidhealth 1.0.0 → 1.4.0

package/Client.js

@@ -47,7 +47,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CandidApiClient = void 0;
 const core = __importStar(require("./core"));
-const Client_1 = require("./api/resources/auth/resources/v2/client/Client");
+const Client_1 = require("./api/resources/auth/resources/default/client/Client");
 const Client_2 = require("./api/resources/auth/client/Client");
 const Client_3 = require("./api/resources/billingNotes/client/Client");
 const Client_4 = require("./api/resources/chargeCaptureBundles/client/Client");
@@ -91,7 +91,7 @@ class CandidApiClient {
         this._oauthTokenProvider = new core.OAuthTokenProvider({
             clientId: this._options.clientId,
             clientSecret: this._options.clientSecret,
-            authClient: new Client_1.V2({
+            authClient: new Client_1.Default({
                 environment: this._options.environment,
             }),
         });

package/README.md

@@ -13,7 +13,7 @@ npm i -s candidhealth
 
 ## Reference
 
-A full reference for this library is available [here](./reference.md).
+A full reference for this library is available [here](https://github.com/candidhealth/candid-node/blob/HEAD/./reference.md).
 
 ## Usage
 

package/api/resources/auth/client/Client.d.ts

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import { V2 } from "../resources/v2/client/Client";
+import { Default } from "../resources/default/client/Client";
 export declare namespace Auth {
     interface Options {
         environment?: core.Supplier<environments.CandidApiEnvironment | environments.CandidApiEnvironmentUrls>;
@@ -24,7 +24,7 @@ export declare namespace Auth {
 }
 export declare class Auth {
     protected readonly _options: Auth.Options;
-    protected _v2: V2 | undefined;
+    protected _default: Default | undefined;
     constructor(_options?: Auth.Options);
-    get v2(): V2;
+    get default(): Default;
 }

package/api/resources/auth/client/Client.js

@@ -4,14 +4,14 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Auth = void 0;
-const Client_1 = require("../resources/v2/client/Client");
+const Client_1 = require("../resources/default/client/Client");
 class Auth {
     constructor(_options = {}) {
         this._options = _options;
     }
-    get v2() {
+    get default() {
         var _a;
-        return ((_a = this._v2) !== null && _a !== void 0 ? _a : (this._v2 = new Client_1.V2(this._options)));
+        return ((_a = this._default) !== null && _a !== void 0 ? _a : (this._default = new Client_1.Default(this._options)));
     }
 }
 exports.Auth = Auth;

package/api/resources/auth/resources/{v2 → default}/client/Client.d.ts

@@ -4,7 +4,7 @@
 import * as environments from "../../../../../../environments";
 import * as core from "../../../../../../core";
 import * as CandidApi from "../../../../../index";
-export declare namespace V2 {
+export declare namespace Default {
     interface Options {
         environment?: core.Supplier<environments.CandidApiEnvironment | environments.CandidApiEnvironmentUrls>;
         /** Specify a custom URL to connect the client to. */
@@ -22,9 +22,9 @@ export declare namespace V2 {
         headers?: Record<string, string>;
     }
 }
-export declare class V2 {
-    protected readonly _options: V2.Options;
-    constructor(_options?: V2.Options);
+export declare class Default {
+    protected readonly _options: Default.Options;
+    constructor(_options?: Default.Options);
     /**
      * <Callout intent="info">
      * Candid Health SDKs automatically handle authentication workflows after configuring them with the `client_id` and
@@ -32,7 +32,21 @@ export declare class V2 {
      * </Callout>
      *
      * Candid Health utilizes the [OAuth 2.0 bearer token authentication scheme](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) in our auth flow. You obtain the bearer token for all
-     * subsequent API requests via the `/auth/token` endpoint defined below, which requires you to provide your `client_id` and `client_secret`. Your `client_id` and `client_secret` can be [generated](https://support.joincandidhealth.com/hc/en-us/articles/23065219476244--Generating-Candid-API-Keys) from the "Users & Credentials" tab by your org admin.
+     * subsequent API requests via the `/auth/v2/token` endpoint defined below, which requires you to provide your `client_id` and `client_secret`. Your `client_id` and `client_secret` can be [generated](https://support.joincandidhealth.com/hc/en-us/articles/23065219476244--Generating-Candid-API-Keys) from the "Users & Credentials" tab by your org admin.
+     *
+     * The `/auth/v2/token` endpoint accepts both `Content-Type: application/json` and `Content-Type: application/x-www-form-urlencoded`. The request body should contain the `client_id` and `client_secret` as follows:
+     *
+     * ```json
+     * {
+     *   "client_id": "YOUR_CLIENT_ID",
+     *   "client_secret": "YOUR_CLIENT_SECRET"
+     * }
+     * ```
+     * or as URL-encoded form data:
+     *
+     * ```
+     * client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET
+     * ```
      *
      * The bearer token is a signed [JWT](https://jwt.io/). The public key for the JWT can be found [here](https://candidhealth.auth0.com/pem) for any verification workflows.
      *
@@ -44,15 +58,15 @@ export declare class V2 {
      * requests; if the client attempts to generate a token too often, it will be rate-limited and will receive an `HTTP 429 Too Many Requests` error.
      * </Callout>
      *
-     * @param {CandidApi.auth.v2.AuthGetTokenRequest} request
-     * @param {V2.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {CandidApi.auth.default_.AuthGetTokenRequest} request
+     * @param {Default.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.auth.v2.getToken({
+     *     await client.auth.default.getToken({
      *         clientId: "YOUR_CLIENT_ID",
      *         clientSecret: "YOUR_CLIENT_SECRET"
      *     })
      */
-    getToken(request: CandidApi.auth.v2.AuthGetTokenRequest, requestOptions?: V2.RequestOptions): Promise<core.APIResponse<CandidApi.auth.v2.AuthGetTokenResponse, CandidApi.auth.v2.getToken.Error>>;
+    getToken(request: CandidApi.auth.default_.AuthGetTokenRequest, requestOptions?: Default.RequestOptions): Promise<core.APIResponse<CandidApi.auth.default_.AuthGetTokenResponse, CandidApi.auth.default_.getToken.Error>>;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/{dist/api/resources/auth/resources/v2 → api/resources/auth/resources/default}/client/Client.js

@@ -48,13 +48,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.V2 = void 0;
+exports.Default = void 0;
 const environments = __importStar(require("../../../../../../environments"));
 const core = __importStar(require("../../../../../../core"));
 const CandidApi = __importStar(require("../../../../../index"));
 const serializers = __importStar(require("../../../../../../serialization/index"));
 const url_join_1 = __importDefault(require("url-join"));
-class V2 {
+class Default {
     constructor(_options = {}) {
         this._options = _options;
     }
@@ -65,7 +65,21 @@ class V2 {
      * </Callout>
      *
      * Candid Health utilizes the [OAuth 2.0 bearer token authentication scheme](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) in our auth flow. You obtain the bearer token for all
-     * subsequent API requests via the `/auth/token` endpoint defined below, which requires you to provide your `client_id` and `client_secret`. Your `client_id` and `client_secret` can be [generated](https://support.joincandidhealth.com/hc/en-us/articles/23065219476244--Generating-Candid-API-Keys) from the "Users & Credentials" tab by your org admin.
+     * subsequent API requests via the `/auth/v2/token` endpoint defined below, which requires you to provide your `client_id` and `client_secret`. Your `client_id` and `client_secret` can be [generated](https://support.joincandidhealth.com/hc/en-us/articles/23065219476244--Generating-Candid-API-Keys) from the "Users & Credentials" tab by your org admin.
+     *
+     * The `/auth/v2/token` endpoint accepts both `Content-Type: application/json` and `Content-Type: application/x-www-form-urlencoded`. The request body should contain the `client_id` and `client_secret` as follows:
+     *
+     * ```json
+     * {
+     *   "client_id": "YOUR_CLIENT_ID",
+     *   "client_secret": "YOUR_CLIENT_SECRET"
+     * }
+     * ```
+     * or as URL-encoded form data:
+     *
+     * ```
+     * client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET
+     * ```
      *
      * The bearer token is a signed [JWT](https://jwt.io/). The public key for the JWT can be found [here](https://candidhealth.auth0.com/pem) for any verification workflows.
      *
@@ -77,11 +91,11 @@ class V2 {
      * requests; if the client attempts to generate a token too often, it will be rate-limited and will receive an `HTTP 429 Too Many Requests` error.
      * </Callout>
      *
-     * @param {CandidApi.auth.v2.AuthGetTokenRequest} request
-     * @param {V2.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {CandidApi.auth.default_.AuthGetTokenRequest} request
+     * @param {Default.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.auth.v2.getToken({
+     *     await client.auth.default.getToken({
      *         clientId: "YOUR_CLIENT_ID",
      *         clientSecret: "YOUR_CLIENT_SECRET"
      *     })
@@ -92,10 +106,12 @@ class V2 {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CandidApiEnvironment.Production).candidApi, "/api/auth/v2/token"),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "candidhealth/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.4.0", "User-Agent": "candidhealth/1.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
-                body: serializers.auth.v2.AuthGetTokenRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                body: serializers.auth.default_.AuthGetTokenRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "strip",
+                }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -103,7 +119,7 @@ class V2 {
             if (_response.ok) {
                 return {
                     ok: true,
-                    body: serializers.auth.v2.AuthGetTokenResponse.parseOrThrow(_response.body, {
+                    body: serializers.auth.default_.AuthGetTokenResponse.parseOrThrow(_response.body, {
                         unrecognizedObjectKeys: "passthrough",
                         allowUnrecognizedUnionMembers: true,
                         allowUnrecognizedEnumValues: true,
@@ -114,9 +130,10 @@ class V2 {
             if (_response.error.reason === "status-code") {
                 switch ((_c = _response.error.body) === null || _c === void 0 ? void 0 : _c.errorName) {
                     case "TooManyRequestsError":
+                    case "InvalidContentTypeError":
                         return {
                             ok: false,
-                            error: serializers.auth.v2.getToken.Error.parseOrThrow(_response.error.body, {
+                            error: serializers.auth.default_.getToken.Error.parseOrThrow(_response.error.body, {
                                 unrecognizedObjectKeys: "passthrough",
                                 allowUnrecognizedUnionMembers: true,
                                 allowUnrecognizedEnumValues: true,
@@ -127,7 +144,7 @@ class V2 {
             }
             return {
                 ok: false,
-                error: CandidApi.auth.v2.getToken.Error._unknown(_response.error),
+                error: CandidApi.auth.default_.getToken.Error._unknown(_response.error),
             };
         });
     }
@@ -141,4 +158,4 @@ class V2 {
         });
     }
 }
-exports.V2 = V2;
+exports.Default = Default;

package/api/resources/auth/resources/default/client/getToken.d.ts

@@ -0,0 +1,34 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+import * as core from "../../../../../../core";
+export type Error = CandidApi.auth.default_.getToken.Error.TooManyRequestsError | CandidApi.auth.default_.getToken.Error.InvalidContentTypeError | CandidApi.auth.default_.getToken.Error._Unknown;
+export declare namespace Error {
+    interface TooManyRequestsError extends _Utils {
+        errorName: "TooManyRequestsError";
+        content: CandidApi.auth.default_.TooManyRequestsErrorType;
+    }
+    interface InvalidContentTypeError extends _Utils {
+        errorName: "InvalidContentTypeError";
+        content: CandidApi.auth.default_.InvalidContentTypeErrorType;
+    }
+    interface _Unknown extends _Utils {
+        errorName: void;
+        content: core.Fetcher.Error;
+    }
+    interface _Utils {
+        _visit: <_Result>(visitor: CandidApi.auth.default_.getToken.Error._Visitor<_Result>) => _Result;
+    }
+    interface _Visitor<_Result> {
+        tooManyRequestsError: (value: CandidApi.auth.default_.TooManyRequestsErrorType) => _Result;
+        invalidContentTypeError: (value: CandidApi.auth.default_.InvalidContentTypeErrorType) => _Result;
+        _other: (value: core.Fetcher.Error) => _Result;
+    }
+}
+export declare const Error: {
+    readonly tooManyRequestsError: (value: CandidApi.auth.default_.TooManyRequestsErrorType) => CandidApi.auth.default_.getToken.Error.TooManyRequestsError;
+    readonly invalidContentTypeError: (value: CandidApi.auth.default_.InvalidContentTypeErrorType) => CandidApi.auth.default_.getToken.Error.InvalidContentTypeError;
+    readonly _unknown: (fetcherError: core.Fetcher.Error) => CandidApi.auth.default_.getToken.Error._Unknown;
+    readonly _visit: <_Result>(value: CandidApi.auth.default_.getToken.Error, visitor: CandidApi.auth.default_.getToken.Error._Visitor<_Result>) => _Result;
+};

package/{dist/api/resources/auth/resources/v2 → api/resources/auth/resources/default}/client/getToken.js

@@ -44,7 +44,16 @@ exports.Error = {
             content: value,
             errorName: "TooManyRequestsError",
             _visit: function (visitor) {
-                return CandidApi.auth.v2.getToken.Error._visit(this, visitor);
+                return CandidApi.auth.default_.getToken.Error._visit(this, visitor);
+            },
+        };
+    },
+    invalidContentTypeError: (value) => {
+        return {
+            content: value,
+            errorName: "InvalidContentTypeError",
+            _visit: function (visitor) {
+                return CandidApi.auth.default_.getToken.Error._visit(this, visitor);
             },
         };
     },
@@ -53,7 +62,7 @@ exports.Error = {
             errorName: undefined,
             content: fetcherError,
             _visit: function (visitor) {
-                return CandidApi.auth.v2.getToken.Error._visit(this, visitor);
+                return CandidApi.auth.default_.getToken.Error._visit(this, visitor);
             },
         };
     },
@@ -61,6 +70,8 @@ exports.Error = {
         switch (value.errorName) {
             case "TooManyRequestsError":
                 return visitor.tooManyRequestsError(value.content);
+            case "InvalidContentTypeError":
+                return visitor.invalidContentTypeError(value.content);
             default:
                 return visitor._other(value);
         }

package/api/resources/auth/resources/default/types/InvalidContentTypeErrorType.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface InvalidContentTypeErrorType {
+    message: string;
+}

package/{dist/api/resources/auth/resources/v2 → api/resources/auth/resources/default}/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./AuthGetTokenResponse";
 export * from "./TooManyRequestsErrorType";
+export * from "./InvalidContentTypeErrorType";

package/{dist/serialization/resources/auth/resources/v2 → api/resources/auth/resources/default}/types/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AuthGetTokenResponse"), exports);
 __exportStar(require("./TooManyRequestsErrorType"), exports);
+__exportStar(require("./InvalidContentTypeErrorType"), exports);

package/api/resources/auth/resources/index.d.ts

@@ -1 +1 @@
-export * as v2 from "./v2";
+export * as default_ from "./default";

package/api/resources/auth/resources/index.js

@@ -33,5 +33,5 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.v2 = void 0;
-exports.v2 = __importStar(require("./v2"));
+exports.default_ = void 0;
+exports.default_ = __importStar(require("./default"));

package/api/resources/billingNotes/resources/v2/client/Client.js

@@ -73,7 +73,7 @@ class V2 {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CandidApiEnvironment.Production).candidApi, "/api/billing_notes/v2"),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "candidhealth/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.4.0", "User-Agent": "candidhealth/1.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.billingNotes.v2.StandaloneBillingNoteCreate.jsonOrThrow(request, {
@@ -113,7 +113,7 @@ class V2 {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CandidApiEnvironment.Production).candidApi, `/api/billing_notes/v2/${encodeURIComponent(serializers.billingNotes.v2.BillingNoteId.jsonOrThrow(billingNoteId))}`),
                 method: "DELETE",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "candidhealth/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.4.0", "User-Agent": "candidhealth/1.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -164,7 +164,7 @@ class V2 {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CandidApiEnvironment.Production).candidApi, `/api/billing_notes/v2/${encodeURIComponent(serializers.billingNotes.v2.BillingNoteId.jsonOrThrow(billingNoteId))}`),
                 method: "PATCH",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "candidhealth/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.4.0", "User-Agent": "candidhealth/1.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.billingNotes.v2.BillingNoteUpdate.jsonOrThrow(request, {

package/api/resources/billingNotes/resources/v2/types/BillingNoteBaseOptional.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface BillingNoteBaseOptional {
+    /** Empty string not allowed. */
+    text?: string;
+}

package/api/resources/billingNotes/resources/v2/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./BillingNoteId";
+export * from "./BillingNoteBaseOptional";
 export * from "./BillingNoteBase";
 export * from "./BillingNote";

package/api/resources/billingNotes/resources/v2/types/index.js

@@ -15,5 +15,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BillingNoteId"), exports);
+__exportStar(require("./BillingNoteBaseOptional"), exports);
 __exportStar(require("./BillingNoteBase"), exports);
 __exportStar(require("./BillingNote"), exports);

package/api/resources/chargeCapture/resources/v1/client/Client.js

@@ -76,7 +76,7 @@ class V1 {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CandidApiEnvironment.Production).candidApi, "/api/charge_captures/v1"),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "candidhealth/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.4.0", "User-Agent": "candidhealth/1.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.chargeCapture.v1.CreateChargeCaptureRequest.jsonOrThrow(request, {
@@ -136,7 +136,7 @@ class V1 {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CandidApiEnvironment.Production).candidApi, `/api/charge_captures/v1/${encodeURIComponent(serializers.ChargeCaptureId.jsonOrThrow(chargeCaptureId))}`),
                 method: "PATCH",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "candidhealth/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.4.0", "User-Agent": "candidhealth/1.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.chargeCapture.v1.ChargeCaptureUpdate.jsonOrThrow(request, {
@@ -194,7 +194,7 @@ class V1 {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CandidApiEnvironment.Production).candidApi, `/api/charge_captures/v1/${encodeURIComponent(serializers.ChargeCaptureId.jsonOrThrow(chargeCaptureId))}`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "candidhealth/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.4.0", "User-Agent": "candidhealth/1.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -228,7 +228,7 @@ class V1 {
     getAll() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b;
-            const { limit, sort, sortDirection, pageToken, patientExternalId, status, chargeExternalId, dateOfServiceMin, dateOfServiceMax, claimIds, claimCreationIds, billingProviderNpis, serviceFacilityName, primaryPayerIds, renderingProviderNpis, renderingProviderNames, supervisingProviderNpis, supervisingProviderNames, excludeChargesLinkedToClaims, patientExternalIdRankedSort, statusRankedSort, chargeExternalIdRankedSort, dateOfServiceMinRankedSort, dateOfServiceMaxRankedSort, claimIdsRankedSort, claimCreationIdsRankedSort, billingProviderNpisRankedSort, serviceFacilityNameRankedSort, primaryPayerIdsRankedSort, renderingProviderNpisRankedSort, renderingProviderNamesRankedSort, supervisingProviderNpisRankedSort, supervisingProviderNamesRankedSort, } = request;
+            const { limit, sort, sortDirection, pageToken, patientExternalId, status, chargeExternalId, dateOfServiceMin, dateOfServiceMax, claimIds, claimCreationIds, billingProviderNpis, serviceFacilityName, primaryPayerIds, renderingProviderNpis, renderingProviderNames, supervisingProviderNpis, supervisingProviderNames, excludeChargesLinkedToClaims, patientExternalIdRankedSort, statusRankedSort, chargeExternalIdRankedSort, dateOfServiceMinRankedSort, dateOfServiceMaxRankedSort, searchTerm, billableStatus, responsibleParty, claimIdsRankedSort, claimCreationIdsRankedSort, billingProviderNpisRankedSort, serviceFacilityNameRankedSort, primaryPayerIdsRankedSort, renderingProviderNpisRankedSort, renderingProviderNamesRankedSort, supervisingProviderNpisRankedSort, supervisingProviderNamesRankedSort, } = request;
             const _queryParams = {};
             if (limit != null) {
                 _queryParams["limit"] = limit.toString();
@@ -348,6 +348,17 @@ class V1 {
             if (dateOfServiceMaxRankedSort != null) {
                 _queryParams["date_of_service_max_ranked_sort"] = dateOfServiceMaxRankedSort;
             }
+            if (searchTerm != null) {
+                _queryParams["search_term"] = searchTerm;
+            }
+            if (billableStatus != null) {
+                _queryParams["billable_status"] = serializers.encounters.v4.BillableStatusType.jsonOrThrow(billableStatus, {
+                    unrecognizedObjectKeys: "strip",
+                });
+            }
+            if (responsibleParty != null) {
+                _queryParams["responsible_party"] = serializers.encounters.v4.ResponsiblePartyType.jsonOrThrow(responsibleParty, { unrecognizedObjectKeys: "strip" });
+            }
             if (claimIdsRankedSort != null) {
                 if (Array.isArray(claimIdsRankedSort)) {
                     _queryParams["claim_ids_ranked_sort"] = claimIdsRankedSort.map((item) => serializers.EncounterId.jsonOrThrow(item, { unrecognizedObjectKeys: "strip" }));
@@ -418,7 +429,7 @@ class V1 {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CandidApiEnvironment.Production).candidApi, "/api/charge_captures/v1"),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "candidhealth/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.4.0", "User-Agent": "candidhealth/1.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",
@@ -459,7 +470,7 @@ class V1 {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CandidApiEnvironment.Production).candidApi, "/api/charge_captures/v1/changes/"),
                 method: "PATCH",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "candidhealth/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.4.0", "User-Agent": "candidhealth/1.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.chargeCapture.v1.ChargeCapturePostBilledChangeUpdate.jsonOrThrow(request, {

package/api/resources/chargeCapture/resources/v1/client/requests/ChargeCaptureUpdate.d.ts

@@ -19,6 +19,10 @@ export interface ChargeCaptureUpdate {
      * Send full URL format for the external link (e.g. https://emr_charge_capture_url.com/123).
      */
     ehrSourceUrl?: string;
+    /** An optional string field denoting the originating system of the charge. */
+    originatingSystem?: string;
+    /** An optional string field denoting the user defined category of the claim creation. */
+    claimCreationCategory?: string;
     /** The patient ID from the external EMR platform for the patient */
     patientExternalId?: string;
     /** the status of the charge capture */

package/api/resources/chargeCapture/resources/v1/client/requests/CreateChargeCaptureRequest.d.ts

@@ -16,6 +16,10 @@ export interface CreateChargeCaptureRequest {
     data: CandidApi.chargeCapture.v1.ChargeCaptureData;
     /** A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI. */
     chargeExternalId: string;
+    /** An optional string field denoting the originating system of the charge. */
+    originatingSystem?: string;
+    /** An optional string field denoting the user defined category of the claim creation. */
+    claimCreationCategory?: string;
     /** External URL reference that links to Charge Capture details within the external system (e.g. the EHR visit page). Send full URL format for the external link (e.g. https://emr_charge_capture_url.com/123). */
     ehrSourceUrl?: string;
     /** The patient ID from the external EMR platform for the patient */

package/api/resources/chargeCapture/resources/v1/client/requests/GetAllChargeCapturesRequest.d.ts

@@ -108,6 +108,20 @@ export interface GetAllChargeCapturesRequest {
      * This date must be the local date in the timezone where the service occurred.
      */
     dateOfServiceMaxRankedSort?: string;
+    /**
+     * Filter by any of the following fields: charge_id, claim_id, patient external_id,
+     * patient date of birth, patient first name, patient last name,
+     * or charge external id.
+     */
+    searchTerm?: string;
+    /**
+     * Defines if the Encounter is to be billed by Candid to the responsible_party. Examples for when this should be set to NOT_BILLABLE include if the Encounter has not occurred yet or if there is no intention of ever billing the responsible_party.
+     */
+    billableStatus?: CandidApi.encounters.v4.BillableStatusType;
+    /**
+     * Defines the party to be billed with the initial balance owed on the claim. Use SELF_PAY if you intend to bill self pay/cash pay.
+     */
+    responsibleParty?: CandidApi.encounters.v4.ResponsiblePartyType;
     /**
      * A list of claim IDs to show first. This will return all charge captures that have a resulting claim with one of the IDs in this list.
      */

package/api/resources/chargeCapture/resources/v1/types/ChargeCapture.d.ts

@@ -10,6 +10,8 @@ export interface ChargeCapture {
     patientExternalId: CandidApi.PatientExternalId;
     chargeExternalId: string;
     ehrSourceUrl?: string;
+    originatingSystem?: string;
+    claimCreationCategory?: string;
     error?: CandidApi.chargeCapture.v1.ChargeCaptureError;
     updates: CandidApi.chargeCapture.v1.ChargeCapturePostBilledChange[];
     claimCreationId?: CandidApi.ChargeCaptureClaimCreationId;

package/api/resources/chargeCapture/resources/v1/types/ChargeCaptureData.d.ts

@@ -2,56 +2,5 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../../../../index";
-export interface ChargeCaptureData extends CandidApi.encounters.v4.EncounterOptional {
-    /**
-     * Ideally, this field should contain no more than 12 diagnoses. However, more diagnoses
-     * may be submitted at this time, and coders will later prioritize the 12 that will be
-     * submitted to the payor.
-     */
-    diagnoses?: CandidApi.DiagnosisCreate[];
-    interventions?: CandidApi.encounters.v4.Intervention[];
-    /**
-     * ***This field is in beta.***
-     * To be included for claims that have been submitted outside of Candid.
-     * Candid supports posting remits and payments to these claims and working them in-platform (e.g. editing, resubmitting).
-     */
-    externalClaimSubmission?: CandidApi.claimSubmission.v1.ExternalClaimSubmissionCreate;
-    /**
-     * Each service line must be linked to a diagnosis. Concretely,
-     * `service_line.diagnosis_pointers`must contain at least one entry which should be
-     * in bounds of the diagnoses list field.
-     */
-    serviceLines?: CandidApi.serviceLines.v2.ServiceLineCreate[];
-    patientHistories?: CandidApi.encounters.v4.PatientHistoryCategory[];
-    /**
-     * Spot to store misc, human-readable, notes about this encounter to be
-     * used in the billing process.
-     */
-    billingNotes?: CandidApi.billingNotes.v2.BillingNoteBase[];
-    /** Contains the identification information of the individual receiving medical services. */
-    patient?: CandidApi.PatientUpdateWithOptionalAddress;
-    /** Encounter Service facility is typically the location a medical service was rendered, such as a provider office or hospital. For telehealth, service facility can represent the provider's location when the service was delivered (e.g., home), or the location where an in-person visit would have taken place, whichever is easier to identify. If the provider is in-network, service facility may be defined in payer contracts. Box 32 on the CMS-1500 claim form. Note that for an in-network claim to be successfully adjudicated, the service facility address listed on claims must match what was provided to the payer during the credentialing process. */
-    serviceFacility?: CandidApi.EncounterServiceFacilityUpdateWithOptionalAddress;
-    /**
-     * The rendering provider is the practitioner -- physician, nurse practitioner, etc. -- performing the service.
-     * For telehealth services, the rendering provider performs the visit, asynchronous communication, or other service. The rendering provider address should generally be the same as the service facility address.
-     */
-    renderingProvider?: CandidApi.encounterProviders.v2.RenderingProviderUpdateWithOptionalAddress;
-    /**
-     * The second iteration of Loop ID-2310. Use code "P3 - Primary Care Provider" in this loop to
-     * indicate the initial referral from the primary care provider or whatever provider wrote the initial referral for this patient's episode of care being billed/reported in this transaction.
-     */
-    initialReferringProvider?: CandidApi.encounterProviders.v2.InitialReferringProviderUpdateWithOptionalAddress;
-    /**
-     * The final provider who referred the services that were rendered.
-     * All physicians who order services or refer Medicare beneficiaries must
-     * report this data.
-     */
-    referringProvider?: CandidApi.encounterProviders.v2.ReferringProviderUpdateWithOptionalAddress;
-    /** Required when the rendering provider is supervised by a physician. If not required by this implementation guide, do not send. */
-    supervisingProvider?: CandidApi.encounterProviders.v2.SupervisingProviderUpdateWithOptionalAddress;
-    /** The billing provider is the provider or business entity submitting the claim. Billing provider may be, but is not necessarily, the same person/NPI as the rendering provider. From a payer's perspective, this represents the person or entity being reimbursed. When a contract exists with the target payer, the billing provider should be the entity contracted with the payer. In some circumstances, this will be an individual provider. In that case, submit that provider's NPI and the tax ID (TIN) that the provider gave to the payer during contracting. In other cases, the billing entity will be a medical group. If so, submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim form. */
-    billingProvider?: CandidApi.encounterProviders.v2.BillingProviderUpdateWithOptionalAddress;
-    /** Specifies the address to which payments for the claim should be sent. */
-    payToAddress?: CandidApi.StreetAddressShortZipOptional;
+export interface ChargeCaptureData extends CandidApi.encounters.v4.EncounterDeepOptional {
 }

package/api/resources/chargeCapture/resources/v1/types/ChargeCaptureError.d.ts

@@ -12,6 +12,12 @@ export interface ChargeCaptureError {
     chargeCaptureId?: CandidApi.ChargeCaptureId;
     /** A human readable error explaining why this charge capture Claim Creation failed to create a claim. */
     message: string;
+    /** Whether or not the error has been resolved as part of user workflows */
+    resolved?: boolean;
+    /** A string denoting who resolved the error within candid's system. */
+    resolvedBy?: string;
+    /** A string denoting how or why an error was resolved. */
+    resolutionReason?: string;
     /**
      * The field of the corresponding underlying ChargeCapture that has a field that is failing validations,
      * is not present but marked as required, or otherwise in error.

package/api/resources/chargeCapture/resources/v1/types/index.d.ts

@@ -1,6 +1,6 @@
+export * from "./ChargeCaptureData";
 export * from "./ChargeCapturePage";
 export * from "./ChargeCapture";
-export * from "./ChargeCaptureData";
 export * from "./ChargeCaptureError";
 export * from "./ChargeCaptureSortField";
 export * from "./ChargeCaptureStatus";