@mergeapi/merge-node-client 2.1.3 → 2.2.0

package/.mock/definition/accounting/__package__.yml

@@ -41304,6 +41304,83 @@ types:
       results: optional<list<VendorCredit>>
     source:
       openapi: openapi/openapi.yml
+  PatchedContactRequestAddressesItem:
+    discriminated: false
+    union:
+      - type: string
+        validation:
+          format: uuid
+      - Address
+    source:
+      openapi: openapi/openapi.yml
+    inline: true
+  PatchedContactRequest:
+    docs: >-
+      # The Contact Object
+
+      ### Description
+
+      A `Contact` is an individual or business entity to which products and
+      services are sold to or purchased from. The `Contact` model contains both
+      Customers, in which products and services are sold to, and Vendors (or
+      Suppliers), in which products and services are purchased from.
+
+      * A `Contact` is a Vendor/Supplier if the `is_supplier` property is true.
+
+      * A `Contact` is a customer if the `is_customer` property is true.
+
+
+      ### Usage Example
+
+      Fetch from the `LIST Contacts` endpoint and view a company's contacts.
+    properties:
+      name:
+        type: optional<string>
+        docs: The contact's name.
+      is_supplier:
+        type: optional<boolean>
+        docs: Whether the contact is a supplier.
+      is_customer:
+        type: optional<boolean>
+        docs: Whether the contact is a customer.
+      email_address:
+        type: optional<string>
+        docs: The contact's email address.
+      tax_number:
+        type: optional<string>
+        docs: The contact's tax number.
+      status:
+        type: optional<string>
+        docs: |-
+          The contact's status
+
+          * `ACTIVE` - ACTIVE
+          * `ARCHIVED` - ARCHIVED
+      currency:
+        type: optional<string>
+        docs: The currency the contact's transactions are in.
+      company:
+        type: optional<string>
+        docs: The company the contact belongs to.
+        validation:
+          format: uuid
+      addresses:
+        type: optional<list<optional<PatchedContactRequestAddressesItem>>>
+        docs: '`Address` object IDs for the given `Contacts` object.'
+      phone_numbers:
+        type: optional<list<AccountingPhoneNumberRequest>>
+        docs: '`AccountingPhoneNumber` object for the given `Contacts` object.'
+      integration_params:
+        type: optional<map<string, unknown>>
+        access: write-only
+      linked_account_params:
+        type: optional<map<string, unknown>>
+        access: write-only
+      remote_fields:
+        type: optional<list<RemoteFieldRequest>>
+        access: write-only
+    source:
+      openapi: openapi/openapi.yml
   PatchedItemRequestRequestStatus:
     discriminated: false
     docs: |-

package/.mock/definition/accounting/contacts.yml

@@ -354,6 +354,286 @@ service:
                 - remote_field_class: remote_field_class
                   value:
                     key: value
