@mergeapi/merge-node-client 1.0.5 → 1.0.7

package/api/resources/filestorage/resources/fieldMapping/client/Client.d.ts

@@ -0,0 +1,74 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../environments";
+import * as core from "../../../../../../core";
+import * as Merge from "../../../../..";
+export declare namespace FieldMapping {
+    interface Options {
+        environment?: core.Supplier<environments.MergeEnvironment | string>;
+        apiKey: core.Supplier<core.BearerToken>;
+        accountToken?: core.Supplier<string | undefined>;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+    }
+}
+export declare class FieldMapping {
+    protected readonly _options: FieldMapping.Options;
+    constructor(_options: FieldMapping.Options);
+    /**
+     * Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+     *
+     * @example
+     *     await merge.filestorage.fieldMapping.fieldMappingsRetrieve()
+     */
+    fieldMappingsRetrieve(requestOptions?: FieldMapping.RequestOptions): Promise<Merge.filestorage.FieldMappingApiInstanceResponse>;
+    /**
+     * Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+     *
+     * @example
+     *     await merge.filestorage.fieldMapping.fieldMappingsCreate({
+     *         targetFieldName: "example_target_field_name",
+     *         targetFieldDescription: "this is a example description of the target field",
+     *         remoteFieldTraversalPath: [],
+     *         remoteMethod: "GET",
+     *         remoteUrlPath: "/example-url-path",
+     *         commonModelName: "ExampleCommonModel"
+     *     })
+     */
+    fieldMappingsCreate(request: Merge.filestorage.CreateFieldMappingRequest, requestOptions?: FieldMapping.RequestOptions): Promise<Merge.filestorage.FieldMappingInstanceResponse>;
+    /**
+     * Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+     *
+     * @example
+     *     await merge.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id")
+     */
+    fieldMappingsDestroy(fieldMappingId: string, requestOptions?: FieldMapping.RequestOptions): Promise<Merge.filestorage.FieldMappingInstanceResponse>;
+    /**
+     * Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+     *
+     * @example
+     *     await merge.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id", {
+     *         remoteMethod: "GET",
+     *         remoteUrlPath: "/example-url-path"
+     *     })
+     */
+    fieldMappingsPartialUpdate(fieldMappingId: string, request?: Merge.filestorage.PatchedEditFieldMappingRequest, requestOptions?: FieldMapping.RequestOptions): Promise<Merge.filestorage.FieldMappingInstanceResponse>;
+    /**
+     * Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+     *
+     * @example
+     *     await merge.filestorage.fieldMapping.remoteFieldsRetrieve({})
+     */
+    remoteFieldsRetrieve(request?: Merge.filestorage.RemoteFieldsRetrieveRequest, requestOptions?: FieldMapping.RequestOptions): Promise<Merge.filestorage.RemoteFieldApiResponse>;
+    /**
+     * Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+     *
+     * @example
+     *     await merge.filestorage.fieldMapping.targetFieldsRetrieve()
+     */
+    targetFieldsRetrieve(requestOptions?: FieldMapping.RequestOptions): Promise<Merge.filestorage.ExternalTargetFieldApiResponse>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}

package/api/resources/filestorage/resources/fieldMapping/client/Client.js

