@mergeapi/merge-node-client 1.0.5 → 1.0.6

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

@@ -35,7 +35,7 @@ export declare class Folders {
      *         model: {
      *             name: "Platform",
      *             folderUrl: "https://drive.com/1234",
-     *             size: 2738000,
+     *             size: 1,
      *             description: "This is a wild folder."
      *         }
      *     })
@@ -45,7 +45,7 @@ export declare class Folders {
      * Returns a `Folder` object with the given `id`.
      *
      * @example
-     *     await merge.filestorage.folders.retrieve("id", {
+     *     await merge.filestorage.folders.retrieve("string", {
      *         expand: Merge.filestorage.FoldersRetrieveRequestExpand.Drive
      *     })
      */

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

@@ -121,7 +121,7 @@ class Folders {
                         : undefined,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
-                    "X-Fern-SDK-Version": "1.0.5",
+                    "X-Fern-SDK-Version": "1.0.6",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -165,7 +165,7 @@ class Folders {
      *         model: {
      *             name: "Platform",
      *             folderUrl: "https://drive.com/1234",
-     *             size: 2738000,
+     *             size: 1,
      *             description: "This is a wild folder."
      *         }
      *     })
@@ -191,7 +191,7 @@ class Folders {
                         : undefined,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
-                    "X-Fern-SDK-Version": "1.0.5",
+                    "X-Fern-SDK-Version": "1.0.6",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -234,7 +234,7 @@ class Folders {
      * Returns a `Folder` object with the given `id`.
      *
      * @example
-     *     await merge.filestorage.folders.retrieve("id", {
+     *     await merge.filestorage.folders.retrieve("string", {
      *         expand: Merge.filestorage.FoldersRetrieveRequestExpand.Drive
      *     })
      */
@@ -259,7 +259,7 @@ class Folders {
                         : undefined,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
-                    "X-Fern-SDK-Version": "1.0.5",
+                    "X-Fern-SDK-Version": "1.0.6",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -314,7 +314,7 @@ class Folders {
                         : undefined,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
-                    "X-Fern-SDK-Version": "1.0.5",
+                    "X-Fern-SDK-Version": "1.0.6",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/api/resources/filestorage/resources/folders/client/requests/FileStorageFolderEndpointRequest.d.ts

@@ -8,7 +8,7 @@ import * as Merge from "../../../../../..";
  *         model: {
  *             name: "Platform",
  *             folderUrl: "https://drive.com/1234",
- *             size: 2738000,
+ *             size: 1,
  *             description: "This is a wild folder."
  *         }
  *     }

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

@@ -19,7 +19,7 @@ export declare class ForceResync {
     protected readonly _options: ForceResync.Options;
     constructor(_options: ForceResync.Options);
     /**
-     * Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Core, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
+     * Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Launch, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
      *
      * @example
      *     await merge.filestorage.forceResync.syncStatusResyncCreate()

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

@@ -49,7 +49,7 @@ class ForceResync {
         this._options = _options;
     }
     /**
-     * Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Core, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
+     * Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Launch, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
      *
      * @example
      *     await merge.filestorage.forceResync.syncStatusResyncCreate()
@@ -67,7 +67,7 @@ class ForceResync {
                         : undefined,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
-                    "X-Fern-SDK-Version": "1.0.5",
+                    "X-Fern-SDK-Version": "1.0.6",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

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

@@ -69,7 +69,7 @@ class GenerateKey {
                         : undefined,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
-                    "X-Fern-SDK-Version": "1.0.5",
+                    "X-Fern-SDK-Version": "1.0.6",
                 },
                 contentType: "application/json",
                 body: yield serializers.filestorage.GenerateRemoteKeyRequest.jsonOrThrow(request, {

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

@@ -29,7 +29,7 @@ export declare class Groups {
      * Returns a `Group` object with the given `id`.
      *
      * @example
-     *     await merge.filestorage.groups.retrieve("id", {})
+     *     await merge.filestorage.groups.retrieve("string", {})
      */
     retrieve(id: string, request?: Merge.filestorage.GroupsRetrieveRequest, requestOptions?: Groups.RequestOptions): Promise<Merge.filestorage.Group>;
     protected _getAuthorizationHeader(): Promise<string>;

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

@@ -96,7 +96,7 @@ class Groups {
                         : undefined,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
-                    "X-Fern-SDK-Version": "1.0.5",
+                    "X-Fern-SDK-Version": "1.0.6",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -136,7 +136,7 @@ class Groups {
      * Returns a `Group` object with the given `id`.
      *
      * @example
-     *     await merge.filestorage.groups.retrieve("id", {})
+     *     await merge.filestorage.groups.retrieve("string", {})
      */
     retrieve(id, request = {}, requestOptions) {
         var _a;
@@ -156,7 +156,7 @@ class Groups {
                         : undefined,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
-                    "X-Fern-SDK-Version": "1.0.5",
+                    "X-Fern-SDK-Version": "1.0.6",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,

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

@@ -11,8 +11,10 @@ export * as accountToken from "./accountToken";
 export * as asyncPassthrough from "./asyncPassthrough";
 export * as auditTrail from "./auditTrail";
 export * as availableActions from "./availableActions";
+export * as scopes from "./scopes";
 export * as deleteAccount from "./deleteAccount";
 export * as drives from "./drives";
+export * as fieldMapping from "./fieldMapping";
 export * as generateKey from "./generateKey";
 export * as groups from "./groups";
 export * as linkToken from "./linkToken";
@@ -24,7 +26,9 @@ export * as forceResync from "./forceResync";
 export * as users from "./users";
 export * as webhookReceivers from "./webhookReceivers";
 export * from "./auditTrail/client/requests";
+export * from "./scopes/client/requests";
 export * from "./drives/client/requests";
+export * from "./fieldMapping/client/requests";
 export * from "./files/client/requests";
 export * from "./folders/client/requests";
 export * from "./generateKey/client/requests";

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

@@ -26,7 +26,7 @@ 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 });
-exports.webhookReceivers = exports.users = exports.forceResync = exports.syncStatus = exports.selectiveSync = exports.regenerateKey = exports.passthrough = exports.linkToken = exports.groups = exports.generateKey = exports.drives = exports.deleteAccount = exports.availableActions = exports.auditTrail = exports.asyncPassthrough = exports.accountToken = exports.accountDetails = exports.linkedAccounts = exports.issues = exports.folders = exports.files = void 0;
+exports.webhookReceivers = exports.users = exports.forceResync = exports.syncStatus = exports.selectiveSync = exports.regenerateKey = exports.passthrough = exports.linkToken = exports.groups = exports.generateKey = exports.fieldMapping = exports.drives = exports.deleteAccount = exports.scopes = exports.availableActions = exports.auditTrail = exports.asyncPassthrough = exports.accountToken = exports.accountDetails = exports.linkedAccounts = exports.issues = exports.folders = exports.files = void 0;
 exports.files = __importStar(require("./files"));
 __exportStar(require("./files/types"), exports);
 exports.folders = __importStar(require("./folders"));
@@ -40,8 +40,10 @@ exports.accountToken = __importStar(require("./accountToken"));
 exports.asyncPassthrough = __importStar(require("./asyncPassthrough"));
 exports.auditTrail = __importStar(require("./auditTrail"));
 exports.availableActions = __importStar(require("./availableActions"));
+exports.scopes = __importStar(require("./scopes"));
 exports.deleteAccount = __importStar(require("./deleteAccount"));
 exports.drives = __importStar(require("./drives"));
+exports.fieldMapping = __importStar(require("./fieldMapping"));
 exports.generateKey = __importStar(require("./generateKey"));
 exports.groups = __importStar(require("./groups"));
 exports.linkToken = __importStar(require("./linkToken"));
@@ -53,7 +55,9 @@ exports.forceResync = __importStar(require("./forceResync"));
 exports.users = __importStar(require("./users"));
 exports.webhookReceivers = __importStar(require("./webhookReceivers"));
 __exportStar(require("./auditTrail/client/requests"), exports);
+__exportStar(require("./scopes/client/requests"), exports);
 __exportStar(require("./drives/client/requests"), exports);
+__exportStar(require("./fieldMapping/client/requests"), exports);
 __exportStar(require("./files/client/requests"), exports);
 __exportStar(require("./folders/client/requests"), exports);
 __exportStar(require("./generateKey/client/requests"), exports);

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

@@ -31,7 +31,7 @@ export declare class Issues {
      * Get a specific issue.
      *
      * @example
-     *     await merge.filestorage.issues.retrieve("id")
+     *     await merge.filestorage.issues.retrieve("string")
      */
     retrieve(id: string, requestOptions?: Issues.RequestOptions): Promise<Merge.filestorage.Issue>;
     protected _getAuthorizationHeader(): Promise<string>;

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

@@ -110,7 +110,7 @@ class Issues {
                         : undefined,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
-                    "X-Fern-SDK-Version": "1.0.5",
+                    "X-Fern-SDK-Version": "1.0.6",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -150,7 +150,7 @@ class Issues {
      * Get a specific issue.
      *
      * @example
-     *     await merge.filestorage.issues.retrieve("id")
+     *     await merge.filestorage.issues.retrieve("string")
      */
     retrieve(id, requestOptions) {
         var _a;
@@ -165,7 +165,7 @@ class Issues {
                         : undefined,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
-                    "X-Fern-SDK-Version": "1.0.5",
+                    "X-Fern-SDK-Version": "1.0.6",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/api/resources/filestorage/resources/issues/client/requests/IssuesListRequest.d.ts

@@ -28,7 +28,7 @@ export interface IssuesListRequest {
      */
     firstIncidentTimeBefore?: Date;
     /**
-     * If True, will include muted issues
+     * If true, will include muted issues
      */
     includeMuted?: string;
     integrationName?: string;

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

@@ -20,6 +20,15 @@ export declare class LinkToken {
     constructor(_options: LinkToken.Options);
     /**
      * Creates a link token to be used when linking a new end user.
+     *
+     * @example
+     *     await merge.filestorage.linkToken.create({
+     *         endUserEmailAddress: "example@gmail.com",
+     *         endUserOrganizationName: "Test Organization",
+     *         endUserOriginId: "12345",
+     *         categories: [],
+     *         integration: "bamboohr"
+     *     })
      */
     create(request: Merge.filestorage.EndUserDetailsRequest, requestOptions?: LinkToken.RequestOptions): Promise<Merge.filestorage.LinkToken>;
     protected _getAuthorizationHeader(): Promise<string>;

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

@@ -50,6 +50,15 @@ class LinkToken {
     }
     /**
      * Creates a link token to be used when linking a new end user.
+     *
+     * @example
+     *     await merge.filestorage.linkToken.create({
+     *         endUserEmailAddress: "example@gmail.com",
+     *         endUserOrganizationName: "Test Organization",
+     *         endUserOriginId: "12345",
+     *         categories: [],
+     *         integration: "bamboohr"
+     *     })
      */
     create(request, requestOptions) {
         var _a;
@@ -64,7 +73,7 @@ class LinkToken {
                         : undefined,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
-                    "X-Fern-SDK-Version": "1.0.5",
+                    "X-Fern-SDK-Version": "1.0.6",
                 },
                 contentType: "application/json",
                 body: yield serializers.filestorage.EndUserDetailsRequest.jsonOrThrow(request, {

package/api/resources/filestorage/resources/linkToken/client/requests/EndUserDetailsRequest.d.ts

@@ -2,6 +2,16 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Merge from "../../../../../..";
+/**
+ * @example
+ *     {
+ *         endUserEmailAddress: "example@gmail.com",
+ *         endUserOrganizationName: "Test Organization",
+ *         endUserOriginId: "12345",
+ *         categories: [],
+ *         integration: "bamboohr"
+ *     }
+ */
 export interface EndUserDetailsRequest {
     /** Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent. */
     endUserEmailAddress: string;
@@ -19,4 +29,6 @@ export interface EndUserDetailsRequest {
     shouldCreateMagicLinkUrl?: boolean;
     /** An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. */
     commonModels?: Merge.filestorage.CommonModelScopesBodyRequest[];
+    /** When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. */
+    categoryCommonModelScopes?: Record<string, Merge.filestorage.IndividualCommonModelScopeDeserializerRequest[] | undefined>;
 }

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

@@ -110,7 +110,7 @@ class LinkedAccounts {
                         : undefined,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
-                    "X-Fern-SDK-Version": "1.0.5",
+                    "X-Fern-SDK-Version": "1.0.6",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,

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

@@ -20,6 +20,14 @@ export declare class Passthrough {
     constructor(_options: Passthrough.Options);
     /**
      * Pull data from an endpoint not currently supported by Merge.
+     *
+     * @example
+     *     await merge.filestorage.passthrough.create({
+     *         method: Merge.filestorage.MethodEnum.Get,
+     *         path: "/scooters",
+     *         data: "{\"company\": \"Lime\", \"model\": \"Gen 2.5\"}",
+     *         requestFormat: Merge.filestorage.RequestFormatEnum.Json
+     *     })
      */
     create(request: Merge.filestorage.DataPassthroughRequest, requestOptions?: Passthrough.RequestOptions): Promise<Merge.filestorage.RemoteResponse>;
     protected _getAuthorizationHeader(): Promise<string>;

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

@@ -50,6 +50,14 @@ class Passthrough {
     }
     /**
      * Pull data from an endpoint not currently supported by Merge.
+     *
+     * @example
+     *     await merge.filestorage.passthrough.create({
+     *         method: Merge.filestorage.MethodEnum.Get,
+     *         path: "/scooters",
+     *         data: "{\"company\": \"Lime\", \"model\": \"Gen 2.5\"}",
+     *         requestFormat: Merge.filestorage.RequestFormatEnum.Json
+     *     })
      */
     create(request, requestOptions) {
         var _a;
@@ -64,7 +72,7 @@ class Passthrough {
                         : undefined,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
-                    "X-Fern-SDK-Version": "1.0.5",
+                    "X-Fern-SDK-Version": "1.0.6",
                 },
                 contentType: "application/json",
                 body: yield serializers.filestorage.DataPassthroughRequest.jsonOrThrow(request, {

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

@@ -69,7 +69,7 @@ class RegenerateKey {
                         : undefined,
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@mergeapi/merge-node-client",
-                    "X-Fern-SDK-Version": "1.0.5",
+                    "X-Fern-SDK-Version": "1.0.6",
                 },
                 contentType: "application/json",
                 body: yield serializers.filestorage.RemoteKeyForRegenerationRequest.jsonOrThrow(request, {

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

@@ -0,0 +1,45 @@
+/**
+ * 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 Scopes {
+    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 Scopes {
+    protected readonly _options: Scopes.Options;
+    constructor(_options: Scopes.Options);
+    /**
+     * Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn More](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+     *
+     * @example
+     *     await merge.filestorage.scopes.defaultScopesRetrieve()
+     */
+    defaultScopesRetrieve(requestOptions?: Scopes.RequestOptions): Promise<Merge.filestorage.CommonModelScopeApi>;
+    /**
+     * Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn More](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+     *
+     * @example
+     *     await merge.filestorage.scopes.linkedAccountScopesRetrieve()
+     */
+    linkedAccountScopesRetrieve(requestOptions?: Scopes.RequestOptions): Promise<Merge.filestorage.CommonModelScopeApi>;
+    /**
+     * Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn More](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes)
+     *
+     * @example
+     *     await merge.filestorage.scopes.linkedAccountScopesCreate({
+     *         commonModels: []
+     *     })
+     */
+    linkedAccountScopesCreate(request: Merge.filestorage.LinkedAccountCommonModelScopeDeserializerRequest, requestOptions?: Scopes.RequestOptions): Promise<Merge.filestorage.CommonModelScopeApi>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}