+    partialUpdate:
+      path: /accounting/v1/contacts/{id}
+      method: PATCH
+      auth: true
+      docs: Updates a `Contact` object with the given `id`.
+      source:
+        openapi: openapi/openapi.yml
+      path-parameters:
+        id: string
+      request:
+        name: PatchedContactEndpointRequest
+        query-parameters:
+          is_debug_mode:
+            type: optional<boolean>
+            docs: >-
+              Whether to include debug fields (such as log file links) in the
+              response.
+          run_async:
+            type: optional<boolean>
+            docs: Whether or not third-party updates should be run asynchronously.
+        body:
+          properties:
+            model: root.PatchedContactRequest
+        content-type: application/json
+      response:
+        docs: ''
+        type: root.ContactResponse
+        status-code: 200
+      examples:
+        - path-parameters:
+            id: id
+          headers:
+            X-Account-Token: X-Account-Token
+          request:
+            model: {}
+          response:
+            body:
+              model:
+                id: c640b80b-fac9-409f-aa19-1f9221aec445
+                remote_id: '11167'
+                created_at: '2021-09-15T00:00:00Z'
+                modified_at: '2021-10-16T00:00:00Z'
+                name: Gil Feig's pickleball store
+                is_supplier: true
+                is_customer: true
+                email_address: pickleball@merge.dev
+                tax_number: 12-3456789
+                status: ACTIVE
+                currency: USD
+                remote_updated_at: '2020-03-31T00:00:00Z'
+                company: 595c8f97-2ac4-45b7-b000-41bdf43240b5
+                addresses:
+                  - 2f2702aa-8948-492b-a412-2acdf6d2c499
+                  - d98c7428-8dda-48a8-a1da-c570f65e2375
+                phone_numbers:
+                  - created_at: '2021-09-15T00:00:00Z'
+                    modified_at: '2021-10-16T00:00:00Z'
+                    number: '+3198675309'
+                    type: Mobile
+                remote_was_deleted: true
+                field_mappings:
+                  organization_defined_targets:
+                    custom_key: custom_value
+                  linked_account_defined_targets:
+                    custom_key: custom_value
+                remote_data:
+                  - path: /actions
+                    data:
+                      - Varies by platform
+                remote_fields:
+                  - remote_field_class: remote_field_class
+              warnings:
+                - source:
+                    pointer: pointer
+                  title: Unrecognized Field
+                  detail: An unrecognized field, age, was passed in with request data.
+                  problem_type: UNRECOGNIZED_FIELD
+              errors:
+                - source:
+                    pointer: pointer
+                  title: Missing Required Field
+                  detail: custom_fields is a required field on model.
+                  problem_type: MISSING_REQUIRED_FIELD
+              logs:
+                - log_id: 99433219-8017-4acd-bb3c-ceb23d663832
+                  dashboard_view: >-
+                    https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832
+                  log_summary:
+                    url: www.exampleintegration.com/api/v1/exampleapi
+                    method: POST
+                    status_code: 200
+    metaPatchRetrieve:
+      path: /accounting/v1/contacts/meta/patch/{id}
+      method: GET
+      auth: true
+      docs: Returns metadata for `Contact` PATCHs.
+      source:
+        openapi: openapi/openapi.yml
+      path-parameters:
+        id: string
+      response:
+        docs: ''
+        type: root.MetaResponse
+        status-code: 200
+      examples:
+        - path-parameters:
+            id: id
+          headers:
+            X-Account-Token: X-Account-Token
+          response:
+            body:
+              request_schema:
+                type: object
+                properties:
+                  model:
+                    type: object
+                    required:
+                      - last_name
+                      - first_name
+                      - merge_categories
+                      - new_york_city_neighborhood
+                      - favorite_tv_shows
+                      - favorite_watch
+                    properties:
+                      email_addresses:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            value:
+                              type: string
+                              title: value
+                            email_address_type:
+                              type: string
+                              title: email_address_type
+                            integration_params:
+                              type: object
+                              title: integration_params
+                              properties: {}
+                            linked_account_params:
+                              type: object
+                              title: linked_account_params
+                              properties: {}
+                        title: email_addresses
+                        description: Array of email_addresses objects
+                      urls:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            value:
+                              type: string
+                              title: value
+                            url_type:
+                              type: string
+                              title: url_type
+                            integration_params:
+                              type: object
+                              title: integration_params
+                              properties: {}
+                            linked_account_params:
+                              type: object
+                              title: linked_account_params
+                              properties: {}
+                        title: urls
+                        description: Array of urls objects
+                      first_name:
+                        type: string
+                        title: first_name
+                        description: The first name.
+                      last_name:
+                        type: string
+                        title: last_name
+                        description: The last name.
+                      phone_numbers:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            value:
+                              type: string
+                              title: value
+                            phone_number_type:
+                              type: string
+                              title: phone_number_type
+                            integration_params:
+                              type: object
+                              title: integration_params
+                              properties: {}
+                            linked_account_params:
+                              type: object
+                              title: linked_account_params
+                              properties: {}
+                        title: phone_numbers
+                        description: Array of phone_numbers objects
+                      tags:
+                        type: array
+                        items:
+                          type: string
+                          format: uuid
+                        title: tags
+                        description: Array of tags names
+                      attachments:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            id:
+                              type: string
+                              title: id
+                            file_url:
+                              type: string
+                              title: file_url
+                            file_name:
+                              type: string
+                              title: file_name
+                            attachment_type:
+                              type: string
+                              title: attachment_type
+                            integration_params:
+                              type: object
+                              title: integration_params
+                              properties: {}
+                            linked_account_params:
+                              type: object
+                              title: linked_account_params
+                              properties: {}
+                        title: attachments
+                        description: 'Array of attachments objects '
+                      merge_categories:
+                        type: array
+                        categories:
+                          type: string
+                          enum:
+                            - HRIS
+                            - ATS
+                            - Accounting
+                            - Ticketing
+                            - File Storage
+                            - CRM
+                            - Marketing Automation
+                          enum_information:
+                            - value: HRIS
+                              description: Merge HRIS Category
+                            - value: ATS
+                              description: Merge ATS Category
+                            - value: Accounting
+                              description: Merge Accounting Category
+                            - value: Ticketing
+                              description: Merge Ticketing Category
+                            - value: File Storage
+                              description: Merge File Storage Category
+                            - value: CRM
+                              description: Merge CRM Category
+                            - value: Marketing Automation
+                              description: Merge Marketing Automation Category
+                        title: Merge Categories
+                        description: Array of Merge's Unified API Categories
+                      new_york_city_neighborhood:
+                        type: string
+                        title: Borough
+                        description: One of the 5 Boroughs of New York City
+                      favorite_tv_shows:
+                        type: array
+                        items:
+                          type: string
+                          format: uuid
+                        title: Favorite TV Shows
+                        description: Array of TV Show objects on merge.tv_shows
+                      favorite_watch:
+                        type: string
+                        title: Favorite Watch
+                        description: Favorite watch of all time
+              remote_field_classes:
+                key: value
+              status:
+                linked_account_status: linked_account_status
+                can_make_request: true
+              has_conditional_params: true
+              has_required_linked_account_params: true
     metaPostRetrieve:
       path: /accounting/v1/contacts/meta/post
       method: GET