@@ -0,0 +1,406 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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.FieldMapping = void 0;
+const environments = __importStar(require("../../../../../../environments"));
+const core = __importStar(require("../../../../../../core"));
+const url_join_1 = __importDefault(require("url-join"));
+const serializers = __importStar(require("../../../../../../serialization"));
+const errors = __importStar(require("../../../../../../errors"));
+class FieldMapping {
+    constructor(_options) {
+        this._options = _options;
+    }
+    /**
+     * Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+     *
+     * @example
+     *     await merge.filestorage.fieldMapping.fieldMappingsRetrieve()
+     */
+    fieldMappingsRetrieve(requestOptions) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.MergeEnvironment.Production, "filestorage/v1/field-mappings"),
+                method: "GET",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Account-Token": (yield core.Supplier.get(this._options.accountToken)) != null
+                        ? yield core.Supplier.get(this._options.accountToken)
+                        : undefined,
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
+                    "X-Fern-SDK-Version": "1.0.7",
+                },
+                contentType: "application/json",
+                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,
+            });
+            if (_response.ok) {
+                return yield serializers.filestorage.FieldMappingApiInstanceResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.MergeError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.MergeError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.MergeTimeoutError();
+                case "unknown":
+                    throw new errors.MergeError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+     *
+     * @example
+     *     await merge.filestorage.fieldMapping.fieldMappingsCreate({
+     *         targetFieldName: "example_target_field_name",
+     *         targetFieldDescription: "this is a example description of the target field",
+     *         remoteFieldTraversalPath: [],
+     *         remoteMethod: "GET",
+     *         remoteUrlPath: "/example-url-path",
+     *         commonModelName: "ExampleCommonModel"
+     *     })
+     */
+    fieldMappingsCreate(request, requestOptions) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.MergeEnvironment.Production, "filestorage/v1/field-mappings"),
+                method: "POST",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Account-Token": (yield core.Supplier.get(this._options.accountToken)) != null
+                        ? yield core.Supplier.get(this._options.accountToken)
+                        : undefined,
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
+                    "X-Fern-SDK-Version": "1.0.7",
+                },
+                contentType: "application/json",
+                body: yield serializers.filestorage.CreateFieldMappingRequest.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,
+            });
+            if (_response.ok) {
+                return yield serializers.filestorage.FieldMappingInstanceResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.MergeError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.MergeError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.MergeTimeoutError();
+                case "unknown":
+                    throw new errors.MergeError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+     *
+     * @example
+     *     await merge.filestorage.fieldMapping.fieldMappingsDestroy("field_mapping_id")
+     */
+    fieldMappingsDestroy(fieldMappingId, requestOptions) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.MergeEnvironment.Production, `filestorage/v1/field-mappings/${fieldMappingId}`),
+                method: "DELETE",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Account-Token": (yield core.Supplier.get(this._options.accountToken)) != null
+                        ? yield core.Supplier.get(this._options.accountToken)
+                        : undefined,
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
+                    "X-Fern-SDK-Version": "1.0.7",
+                },
+                contentType: "application/json",
+                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,
+            });
+            if (_response.ok) {
+                return yield serializers.filestorage.FieldMappingInstanceResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.MergeError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.MergeError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.MergeTimeoutError();
+                case "unknown":
+                    throw new errors.MergeError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+     *
+     * @example
+     *     await merge.filestorage.fieldMapping.fieldMappingsPartialUpdate("field_mapping_id", {
+     *         remoteMethod: "GET",
+     *         remoteUrlPath: "/example-url-path"
+     *     })
+     */
+    fieldMappingsPartialUpdate(fieldMappingId, request = {}, requestOptions) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.MergeEnvironment.Production, `filestorage/v1/field-mappings/${fieldMappingId}`),
+                method: "PATCH",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Account-Token": (yield core.Supplier.get(this._options.accountToken)) != null
+                        ? yield core.Supplier.get(this._options.accountToken)
+                        : undefined,
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
+                    "X-Fern-SDK-Version": "1.0.7",
+                },
+                contentType: "application/json",
+                body: yield serializers.filestorage.PatchedEditFieldMappingRequest.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,
+            });
+            if (_response.ok) {
+                return yield serializers.filestorage.FieldMappingInstanceResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.MergeError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.MergeError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.MergeTimeoutError();
+                case "unknown":
+                    throw new errors.MergeError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+     *
+     * @example
+     *     await merge.filestorage.fieldMapping.remoteFieldsRetrieve({})
+     */
+    remoteFieldsRetrieve(request = {}, requestOptions) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const { commonModels, includeExampleValues } = request;
+            const _queryParams = {};
+            if (commonModels != null) {
+                _queryParams["common_models"] = commonModels;
+            }
+            if (includeExampleValues != null) {
+                _queryParams["include_example_values"] = includeExampleValues;
+            }
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.MergeEnvironment.Production, "filestorage/v1/remote-fields"),
+                method: "GET",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Account-Token": (yield core.Supplier.get(this._options.accountToken)) != null
+                        ? yield core.Supplier.get(this._options.accountToken)
+                        : undefined,
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
+                    "X-Fern-SDK-Version": "1.0.7",
+                },
+                contentType: "application/json",
+                queryParameters: _queryParams,
+                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,
+            });
+            if (_response.ok) {
+                return yield serializers.filestorage.RemoteFieldApiResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.MergeError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.MergeError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.MergeTimeoutError();
+                case "unknown":
+                    throw new errors.MergeError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+     *
+     * @example
+     *     await merge.filestorage.fieldMapping.targetFieldsRetrieve()
+     */
+    targetFieldsRetrieve(requestOptions) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.MergeEnvironment.Production, "filestorage/v1/target-fields"),
+                method: "GET",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Account-Token": (yield core.Supplier.get(this._options.accountToken)) != null
+                        ? yield core.Supplier.get(this._options.accountToken)
+                        : undefined,
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
+                    "X-Fern-SDK-Version": "1.0.7",
+                },
+                contentType: "application/json",
+                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,
+            });
+            if (_response.ok) {
+                return yield serializers.filestorage.ExternalTargetFieldApiResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.MergeError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.MergeError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.MergeTimeoutError();
+                case "unknown":
+                    throw new errors.MergeError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    _getAuthorizationHeader() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return `Bearer ${yield core.Supplier.get(this._options.apiKey)}`;
+        });
+    }
+}
+exports.FieldMapping = FieldMapping;

