@mergeapi/merge-node-client 1.0.5 → 1.0.6

package/api/resources/accounting/resources/availableActions/client/Client.js

@@ -50,6 +50,9 @@ class AvailableActions {
     }
     /**
      * Returns a list of models and actions available for an account.
+     *
+     * @example
+     *     await merge.accounting.availableActions.retrieve()
      */
     retrieve(requestOptions) {
         var _a;
@@ -64,7 +67,7 @@ class AvailableActions {
                         : 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/accounting/resources/balanceSheets/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class BalanceSheets {
      * Returns a `BalanceSheet` object with the given `id`.
      *
      * @example
-     *     await merge.accounting.balanceSheets.retrieve("id", {
+     *     await merge.accounting.balanceSheets.retrieve("string", {
      *         expand: "company"
      *     })
      */

package/api/resources/accounting/resources/balanceSheets/client/Client.js

@@ -104,7 +104,7 @@ class BalanceSheets {
                         : 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,
@@ -144,7 +144,7 @@ class BalanceSheets {
      * Returns a `BalanceSheet` object with the given `id`.
      *
      * @example
-     *     await merge.accounting.balanceSheets.retrieve("id", {
+     *     await merge.accounting.balanceSheets.retrieve("string", {
      *         expand: "company"
      *     })
      */
@@ -169,7 +169,7 @@ class BalanceSheets {
                         : 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/accounting/resources/cashFlowStatements/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class CashFlowStatements {
      * Returns a `CashFlowStatement` object with the given `id`.
      *
      * @example
-     *     await merge.accounting.cashFlowStatements.retrieve("id", {
+     *     await merge.accounting.cashFlowStatements.retrieve("string", {
      *         expand: "company"
      *     })
      */

package/api/resources/accounting/resources/cashFlowStatements/client/Client.js

@@ -104,7 +104,7 @@ class CashFlowStatements {
                         : 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,
@@ -144,7 +144,7 @@ class CashFlowStatements {
      * Returns a `CashFlowStatement` object with the given `id`.
      *
      * @example
-     *     await merge.accounting.cashFlowStatements.retrieve("id", {
+     *     await merge.accounting.cashFlowStatements.retrieve("string", {
      *         expand: "company"
      *     })
      */
@@ -169,7 +169,7 @@ class CashFlowStatements {
                         : 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/accounting/resources/companyInfo/client/Client.d.ts

@@ -31,7 +31,7 @@ export declare class CompanyInfo {
      * Returns a `CompanyInfo` object with the given `id`.
      *
      * @example
-     *     await merge.accounting.companyInfo.retrieve("id", {
+     *     await merge.accounting.companyInfo.retrieve("string", {
      *         expand: Merge.accounting.CompanyInfoRetrieveRequestExpand.Addresses
      *     })
      */

package/api/resources/accounting/resources/companyInfo/client/Client.js

@@ -101,7 +101,7 @@ class CompanyInfo {
                         : 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,
@@ -141,7 +141,7 @@ class CompanyInfo {
      * Returns a `CompanyInfo` object with the given `id`.
      *
      * @example
-     *     await merge.accounting.companyInfo.retrieve("id", {
+     *     await merge.accounting.companyInfo.retrieve("string", {
      *         expand: Merge.accounting.CompanyInfoRetrieveRequestExpand.Addresses
      *     })
      */
@@ -166,7 +166,7 @@ class CompanyInfo {
                         : 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/accounting/resources/contacts/client/Client.d.ts

@@ -39,12 +39,9 @@ export declare class Contacts {
      *             isCustomer: true,
      *             emailAddress: "pickleball@merge.dev",
      *             taxNumber: "12-3456789",
+     *             status: undefined,
      *             currency: "USD",
-     *             company: "595c8f97-2ac4-45b7-b000-41bdf43240b5",
-     *             phoneNumbers: [{
-     *                     number: "+3198675309",
-     *                     type: "Mobile"
-     *                 }]
+     *             company: "595c8f97-2ac4-45b7-b000-41bdf43240b5"
      *         }
      *     })
      */
@@ -53,7 +50,7 @@ export declare class Contacts {
      * Returns a `Contact` object with the given `id`.
      *
      * @example
-     *     await merge.accounting.contacts.retrieve("id", {
+     *     await merge.accounting.contacts.retrieve("string", {
      *         expand: Merge.accounting.ContactsRetrieveRequestExpand.Addresses,
      *         remoteFields: "status",
      *         showEnumOrigins: "status"

package/api/resources/accounting/resources/contacts/client/Client.js

@@ -129,7 +129,7 @@ class Contacts {
                         : 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,
@@ -175,12 +175,9 @@ class Contacts {
      *             isCustomer: true,
      *             emailAddress: "pickleball@merge.dev",
      *             taxNumber: "12-3456789",
+     *             status: undefined,
      *             currency: "USD",
-     *             company: "595c8f97-2ac4-45b7-b000-41bdf43240b5",
-     *             phoneNumbers: [{
-     *                     number: "+3198675309",
-     *                     type: "Mobile"
-     *                 }]
+     *             company: "595c8f97-2ac4-45b7-b000-41bdf43240b5"
      *         }
      *     })
      */
@@ -205,7 +202,7 @@ class Contacts {
                         : 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,
@@ -248,7 +245,7 @@ class Contacts {
      * Returns a `Contact` object with the given `id`.
      *
      * @example
-     *     await merge.accounting.contacts.retrieve("id", {
+     *     await merge.accounting.contacts.retrieve("string", {
      *         expand: Merge.accounting.ContactsRetrieveRequestExpand.Addresses,
      *         remoteFields: "status",
      *         showEnumOrigins: "status"
@@ -281,7 +278,7 @@ class Contacts {
                         : 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,
@@ -336,7 +333,7 @@ class Contacts {
                         : 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/accounting/resources/contacts/client/requests/ContactEndpointRequest.d.ts

@@ -10,12 +10,9 @@ import * as Merge from "../../../../../..";
  *             isCustomer: true,
  *             emailAddress: "pickleball@merge.dev",
  *             taxNumber: "12-3456789",
+ *             status: undefined,
  *             currency: "USD",
- *             company: "595c8f97-2ac4-45b7-b000-41bdf43240b5",
- *             phoneNumbers: [{
- *                     number: "+3198675309",
- *                     type: "Mobile"
- *                 }]
+ *             company: "595c8f97-2ac4-45b7-b000-41bdf43240b5"
  *         }
  *     }
  */

package/api/resources/accounting/resources/creditNotes/client/Client.d.ts

@@ -33,7 +33,7 @@ export declare class CreditNotes {
      * Returns a `CreditNote` object with the given `id`.
      *
      * @example
-     *     await merge.accounting.creditNotes.retrieve("id", {
+     *     await merge.accounting.creditNotes.retrieve("string", {
      *         expand: Merge.accounting.CreditNotesRetrieveRequestExpand.AccountingPeriod,
      *         remoteFields: Merge.accounting.CreditNotesRetrieveRequestRemoteFields.Status,
      *         showEnumOrigins: Merge.accounting.CreditNotesRetrieveRequestShowEnumOrigins.Status

package/api/resources/accounting/resources/creditNotes/client/Client.js

@@ -118,7 +118,7 @@ class CreditNotes {
                         : 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,
@@ -158,7 +158,7 @@ class CreditNotes {
      * Returns a `CreditNote` object with the given `id`.
      *
      * @example
-     *     await merge.accounting.creditNotes.retrieve("id", {
+     *     await merge.accounting.creditNotes.retrieve("string", {
      *         expand: Merge.accounting.CreditNotesRetrieveRequestExpand.AccountingPeriod,
      *         remoteFields: Merge.accounting.CreditNotesRetrieveRequestRemoteFields.Status,
      *         showEnumOrigins: Merge.accounting.CreditNotesRetrieveRequestShowEnumOrigins.Status
@@ -191,7 +191,7 @@ class CreditNotes {
                         : 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/accounting/resources/deleteAccount/client/Client.js

@@ -66,7 +66,7 @@ class DeleteAccount {
                         : 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/accounting/resources/expenses/client/Client.d.ts

@@ -34,15 +34,9 @@ export declare class Expenses {
      *     await merge.accounting.expenses.create({
      *         model: {
      *             totalAmount: 10000,
+     *             currency: undefined,
      *             exchangeRate: "2.9",
-     *             memo: "New employee supplies",
-     *             lines: [{
-     *                     remoteId: "121222",
-     *                     netAmount: 25.54,
-     *                     company: "595c8f97-2ac4-45b7-b000-41bdf43240b5",
-     *                     description: "MacBook Pro",
-     *                     exchangeRate: "2.9"
-     *                 }]
+     *             memo: "New employee supplies"
      *         }
      *     })
      */
@@ -51,7 +45,7 @@ export declare class Expenses {
      * Returns an `Expense` object with the given `id`.
      *
      * @example
-     *     await merge.accounting.expenses.retrieve("id", {
+     *     await merge.accounting.expenses.retrieve("string", {
      *         expand: Merge.accounting.ExpensesRetrieveRequestExpand.Account
      *     })
      */

package/api/resources/accounting/resources/expenses/client/Client.js

@@ -121,7 +121,7 @@ class Expenses {
                         : 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,
@@ -164,15 +164,9 @@ class Expenses {
      *     await merge.accounting.expenses.create({
      *         model: {
      *             totalAmount: 10000,
+     *             currency: undefined,
      *             exchangeRate: "2.9",
-     *             memo: "New employee supplies",
-     *             lines: [{
-     *                     remoteId: "121222",
-     *                     netAmount: 25.54,
-     *                     company: "595c8f97-2ac4-45b7-b000-41bdf43240b5",
-     *                     description: "MacBook Pro",
-     *                     exchangeRate: "2.9"
-     *                 }]
+     *             memo: "New employee supplies"
      *         }
      *     })
      */
@@ -197,7 +191,7 @@ class Expenses {
                         : 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,
@@ -240,7 +234,7 @@ class Expenses {
      * Returns an `Expense` object with the given `id`.
      *
      * @example
-     *     await merge.accounting.expenses.retrieve("id", {
+     *     await merge.accounting.expenses.retrieve("string", {
      *         expand: Merge.accounting.ExpensesRetrieveRequestExpand.Account
      *     })
      */
@@ -265,7 +259,7 @@ class Expenses {
                         : 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,
@@ -320,7 +314,7 @@ class Expenses {
                         : 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/accounting/resources/expenses/client/requests/ExpenseEndpointRequest.d.ts

@@ -7,15 +7,9 @@ import * as Merge from "../../../../../..";
  *     {
  *         model: {
  *             totalAmount: 10000,
+ *             currency: undefined,
  *             exchangeRate: "2.9",
- *             memo: "New employee supplies",
- *             lines: [{
- *                     remoteId: "121222",
- *                     netAmount: 25.54,
- *                     company: "595c8f97-2ac4-45b7-b000-41bdf43240b5",
- *                     description: "MacBook Pro",
- *                     exchangeRate: "2.9"
- *                 }]
+ *             memo: "New employee supplies"
  *         }
  *     }
  */

package/api/resources/accounting/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.accounting.fieldMapping.fieldMappingsRetrieve()
+     */
+    fieldMappingsRetrieve(requestOptions?: FieldMapping.RequestOptions): Promise<Merge.accounting.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.accounting.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.accounting.CreateFieldMappingRequest, requestOptions?: FieldMapping.RequestOptions): Promise<Merge.accounting.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.accounting.fieldMapping.fieldMappingsDestroy("string")
+     */
+    fieldMappingsDestroy(fieldMappingId: string, requestOptions?: FieldMapping.RequestOptions): Promise<Merge.accounting.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.accounting.fieldMapping.fieldMappingsPartialUpdate("string", {
+     *         remoteMethod: "GET",
+     *         remoteUrlPath: "/example-url-path"
+     *     })
+     */
+    fieldMappingsPartialUpdate(fieldMappingId: string, request?: Merge.accounting.PatchedEditFieldMappingRequest, requestOptions?: FieldMapping.RequestOptions): Promise<Merge.accounting.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.accounting.fieldMapping.remoteFieldsRetrieve({})
+     */
+    remoteFieldsRetrieve(request?: Merge.accounting.RemoteFieldsRetrieveRequest, requestOptions?: FieldMapping.RequestOptions): Promise<Merge.accounting.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.accounting.fieldMapping.targetFieldsRetrieve()
+     */
+    targetFieldsRetrieve(requestOptions?: FieldMapping.RequestOptions): Promise<Merge.accounting.ExternalTargetFieldApiResponse>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}