package/.mock/definition/accounting/transactions.yml

@@ -4,60 +4,124 @@ types:
       - account
       - value: account,accounting_period
         name: AccountAccountingPeriod
+      - value: account,company
+        name: AccountCompany
+      - value: account,company,accounting_period
+        name: AccountCompanyAccountingPeriod
       - accounting_period
+      - company
+      - value: company,accounting_period
+        name: CompanyAccountingPeriod
       - contact
       - value: contact,account
         name: ContactAccount
       - value: contact,account,accounting_period
         name: ContactAccountAccountingPeriod
+      - value: contact,account,company
+        name: ContactAccountCompany
+      - value: contact,account,company,accounting_period
+        name: ContactAccountCompanyAccountingPeriod
       - value: contact,accounting_period
         name: ContactAccountingPeriod
+      - value: contact,company
+        name: ContactCompany
+      - value: contact,company,accounting_period
+        name: ContactCompanyAccountingPeriod
       - line_items
       - value: line_items,account
         name: LineItemsAccount
       - value: line_items,account,accounting_period
         name: LineItemsAccountAccountingPeriod
+      - value: line_items,account,company
+        name: LineItemsAccountCompany
+      - value: line_items,account,company,accounting_period
+        name: LineItemsAccountCompanyAccountingPeriod
       - value: line_items,accounting_period
         name: LineItemsAccountingPeriod
+      - value: line_items,company
+        name: LineItemsCompany
+      - value: line_items,company,accounting_period
+        name: LineItemsCompanyAccountingPeriod
       - value: line_items,contact
         name: LineItemsContact
       - value: line_items,contact,account
         name: LineItemsContactAccount
       - value: line_items,contact,account,accounting_period
         name: LineItemsContactAccountAccountingPeriod
