merge_crm_client 1.0.0

data/lib/merge_crm_client/api/engagements_api.rb

@@ -0,0 +1,334 @@
+=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 EngagementsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Creates an `Engagement` object with the given values.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param engagement_endpoint_request [EngagementEndpointRequest] 
+    # @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 [EngagementResponse]
+    def engagements_create(x_account_token, engagement_endpoint_request, opts = {})
+      data, _status_code, _headers = engagements_create_with_http_info(x_account_token, engagement_endpoint_request, opts)
+      data
+    end
+
+    # Creates an `Engagement` object with the given values.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param engagement_endpoint_request [EngagementEndpointRequest] 
+    # @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<(EngagementResponse, Integer, Hash)>] EngagementResponse data, response status code and response headers
+    def engagements_create_with_http_info(x_account_token, engagement_endpoint_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EngagementsApi.engagements_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 EngagementsApi.engagements_create"
+      end
+      # verify the required parameter 'engagement_endpoint_request' is set
+      if @api_client.config.client_side_validation && engagement_endpoint_request.nil?
+        fail ArgumentError, "Missing the required parameter 'engagement_endpoint_request' when calling EngagementsApi.engagements_create"
+      end
+      # resource path
+      local_var_path = '/engagements'
+
+      # 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(engagement_endpoint_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EngagementResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"EngagementsApi.engagements_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: EngagementsApi#engagements_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns a list of `Engagement` objects.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @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 [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 [PaginatedEngagementList]
+    def engagements_list(x_account_token, opts = {})
+      data, _status_code, _headers = engagements_list_with_http_info(x_account_token, opts)
+      data
+    end
+
+    # Returns a list of &#x60;Engagement&#x60; objects.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @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 [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<(PaginatedEngagementList, Integer, Hash)>] PaginatedEngagementList data, response status code and response headers
+    def engagements_list_with_http_info(x_account_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EngagementsApi.engagements_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 EngagementsApi.engagements_list"
+      end
+      allowable_values = ["account", "account,engagement_type", "engagement_type", "owner", "owner,account", "owner,account,engagement_type", "owner,engagement_type"]
+      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 = '/engagements'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      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[:'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] || 'PaginatedEngagementList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"EngagementsApi.engagements_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: EngagementsApi#engagements_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns metadata for `Engagement` POSTs.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @return [MetaResponse]
+    def engagements_meta_post_retrieve(x_account_token, opts = {})
+      data, _status_code, _headers = engagements_meta_post_retrieve_with_http_info(x_account_token, opts)
+      data
+    end
+
+    # Returns metadata for &#x60;Engagement&#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 engagements_meta_post_retrieve_with_http_info(x_account_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EngagementsApi.engagements_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 EngagementsApi.engagements_meta_post_retrieve"
+      end
+      # resource path
+      local_var_path = '/engagements/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 => :"EngagementsApi.engagements_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: EngagementsApi#engagements_meta_post_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns an `Engagement` 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 [Engagement]
+    def engagements_retrieve(x_account_token, id, opts = {})
+      data, _status_code, _headers = engagements_retrieve_with_http_info(x_account_token, id, opts)
+      data
+    end
+
+    # Returns an &#x60;Engagement&#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<(Engagement, Integer, Hash)>] Engagement data, response status code and response headers
+    def engagements_retrieve_with_http_info(x_account_token, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EngagementsApi.engagements_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 EngagementsApi.engagements_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 EngagementsApi.engagements_retrieve"
+      end
+      allowable_values = ["account", "account,engagement_type", "engagement_type", "owner", "owner,account", "owner,account,engagement_type", "owner,engagement_type"]
+      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 = '/engagements/{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] || 'Engagement'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"EngagementsApi.engagements_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: EngagementsApi#engagements_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/merge_crm_client/api/force_resync_api.rb

@@ -0,0 +1,84 @@
+=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 ForceResyncApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Force re-sync of all models. This is only available for organizations on Merge's Grow and Expand plans.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<SyncStatus>]
+    def sync_status_resync_create(x_account_token, opts = {})
+      data, _status_code, _headers = sync_status_resync_create_with_http_info(x_account_token, opts)
+      data
+    end
+
+    # Force re-sync of all models. This is only available for organizations on Merge&#39;s Grow and Expand plans.
+    # @param x_account_token [String] Token identifying the end user.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<SyncStatus>, Integer, Hash)>] Array<SyncStatus> data, response status code and response headers
+    def sync_status_resync_create_with_http_info(x_account_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ForceResyncApi.sync_status_resync_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 ForceResyncApi.sync_status_resync_create"
+      end
+      # resource path
+      local_var_path = '/sync-status/resync'
+
+      # 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] || 'Array<SyncStatus>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"ForceResyncApi.sync_status_resync_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: ForceResyncApi#sync_status_resync_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/merge_crm_client/api/generate_key_api.rb

@@ -0,0 +1,85 @@
+=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 GenerateKeyApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a remote key.
+    # @param generate_remote_key_request [GenerateRemoteKeyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [RemoteKey]
+    def generate_key_create(generate_remote_key_request, opts = {})
+      data, _status_code, _headers = generate_key_create_with_http_info(generate_remote_key_request, opts)
+      data
+    end
+
+    # Create a remote key.
+    # @param generate_remote_key_request [GenerateRemoteKeyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RemoteKey, Integer, Hash)>] RemoteKey data, response status code and response headers
+    def generate_key_create_with_http_info(generate_remote_key_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GenerateKeyApi.generate_key_create ...'
+      end
+      # verify the required parameter 'generate_remote_key_request' is set
+      if @api_client.config.client_side_validation && generate_remote_key_request.nil?
+        fail ArgumentError, "Missing the required parameter 'generate_remote_key_request' when calling GenerateKeyApi.generate_key_create"
+      end
+      # resource path
+      local_var_path = '/generate-key'
+
+      # 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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(generate_remote_key_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RemoteKey'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"GenerateKeyApi.generate_key_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: GenerateKeyApi#generate_key_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end