package/api/resources/filestorage/resources/fieldMapping/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./requests";

package/api/resources/filestorage/resources/fieldMapping/client/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requests"), exports);

package/api/resources/filestorage/resources/fieldMapping/client/requests/CreateFieldMappingRequest.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         targetFieldName: "example_target_field_name",
+ *         targetFieldDescription: "this is a example description of the target field",
+ *         remoteFieldTraversalPath: [],
+ *         remoteMethod: "GET",
+ *         remoteUrlPath: "/example-url-path",
+ *         commonModelName: "ExampleCommonModel"
+ *     }
+ */
+export interface CreateFieldMappingRequest {
+    /** The name of the target field you want this remote field to map to. */
+    targetFieldName: string;
+    /** The description of the target field you want this remote field to map to. */
+    targetFieldDescription: string;
+    /** The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. */
+    remoteFieldTraversalPath: unknown[];
+    /** The method of the remote endpoint where the remote field is coming from. */
+    remoteMethod: string;
+    /** The path of the remote endpoint where the remote field is coming from. */
+    remoteUrlPath: string;
+    /** The name of the Common Model that the remote field corresponds to in a given category. */
+    commonModelName: string;
+}

package/api/resources/filestorage/resources/fieldMapping/client/requests/CreateFieldMappingRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/filestorage/resources/fieldMapping/client/requests/PatchedEditFieldMappingRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         remoteMethod: "GET",
+ *         remoteUrlPath: "/example-url-path"
+ *     }
+ */
+export interface PatchedEditFieldMappingRequest {
+    /** The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. */
+    remoteFieldTraversalPath?: unknown[];
+    /** The method of the remote endpoint where the remote field is coming from. */
+    remoteMethod?: string;
+    /** The path of the remote endpoint where the remote field is coming from. */
+    remoteUrlPath?: string;
+}

package/api/resources/filestorage/resources/fieldMapping/client/requests/PatchedEditFieldMappingRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/filestorage/resources/fieldMapping/client/requests/RemoteFieldsRetrieveRequest.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface RemoteFieldsRetrieveRequest {
+    /**
+     * A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
+     */
+    commonModels?: string;
+    /**
+     * If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
+     */
+    includeExampleValues?: string;
+}

package/api/resources/filestorage/resources/fieldMapping/client/requests/RemoteFieldsRetrieveRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/filestorage/resources/fieldMapping/client/requests/index.d.ts

@@ -0,0 +1,3 @@
+export { CreateFieldMappingRequest } from "./CreateFieldMappingRequest";
+export { PatchedEditFieldMappingRequest } from "./PatchedEditFieldMappingRequest";
+export { RemoteFieldsRetrieveRequest } from "./RemoteFieldsRetrieveRequest";

package/api/resources/filestorage/resources/fieldMapping/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/filestorage/resources/fieldMapping/index.d.ts

@@ -0,0 +1 @@
+export * from "./client";

package/api/resources/filestorage/resources/fieldMapping/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client"), exports);

package/api/resources/filestorage/resources/files/client/Client.d.ts

@@ -24,9 +24,7 @@ export declare class Files {
      * Returns a list of `File` objects.
      *
      * @example
-     *     await merge.filestorage.files.list({
-     *         expand: Merge.filestorage.FilesListRequestExpand.Drive
-     *     })
+     *     await merge.filestorage.files.list({})
      */
     list(request?: Merge.filestorage.FilesListRequest, requestOptions?: Files.RequestOptions): Promise<Merge.filestorage.PaginatedFileList>;
     /**
@@ -34,14 +32,7 @@ export declare class Files {
      *
      * @example
      *     await merge.filestorage.files.create({
-     *         model: {
-     *             name: "omg_common_model_scope.docx",
-     *             fileUrl: "https://drive.com/1234",
-     *             fileThumbnailUrl: "https://drive.com/1234/thumbnail.png",
-     *             size: 254,
-     *             mimeType: ".docx",
-     *             description: "This file is OP"
-     *         }
+     *         model: {}
      *     })
      */
     create(request: Merge.filestorage.FileStorageFileEndpointRequest, requestOptions?: Files.RequestOptions): Promise<Merge.filestorage.FileStorageFileResponse>;
@@ -49,9 +40,7 @@ export declare class Files {
      * Returns a `File` object with the given `id`.
      *
      * @example
-     *     await merge.filestorage.files.retrieve("id", {
-     *         expand: Merge.filestorage.FilesRetrieveRequestExpand.Drive
-     *     })
+     *     await merge.filestorage.files.retrieve("id", {})
      */
     retrieve(id: string, request?: Merge.filestorage.FilesRetrieveRequest, requestOptions?: Files.RequestOptions): Promise<Merge.filestorage.File_>;
     /**