+      - value: line_items,contact,account,company
+        name: LineItemsContactAccountCompany
+      - value: line_items,contact,account,company,accounting_period
+        name: LineItemsContactAccountCompanyAccountingPeriod
       - value: line_items,contact,accounting_period
         name: LineItemsContactAccountingPeriod
+      - value: line_items,contact,company
+        name: LineItemsContactCompany
+      - value: line_items,contact,company,accounting_period
+        name: LineItemsContactCompanyAccountingPeriod
       - value: line_items,tracking_categories
         name: LineItemsTrackingCategories
       - value: line_items,tracking_categories,account
         name: LineItemsTrackingCategoriesAccount
       - value: line_items,tracking_categories,account,accounting_period
         name: LineItemsTrackingCategoriesAccountAccountingPeriod
+      - value: line_items,tracking_categories,account,company
+        name: LineItemsTrackingCategoriesAccountCompany
+      - value: line_items,tracking_categories,account,company,accounting_period
+        name: LineItemsTrackingCategoriesAccountCompanyAccountingPeriod
       - value: line_items,tracking_categories,accounting_period
         name: LineItemsTrackingCategoriesAccountingPeriod
+      - value: line_items,tracking_categories,company
+        name: LineItemsTrackingCategoriesCompany
+      - value: line_items,tracking_categories,company,accounting_period
+        name: LineItemsTrackingCategoriesCompanyAccountingPeriod
       - value: line_items,tracking_categories,contact
         name: LineItemsTrackingCategoriesContact
       - value: line_items,tracking_categories,contact,account
         name: LineItemsTrackingCategoriesContactAccount
       - value: line_items,tracking_categories,contact,account,accounting_period
         name: LineItemsTrackingCategoriesContactAccountAccountingPeriod
+      - value: line_items,tracking_categories,contact,account,company
+        name: LineItemsTrackingCategoriesContactAccountCompany
+      - value: >-
+          line_items,tracking_categories,contact,account,company,accounting_period
+        name: LineItemsTrackingCategoriesContactAccountCompanyAccountingPeriod
       - value: line_items,tracking_categories,contact,accounting_period
         name: LineItemsTrackingCategoriesContactAccountingPeriod
+      - value: line_items,tracking_categories,contact,company
+        name: LineItemsTrackingCategoriesContactCompany
+      - value: line_items,tracking_categories,contact,company,accounting_period
+        name: LineItemsTrackingCategoriesContactCompanyAccountingPeriod
       - tracking_categories
       - value: tracking_categories,account
         name: TrackingCategoriesAccount
       - value: tracking_categories,account,accounting_period
         name: TrackingCategoriesAccountAccountingPeriod
+      - value: tracking_categories,account,company
+        name: TrackingCategoriesAccountCompany
+      - value: tracking_categories,account,company,accounting_period
+        name: TrackingCategoriesAccountCompanyAccountingPeriod
       - value: tracking_categories,accounting_period
         name: TrackingCategoriesAccountingPeriod
+      - value: tracking_categories,company
+        name: TrackingCategoriesCompany
+      - value: tracking_categories,company,accounting_period
+        name: TrackingCategoriesCompanyAccountingPeriod
       - value: tracking_categories,contact
         name: TrackingCategoriesContact
       - value: tracking_categories,contact,account
         name: TrackingCategoriesContactAccount
       - value: tracking_categories,contact,account,accounting_period
         name: TrackingCategoriesContactAccountAccountingPeriod
+      - value: tracking_categories,contact,account,company
+        name: TrackingCategoriesContactAccountCompany
+      - value: tracking_categories,contact,account,company,accounting_period
+        name: TrackingCategoriesContactAccountCompanyAccountingPeriod
       - value: tracking_categories,contact,accounting_period
         name: TrackingCategoriesContactAccountingPeriod
+      - value: tracking_categories,contact,company
+        name: TrackingCategoriesContactCompany
+      - value: tracking_categories,contact,company,accounting_period
+        name: TrackingCategoriesContactCompanyAccountingPeriod
     source:
       openapi: openapi/openapi.yml
   TransactionsRetrieveRequestExpand:
