merge_crm_client 1.0.0

data/lib/merge_crm_client/api/linked_accounts_api.rb

@@ -0,0 +1,120 @@
+=begin
+#Merge CRM API
+
+#The unified API for building rich integrations with multiple CRM platforms.
+
+The version of the OpenAPI document: 1.0
+Contact: hello@merge.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'cgi'
+
+module MergeCRMClient
+  class LinkedAccountsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List linked accounts for your organization.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :category 
+    # @option opts [String] :cursor The pagination cursor value.
+    # @option opts [String] :end_user_email_address If provided, will only return linked accounts associated with the given email address.
+    # @option opts [String] :end_user_organization_name If provided, will only return linked accounts associated with the given organization name.
+    # @option opts [String] :end_user_origin_id If provided, will only return linked accounts associated with the given origin ID.
+    # @option opts [String] :end_user_origin_ids Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+    # @option opts [String] :id 
+    # @option opts [String] :ids Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+    # @option opts [Boolean] :include_duplicates If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+    # @option opts [String] :integration_name If provided, will only return linked accounts associated with the given integration name.
+    # @option opts [String] :is_test_account If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+    # @option opts [Integer] :page_size Number of results to return per page.
+    # @option opts [String] :status Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
+    # @return [PaginatedAccountDetailsAndActionsList]
+    def linked_accounts_list(opts = {})
+      data, _status_code, _headers = linked_accounts_list_with_http_info(opts)
+      data
+    end
+
+    # List linked accounts for your organization.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :category 
+    # @option opts [String] :cursor The pagination cursor value.
+    # @option opts [String] :end_user_email_address If provided, will only return linked accounts associated with the given email address.
+    # @option opts [String] :end_user_organization_name If provided, will only return linked accounts associated with the given organization name.
+    # @option opts [String] :end_user_origin_id If provided, will only return linked accounts associated with the given origin ID.
+    # @option opts [String] :end_user_origin_ids Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+    # @option opts [String] :id 
+    # @option opts [String] :ids Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+    # @option opts [Boolean] :include_duplicates If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+    # @option opts [String] :integration_name If provided, will only return linked accounts associated with the given integration name.
+    # @option opts [String] :is_test_account If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+    # @option opts [Integer] :page_size Number of results to return per page.
+    # @option opts [String] :status Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
+    # @return [Array<(PaginatedAccountDetailsAndActionsList, Integer, Hash)>] PaginatedAccountDetailsAndActionsList data, response status code and response headers
+    def linked_accounts_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LinkedAccountsApi.linked_accounts_list ...'
+      end
+      allowable_values = ["accounting", "ats", "crm", "hris", "ticketing"]
+      if @api_client.config.client_side_validation && opts[:'category'] && !allowable_values.include?(opts[:'category'])
+        fail ArgumentError, "invalid value for \"category\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/linked-accounts'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'end_user_email_address'] = opts[:'end_user_email_address'] if !opts[:'end_user_email_address'].nil?
+      query_params[:'end_user_organization_name'] = opts[:'end_user_organization_name'] if !opts[:'end_user_organization_name'].nil?
+      query_params[:'end_user_origin_id'] = opts[:'end_user_origin_id'] if !opts[:'end_user_origin_id'].nil?
+      query_params[:'end_user_origin_ids'] = opts[:'end_user_origin_ids'] if !opts[:'end_user_origin_ids'].nil?
+      query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
+      query_params[:'ids'] = opts[:'ids'] if !opts[:'ids'].nil?
+      query_params[:'include_duplicates'] = opts[:'include_duplicates'] if !opts[:'include_duplicates'].nil?
+      query_params[:'integration_name'] = opts[:'integration_name'] if !opts[:'integration_name'].nil?
+      query_params[:'is_test_account'] = opts[:'is_test_account'] if !opts[:'is_test_account'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaginatedAccountDetailsAndActionsList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"LinkedAccountsApi.linked_accounts_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LinkedAccountsApi#linked_accounts_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/merge_crm_client/api/notes_api.rb

@@ -0,0 +1,346 @@
+=begin
+#Merge CRM API
+
+#The unified API for building rich integrations with multiple CRM platforms.
+
+The version of the OpenAPI document: 1.0
+Contact: hello@merge.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'cgi'
+
+module MergeCRMClient
+  class NotesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Creates a `Note` object with the given values.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param note_endpoint_request [NoteEndpointRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :is_debug_mode Whether to include debug fields (such as log file links) in the response.
+    # @option opts [Boolean] :run_async Whether or not third-party updates should be run asynchronously.
+    # @return [NoteResponse]
+    def notes_create(x_account_token, note_endpoint_request, opts = {})
+      data, _status_code, _headers = notes_create_with_http_info(x_account_token, note_endpoint_request, opts)
+      data
+    end
+
+    # Creates a `Note` object with the given values.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param note_endpoint_request [NoteEndpointRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :is_debug_mode Whether to include debug fields (such as log file links) in the response.
+    # @option opts [Boolean] :run_async Whether or not third-party updates should be run asynchronously.
+    # @return [Array<(NoteResponse, Integer, Hash)>] NoteResponse data, response status code and response headers
+    def notes_create_with_http_info(x_account_token, note_endpoint_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NotesApi.notes_create ...'
+      end
+      # verify the required parameter 'x_account_token' is set
+      if @api_client.config.client_side_validation && x_account_token.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_token' when calling NotesApi.notes_create"
+      end
+      # verify the required parameter 'note_endpoint_request' is set
+      if @api_client.config.client_side_validation && note_endpoint_request.nil?
+        fail ArgumentError, "Missing the required parameter 'note_endpoint_request' when calling NotesApi.notes_create"
+      end
+      # resource path
+      local_var_path = '/notes'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'is_debug_mode'] = opts[:'is_debug_mode'] if !opts[:'is_debug_mode'].nil?
+      query_params[:'run_async'] = opts[:'run_async'] if !opts[:'run_async'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      header_params[:'X-Account-Token'] = x_account_token
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(note_endpoint_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'NoteResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"NotesApi.notes_create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: NotesApi#notes_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns a list of `Note` objects.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :account_id If provided, will only return notes with this account.
+    # @option opts [String] :contact_id If provided, will only return notes with this contact.
+    # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
+    # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
+    # @option opts [String] :cursor The pagination cursor value.
+    # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+    # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
+    # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
+    # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
+    # @option opts [String] :opportunity_id If provided, will only return notes with this opportunity.
+    # @option opts [String] :owner_id If provided, will only return notes with this owner.
+    # @option opts [Integer] :page_size Number of results to return per page.
+    # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
+    # @return [PaginatedNoteList]
+    def notes_list(x_account_token, opts = {})
+      data, _status_code, _headers = notes_list_with_http_info(x_account_token, opts)
+      data
+    end
+
+    # Returns a list of &#x60;Note&#x60; objects.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :account_id If provided, will only return notes with this account.
+    # @option opts [String] :contact_id If provided, will only return notes with this contact.
+    # @option opts [Time] :created_after If provided, will only return objects created after this datetime.
+    # @option opts [Time] :created_before If provided, will only return objects created before this datetime.
+    # @option opts [String] :cursor The pagination cursor value.
+    # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+    # @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
+    # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
+    # @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
+    # @option opts [String] :opportunity_id If provided, will only return notes with this opportunity.
+    # @option opts [String] :owner_id If provided, will only return notes with this owner.
+    # @option opts [Integer] :page_size Number of results to return per page.
+    # @option opts [String] :remote_id The API provider&#39;s ID for the given object.
+    # @return [Array<(PaginatedNoteList, Integer, Hash)>] PaginatedNoteList data, response status code and response headers
+    def notes_list_with_http_info(x_account_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NotesApi.notes_list ...'
+      end
+      # verify the required parameter 'x_account_token' is set
+      if @api_client.config.client_side_validation && x_account_token.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_token' when calling NotesApi.notes_list"
+      end
+      allowable_values = ["account", "account,opportunity", "contact", "contact,account", "contact,account,opportunity", "contact,opportunity", "opportunity", "owner", "owner,account", "owner,account,opportunity", "owner,contact", "owner,contact,account", "owner,contact,account,opportunity", "owner,contact,opportunity", "owner,opportunity"]
+      if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
+        fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/notes'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
+      query_params[:'contact_id'] = opts[:'contact_id'] if !opts[:'contact_id'].nil?
+      query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
+      query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
+      query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
+      query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
+      query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
+      query_params[:'opportunity_id'] = opts[:'opportunity_id'] if !opts[:'opportunity_id'].nil?
+      query_params[:'owner_id'] = opts[:'owner_id'] if !opts[:'owner_id'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'X-Account-Token'] = x_account_token
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaginatedNoteList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"NotesApi.notes_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: NotesApi#notes_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns metadata for `Note` POSTs.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @return [MetaResponse]
+    def notes_meta_post_retrieve(x_account_token, opts = {})
+      data, _status_code, _headers = notes_meta_post_retrieve_with_http_info(x_account_token, opts)
+      data
+    end
+
+    # Returns metadata for &#x60;Note&#x60; POSTs.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MetaResponse, Integer, Hash)>] MetaResponse data, response status code and response headers
+    def notes_meta_post_retrieve_with_http_info(x_account_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NotesApi.notes_meta_post_retrieve ...'
+      end
+      # verify the required parameter 'x_account_token' is set
+      if @api_client.config.client_side_validation && x_account_token.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_token' when calling NotesApi.notes_meta_post_retrieve"
+      end
+      # resource path
+      local_var_path = '/notes/meta/post'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'X-Account-Token'] = x_account_token
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MetaResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"NotesApi.notes_meta_post_retrieve",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: NotesApi#notes_meta_post_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns a `Note` object with the given `id`.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+    # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @return [Note]
+    def notes_retrieve(x_account_token, id, opts = {})
+      data, _status_code, _headers = notes_retrieve_with_http_info(x_account_token, id, opts)
+      data
+    end
+
+    # Returns a &#x60;Note&#x60; object with the given &#x60;id&#x60;.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+    # @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
+    # @return [Array<(Note, Integer, Hash)>] Note data, response status code and response headers
+    def notes_retrieve_with_http_info(x_account_token, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NotesApi.notes_retrieve ...'
+      end
+      # verify the required parameter 'x_account_token' is set
+      if @api_client.config.client_side_validation && x_account_token.nil?
+        fail ArgumentError, "Missing the required parameter 'x_account_token' when calling NotesApi.notes_retrieve"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling NotesApi.notes_retrieve"
+      end
+      allowable_values = ["account", "account,opportunity", "contact", "contact,account", "contact,account,opportunity", "contact,opportunity", "opportunity", "owner", "owner,account", "owner,account,opportunity", "owner,contact", "owner,contact,account", "owner,contact,account,opportunity", "owner,contact,opportunity", "owner,opportunity"]
+      if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
+        fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/notes/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'X-Account-Token'] = x_account_token
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Note'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"NotesApi.notes_retrieve",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: NotesApi#notes_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end