@mergeapi/merge-node-client 1.0.5 → 1.0.7

package/dist/api/resources/crm/resources/notes/client/requests/NoteEndpointRequest.d.ts

@@ -5,9 +5,7 @@ import * as Merge from "../../../../../..";
 /**
  * @example
  *     {
- *         model: {
- *             content: "Merge is hiring!"
- *         }
+ *         model: {}
  *     }
  */
 export interface NoteEndpointRequest {

package/dist/api/resources/crm/resources/notes/client/requests/NotesListRequest.d.ts

@@ -4,9 +4,7 @@
 import * as Merge from "../../../../../..";
 /**
  * @example
- *     {
- *         expand: Merge.crm.NotesListRequestExpand.Account
- *     }
+ *     {}
  */
 export interface NotesListRequest {
     /**

package/dist/api/resources/crm/resources/notes/client/requests/NotesRetrieveRequest.d.ts

@@ -4,9 +4,7 @@
 import * as Merge from "../../../../../..";
 /**
  * @example
- *     {
- *         expand: Merge.crm.NotesRetrieveRequestExpand.Account
- *     }
+ *     {}
  */
 export interface NotesRetrieveRequest {
     /**

package/dist/api/resources/crm/resources/opportunities/client/Client.d.ts

@@ -22,12 +22,7 @@ export declare class Opportunities {
      * Returns a list of `Opportunity` objects.
      *
      * @example
-     *     await merge.crm.opportunities.list({
-     *         expand: Merge.crm.OpportunitiesListRequestExpand.Account,
-     *         remoteFields: "status",
-     *         showEnumOrigins: "status",
-     *         status: Merge.crm.OpportunitiesListRequestStatus.Lost
-     *     })
+     *     await merge.crm.opportunities.list({})
      */
     list(request?: Merge.crm.OpportunitiesListRequest, requestOptions?: Opportunities.RequestOptions): Promise<Merge.crm.PaginatedOpportunityList>;
     /**
@@ -35,13 +30,7 @@ export declare class Opportunities {
      *
      * @example
      *     await merge.crm.opportunities.create({
-     *         model: {
-     *             name: "Needs Integrations",
-     *             description: "Needs a Unified API for Integrations!",
-     *             amount: 100000,
-     *             lastActivityAt: new Date("2022-02-10T00:00:00.000Z"),
-     *             closeDate: new Date("2022-02-10T00:00:00.000Z")
-     *         }
+     *         model: {}
      *     })
      */
     create(request: Merge.crm.OpportunityEndpointRequest, requestOptions?: Opportunities.RequestOptions): Promise<Merge.crm.OpportunityResponse>;
@@ -49,11 +38,7 @@ export declare class Opportunities {
      * Returns an `Opportunity` object with the given `id`.
      *
      * @example
-     *     await merge.crm.opportunities.retrieve("id", {
-     *         expand: Merge.crm.OpportunitiesRetrieveRequestExpand.Account,
-     *         remoteFields: "status",
-     *         showEnumOrigins: "status"
-     *     })
+     *     await merge.crm.opportunities.retrieve("id", {})
      */
     retrieve(id: string, request?: Merge.crm.OpportunitiesRetrieveRequest, requestOptions?: Opportunities.RequestOptions): Promise<Merge.crm.Opportunity>;
     /**
@@ -61,16 +46,7 @@ export declare class Opportunities {
      *
      * @example
      *     await merge.crm.opportunities.partialUpdate("id", {
-     *         model: {
-     *             name: "Needs Integrations",
-     *             description: "Needs a Unified API for Integrations!",
-     *             amount: 100000,
-     *             owner: "0358cbc6-2040-430a-848e-aafacbadf3aa",
-     *             account: "0958cbc6-6040-430a-848e-aafacbadf4ae",
-     *             stage: "1968cbc6-6040-430a-848e-aafacbadf4ad",
-     *             lastActivityAt: new Date("2022-02-10T00:00:00.000Z"),
-     *             closeDate: new Date("2022-02-10T00:00:00.000Z")
-     *         }
+     *         model: {}
      *     })
      */
     partialUpdate(id: string, request: Merge.crm.PatchedOpportunityEndpointRequest, requestOptions?: Opportunities.RequestOptions): Promise<Merge.crm.OpportunityResponse>;

package/dist/api/resources/crm/resources/opportunities/client/Client.js

@@ -63,12 +63,7 @@ class Opportunities {
      * Returns a list of `Opportunity` objects.
      *
      * @example
-     *     await merge.crm.opportunities.list({
-     *         expand: Merge.crm.OpportunitiesListRequestExpand.Account,
-     *         remoteFields: "status",
-     *         showEnumOrigins: "status",
-     *         status: Merge.crm.OpportunitiesListRequestStatus.Lost
-     *     })
+     *     await merge.crm.opportunities.list({})
      */
     list(request = {}, requestOptions) {
         var _a;
@@ -127,7 +122,7 @@ class Opportunities {
                 _queryParams["status"] = status;
             }
             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, "api/crm/v1/opportunities"),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.MergeEnvironment.Production, "crm/v1/opportunities"),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
@@ -136,7 +131,7 @@ class Opportunities {
                         : 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.7",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -177,13 +172,7 @@ class Opportunities {
      *
      * @example
      *     await merge.crm.opportunities.create({
-     *         model: {
-     *             name: "Needs Integrations",
-     *             description: "Needs a Unified API for Integrations!",
-     *             amount: 100000,
-     *             lastActivityAt: new Date("2022-02-10T00:00:00.000Z"),
-     *             closeDate: new Date("2022-02-10T00:00:00.000Z")
-     *         }
+     *         model: {}
      *     })
      */
     create(request, requestOptions) {
@@ -198,7 +187,7 @@ class Opportunities {
                 _queryParams["run_async"] = runAsync.toString();
             }
             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, "api/crm/v1/opportunities"),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.MergeEnvironment.Production, "crm/v1/opportunities"),
                 method: "POST",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
@@ -207,7 +196,7 @@ class Opportunities {
                         : 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.7",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -250,11 +239,7 @@ class Opportunities {
      * Returns an `Opportunity` object with the given `id`.
      *
      * @example
-     *     await merge.crm.opportunities.retrieve("id", {
-     *         expand: Merge.crm.OpportunitiesRetrieveRequestExpand.Account,
-     *         remoteFields: "status",
-     *         showEnumOrigins: "status"
-     *     })
+     *     await merge.crm.opportunities.retrieve("id", {})
      */
     retrieve(id, request = {}, requestOptions) {
         var _a;
@@ -277,7 +262,7 @@ class Opportunities {
                 _queryParams["show_enum_origins"] = showEnumOrigins;
             }
             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, `api/crm/v1/opportunities/${id}`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.MergeEnvironment.Production, `crm/v1/opportunities/${id}`),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
@@ -286,7 +271,7 @@ class Opportunities {
                         : 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.7",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -327,16 +312,7 @@ class Opportunities {
      *
      * @example
      *     await merge.crm.opportunities.partialUpdate("id", {
-     *         model: {
-     *             name: "Needs Integrations",
-     *             description: "Needs a Unified API for Integrations!",
-     *             amount: 100000,
-     *             owner: "0358cbc6-2040-430a-848e-aafacbadf3aa",
-     *             account: "0958cbc6-6040-430a-848e-aafacbadf4ae",
-     *             stage: "1968cbc6-6040-430a-848e-aafacbadf4ad",
-     *             lastActivityAt: new Date("2022-02-10T00:00:00.000Z"),
-     *             closeDate: new Date("2022-02-10T00:00:00.000Z")
-     *         }
+     *         model: {}
      *     })
      */
     partialUpdate(id, request, requestOptions) {
@@ -351,7 +327,7 @@ class Opportunities {
                 _queryParams["run_async"] = runAsync.toString();
             }
             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, `api/crm/v1/opportunities/${id}`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.MergeEnvironment.Production, `crm/v1/opportunities/${id}`),
                 method: "PATCH",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
@@ -360,7 +336,7 @@ class Opportunities {
                         : 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.7",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,
@@ -409,7 +385,7 @@ class Opportunities {
         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, `api/crm/v1/opportunities/meta/patch/${id}`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.MergeEnvironment.Production, `crm/v1/opportunities/meta/patch/${id}`),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
@@ -418,7 +394,7 @@ class Opportunities {
                         : 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.7",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -463,7 +439,7 @@ class Opportunities {
         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, "api/crm/v1/opportunities/meta/post"),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.MergeEnvironment.Production, "crm/v1/opportunities/meta/post"),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
@@ -472,7 +448,7 @@ class Opportunities {
                         : 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.7",
                 },
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -534,7 +510,7 @@ class Opportunities {
                 _queryParams["page_size"] = pageSize.toString();
             }
             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, "api/crm/v1/opportunities/remote-field-classes"),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.MergeEnvironment.Production, "crm/v1/opportunities/remote-field-classes"),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
@@ -543,7 +519,7 @@ class Opportunities {
                         : 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.7",
                 },
                 contentType: "application/json",
                 queryParameters: _queryParams,

package/dist/api/resources/crm/resources/opportunities/client/requests/OpportunitiesListRequest.d.ts

@@ -4,12 +4,7 @@
 import * as Merge from "../../../../../..";
 /**
  * @example
- *     {
- *         expand: Merge.crm.OpportunitiesListRequestExpand.Account,
- *         remoteFields: "status",
- *         showEnumOrigins: "status",
- *         status: Merge.crm.OpportunitiesListRequestStatus.Lost
- *     }
+ *     {}
  */
 export interface OpportunitiesListRequest {
     /**
@@ -69,7 +64,7 @@ export interface OpportunitiesListRequest {
      */
     remoteId?: string;
     /**
-     * Which fields should be returned in non-normalized form.
+     * A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
      */
     showEnumOrigins?: "status";
     /**

package/dist/api/resources/crm/resources/opportunities/client/requests/OpportunitiesRetrieveRequest.d.ts

@@ -4,11 +4,7 @@
 import * as Merge from "../../../../../..";
 /**
  * @example
- *     {
- *         expand: Merge.crm.OpportunitiesRetrieveRequestExpand.Account,
- *         remoteFields: "status",
- *         showEnumOrigins: "status"
- *     }
+ *     {}
  */
 export interface OpportunitiesRetrieveRequest {
     /**
@@ -28,7 +24,7 @@ export interface OpportunitiesRetrieveRequest {
      */
     remoteFields?: "status";
     /**
-     * Which fields should be returned in non-normalized form.
+     * A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
      */
     showEnumOrigins?: "status";
 }

package/dist/api/resources/crm/resources/opportunities/client/requests/OpportunityEndpointRequest.d.ts

@@ -5,13 +5,7 @@ import * as Merge from "../../../../../..";
 /**
  * @example
  *     {
- *         model: {
- *             name: "Needs Integrations",
- *             description: "Needs a Unified API for Integrations!",
- *             amount: 100000,
- *             lastActivityAt: new Date("2022-02-10T00:00:00.000Z"),
- *             closeDate: new Date("2022-02-10T00:00:00.000Z")
- *         }
+ *         model: {}
  *     }
  */
 export interface OpportunityEndpointRequest {

package/dist/api/resources/crm/resources/opportunities/client/requests/PatchedOpportunityEndpointRequest.d.ts

@@ -5,16 +5,7 @@ import * as Merge from "../../../../../..";
 /**
  * @example
  *     {
- *         model: {
- *             name: "Needs Integrations",
- *             description: "Needs a Unified API for Integrations!",
- *             amount: 100000,
- *             owner: "0358cbc6-2040-430a-848e-aafacbadf3aa",
- *             account: "0958cbc6-6040-430a-848e-aafacbadf4ae",
- *             stage: "1968cbc6-6040-430a-848e-aafacbadf4ad",
- *             lastActivityAt: new Date("2022-02-10T00:00:00.000Z"),
- *             closeDate: new Date("2022-02-10T00:00:00.000Z")
- *         }
+ *         model: {}
  *     }
  */
 export interface PatchedOpportunityEndpointRequest {

package/dist/api/resources/crm/resources/passthrough/client/Client.d.ts

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

package/dist/api/resources/crm/resources/passthrough/client/Client.js

@@ -50,12 +50,18 @@ class Passthrough {
     }
     /**
      * Pull data from an endpoint not currently supported by Merge.
+     *
+     * @example
+     *     await merge.crm.passthrough.create({
+     *         method: Merge.crm.MethodEnum.Get,
+     *         path: "/scooters"
+     *     })
      */
     create(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, "api/crm/v1/passthrough"),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.MergeEnvironment.Production, "crm/v1/passthrough"),
                 method: "POST",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
@@ -64,7 +70,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.7",
                 },
                 contentType: "application/json",
                 body: yield serializers.crm.DataPassthroughRequest.jsonOrThrow(request, {

package/dist/api/resources/crm/resources/regenerateKey/client/Client.js

@@ -60,7 +60,7 @@ class RegenerateKey {
         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, "api/crm/v1/regenerate-key"),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.MergeEnvironment.Production, "crm/v1/regenerate-key"),
                 method: "POST",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
@@ -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.7",
                 },
                 contentType: "application/json",
                 body: yield serializers.crm.RemoteKeyForRegenerationRequest.jsonOrThrow(request, {

package/dist/api/resources/crm/resources/regenerateKey/client/requests/RemoteKeyForRegenerationRequest.d.ts

@@ -8,5 +8,6 @@
  *     }
  */
 export interface RemoteKeyForRegenerationRequest {
+    /** The name of the remote key */
     name: string;
 }

package/dist/api/resources/crm/resources/scopes/client/Client.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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.crm.scopes.defaultScopesRetrieve()
+     */
+    defaultScopesRetrieve(requestOptions?: Scopes.RequestOptions): Promise<Merge.crm.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.crm.scopes.linkedAccountScopesRetrieve()
+     */
+    linkedAccountScopesRetrieve(requestOptions?: Scopes.RequestOptions): Promise<Merge.crm.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.crm.scopes.linkedAccountScopesCreate({
+     *         commonModels: [{
+     *                 modelName: "model_name"
+     *             }]
+     *     })
+     */
+    linkedAccountScopesCreate(request: Merge.crm.LinkedAccountCommonModelScopeDeserializerRequest, requestOptions?: Scopes.RequestOptions): Promise<Merge.crm.CommonModelScopeApi>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}