@@ -65,60 +129,124 @@ types:
       - account
       - value: account,accounting_period
         name: AccountAccountingPeriod
+      - value: account,company
+        name: AccountCompany
+      - value: account,company,accounting_period
+        name: AccountCompanyAccountingPeriod
       - accounting_period
+      - company
+      - value: company,accounting_period
+        name: CompanyAccountingPeriod
       - contact
       - value: contact,account
         name: ContactAccount
       - value: contact,account,accounting_period
         name: ContactAccountAccountingPeriod
+      - value: contact,account,company
+        name: ContactAccountCompany
+      - value: contact,account,company,accounting_period
+        name: ContactAccountCompanyAccountingPeriod
       - value: contact,accounting_period
         name: ContactAccountingPeriod
+      - value: contact,company
+        name: ContactCompany
+      - value: contact,company,accounting_period
+        name: ContactCompanyAccountingPeriod
       - line_items
       - value: line_items,account
         name: LineItemsAccount
       - value: line_items,account,accounting_period
         name: LineItemsAccountAccountingPeriod
+      - value: line_items,account,company
+        name: LineItemsAccountCompany
+      - value: line_items,account,company,accounting_period
+        name: LineItemsAccountCompanyAccountingPeriod
       - value: line_items,accounting_period
         name: LineItemsAccountingPeriod
+      - value: line_items,company
+        name: LineItemsCompany
+      - value: line_items,company,accounting_period
+        name: LineItemsCompanyAccountingPeriod
       - value: line_items,contact
         name: LineItemsContact
       - value: line_items,contact,account
         name: LineItemsContactAccount
       - value: line_items,contact,account,accounting_period
         name: LineItemsContactAccountAccountingPeriod
+      - value: line_items,contact,account,company
+        name: LineItemsContactAccountCompany
+      - value: line_items,contact,account,company,accounting_period
+        name: LineItemsContactAccountCompanyAccountingPeriod
       - value: line_items,contact,accounting_period
         name: LineItemsContactAccountingPeriod
+      - value: line_items,contact,company
+        name: LineItemsContactCompany
+      - value: line_items,contact,company,accounting_period
+        name: LineItemsContactCompanyAccountingPeriod
       - value: line_items,tracking_categories
         name: LineItemsTrackingCategories
       - value: line_items,tracking_categories,account
         name: LineItemsTrackingCategoriesAccount
       - value: line_items,tracking_categories,account,accounting_period
         name: LineItemsTrackingCategoriesAccountAccountingPeriod
+      - value: line_items,tracking_categories,account,company
+        name: LineItemsTrackingCategoriesAccountCompany
+      - value: line_items,tracking_categories,account,company,accounting_period
+        name: LineItemsTrackingCategoriesAccountCompanyAccountingPeriod
       - value: line_items,tracking_categories,accounting_period
         name: LineItemsTrackingCategoriesAccountingPeriod
+      - value: line_items,tracking_categories,company
+        name: LineItemsTrackingCategoriesCompany
+      - value: line_items,tracking_categories,company,accounting_period
+        name: LineItemsTrackingCategoriesCompanyAccountingPeriod
       - value: line_items,tracking_categories,contact
         name: LineItemsTrackingCategoriesContact
       - value: line_items,tracking_categories,contact,account
         name: LineItemsTrackingCategoriesContactAccount
       - value: line_items,tracking_categories,contact,account,accounting_period
         name: LineItemsTrackingCategoriesContactAccountAccountingPeriod
+      - value: line_items,tracking_categories,contact,account,company
+        name: LineItemsTrackingCategoriesContactAccountCompany
+      - value: >-
+          line_items,tracking_categories,contact,account,company,accounting_period
+        name: LineItemsTrackingCategoriesContactAccountCompanyAccountingPeriod
       - value: line_items,tracking_categories,contact,accounting_period
         name: LineItemsTrackingCategoriesContactAccountingPeriod
+      - value: line_items,tracking_categories,contact,company
+        name: LineItemsTrackingCategoriesContactCompany
+      - value: line_items,tracking_categories,contact,company,accounting_period
+        name: LineItemsTrackingCategoriesContactCompanyAccountingPeriod
       - tracking_categories
       - value: tracking_categories,account
         name: TrackingCategoriesAccount
       - value: tracking_categories,account,accounting_period
         name: TrackingCategoriesAccountAccountingPeriod
+      - value: tracking_categories,account,company
+        name: TrackingCategoriesAccountCompany
+      - value: tracking_categories,account,company,accounting_period
+        name: TrackingCategoriesAccountCompanyAccountingPeriod
       - value: tracking_categories,accounting_period
         name: TrackingCategoriesAccountingPeriod
+      - value: tracking_categories,company
+        name: TrackingCategoriesCompany
+      - value: tracking_categories,company,accounting_period
+        name: TrackingCategoriesCompanyAccountingPeriod
       - value: tracking_categories,contact
         name: TrackingCategoriesContact
       - value: tracking_categories,contact,account
         name: TrackingCategoriesContactAccount
       - value: tracking_categories,contact,account,accounting_period
         name: TrackingCategoriesContactAccountAccountingPeriod
+      - value: tracking_categories,contact,account,company
+        name: TrackingCategoriesContactAccountCompany
+      - value: tracking_categories,contact,account,company,accounting_period
+        name: TrackingCategoriesContactAccountCompanyAccountingPeriod
       - value: tracking_categories,contact,accounting_period
         name: TrackingCategoriesContactAccountingPeriod
+      - value: tracking_categories,contact,company
+        name: TrackingCategoriesContactCompany
+      - value: tracking_categories,contact,company,accounting_period
+        name: TrackingCategoriesContactCompanyAccountingPeriod
     source:
       openapi: openapi/openapi.yml
 imports:

package/.mock/definition/ats/__package__.yml

@@ -1974,6 +1974,7 @@ types:
       - CREATED_TEST_API_KEY
       - DELETED_TEST_API_KEY
       - REGENERATED_PRODUCTION_API_KEY
+      - REGENERATED_WEBHOOK_SIGNATURE
       - INVITED_USER
       - TWO_FACTOR_AUTH_ENABLED
       - TWO_FACTOR_AUTH_DISABLED

package/.mock/definition/filestorage/files.yml

@@ -142,6 +142,16 @@ service:
           page_size:
             type: optional<integer>
             docs: Number of results to return per page.
+          remote_created_after:
+            type: optional<datetime>
+            docs: >-
+              If provided, will only return files created in the third party
+              platform after this datetime.
+          remote_created_before:
+            type: optional<datetime>
+            docs: >-
+              If provided, will only return files created in the third party
+              platform before this datetime.
           remote_id:
             type: optional<string>
             docs: The API provider's ID for the given object.
@@ -438,6 +448,12 @@ service:
           cursor:
             type: optional<string>
             docs: The pagination cursor value.
+          ids:
+            type: optional<string>
+            allow-multiple: true
+            docs: >-
+              If provided, will only return objects with the given IDs.
+              Comma-separated list of strings.
           include_deleted_data:
             type: optional<boolean>
             docs: >-

package/.mock/definition/hris/__package__.yml

@@ -689,6 +689,11 @@ types:
       end_date:
         type: optional<datetime>
         docs: The day and time the benefit ended.
+      employer_benefit:
+        type: optional<string>
+        docs: The employer benefit plan the employee is enrolled in.
+        validation:
+          format: uuid
       remote_was_deleted:
         type: optional<boolean>
         docs: >-
@@ -698,11 +703,6 @@ types:
           [Learn
           more](https://docs.merge.dev/integrations/hris/supported-features/).
         access: read-only
-      employer_benefit:
-        type: optional<string>
-        docs: The employer benefit plan the employee is enrolled in.
-        validation:
-          format: uuid
       field_mappings:
         type: optional<map<string, unknown>>
         access: read-only