merge_crm_client 1.0.0

data/lib/merge_crm_client/models/webhook_receiver_request.rb

@@ -0,0 +1,280 @@
+=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 'date'
+require 'time'
+
+module MergeCRMClient
+  class WebhookReceiverRequest
+    attr_accessor :event
+
+    attr_accessor :is_active
+
+    attr_accessor :key
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'event' => :'event',
+        :'is_active' => :'is_active',
+        :'key' => :'key'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'event' => :'String',
+        :'is_active' => :'Boolean',
+        :'key' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MergeCRMClient::WebhookReceiverRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MergeCRMClient::WebhookReceiverRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'event')
+        self.event = attributes[:'event']
+      end
+
+      if attributes.key?(:'is_active')
+        self.is_active = attributes[:'is_active']
+      end
+
+      if attributes.key?(:'key')
+        self.key = attributes[:'key']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @event.nil?
+        invalid_properties.push('invalid value for "event", event cannot be nil.')
+      end
+
+      if @event.to_s.length < 1
+        invalid_properties.push('invalid value for "event", the character length must be great than or equal to 1.')
+      end
+
+      if @is_active.nil?
+        invalid_properties.push('invalid value for "is_active", is_active cannot be nil.')
+      end
+
+      if !@key.nil? && @key.to_s.length < 1
+        invalid_properties.push('invalid value for "key", the character length must be great than or equal to 1.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @event.nil?
+      return false if @event.to_s.length < 1
+      return false if @is_active.nil?
+      return false if !@key.nil? && @key.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] event Value to be assigned
+    def event=(event)
+      if event.nil?
+        fail ArgumentError, 'event cannot be nil'
+      end
+
+      if event.to_s.length < 1
+        fail ArgumentError, 'invalid value for "event", the character length must be great than or equal to 1.'
+      end
+
+      @event = event
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] key Value to be assigned
+    def key=(key)
+      if !key.nil? && key.to_s.length < 1
+        fail ArgumentError, 'invalid value for "key", the character length must be great than or equal to 1.'
+      end
+
+      @key = key
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          event == o.event &&
+          is_active == o.is_active &&
+          key == o.key
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [event, is_active, key].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = MergeCRMClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/merge_crm_client/version.rb

@@ -0,0 +1,15 @@
+=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
+
+module MergeCRMClient
+  VERSION = '1.0.0'
+end

data/lib/merge_crm_client.rb

@@ -0,0 +1,150 @@
+=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
+
+# Common files
+require 'merge_crm_client/api_client'
+require 'merge_crm_client/api_error'
+require 'merge_crm_client/version'
+require 'merge_crm_client/configuration'
+
+# Models
+require 'merge_crm_client/models/account'
+require 'merge_crm_client/models/account_details'
+require 'merge_crm_client/models/account_details_and_actions'
+require 'merge_crm_client/models/account_details_and_actions_integration'
+require 'merge_crm_client/models/account_details_and_actions_status_enum'
+require 'merge_crm_client/models/account_integration'
+require 'merge_crm_client/models/account_request'
+require 'merge_crm_client/models/account_token'
+require 'merge_crm_client/models/activity_type_enum'
+require 'merge_crm_client/models/address'
+require 'merge_crm_client/models/address_request'
+require 'merge_crm_client/models/address_type_enum'
+require 'merge_crm_client/models/available_actions'
+require 'merge_crm_client/models/crm_account_endpoint_request'
+require 'merge_crm_client/models/crm_account_response'
+require 'merge_crm_client/models/crm_contact_endpoint_request'
+require 'merge_crm_client/models/crm_contact_response'
+require 'merge_crm_client/models/categories_enum'
+require 'merge_crm_client/models/category_enum'
+require 'merge_crm_client/models/contact'
+require 'merge_crm_client/models/contact_request'
+require 'merge_crm_client/models/country_enum'
+require 'merge_crm_client/models/data_passthrough_request'
+require 'merge_crm_client/models/debug_mode_log'
+require 'merge_crm_client/models/debug_model_log_summary'
+require 'merge_crm_client/models/direction_enum'
+require 'merge_crm_client/models/email_address'
+require 'merge_crm_client/models/email_address_request'
+require 'merge_crm_client/models/encoding_enum'
+require 'merge_crm_client/models/end_user_details_request'
+require 'merge_crm_client/models/engagement'
+require 'merge_crm_client/models/engagement_endpoint_request'
+require 'merge_crm_client/models/engagement_request'
+require 'merge_crm_client/models/engagement_response'
+require 'merge_crm_client/models/engagement_type'
+require 'merge_crm_client/models/error_validation_problem'
+require 'merge_crm_client/models/generate_remote_key_request'
+require 'merge_crm_client/models/issue'
+require 'merge_crm_client/models/issue_status_enum'
+require 'merge_crm_client/models/lead'
+require 'merge_crm_client/models/lead_endpoint_request'
+require 'merge_crm_client/models/lead_request'
+require 'merge_crm_client/models/lead_response'
+require 'merge_crm_client/models/link_token'
+require 'merge_crm_client/models/linked_account_status'
+require 'merge_crm_client/models/meta_response'
+require 'merge_crm_client/models/method_enum'
+require 'merge_crm_client/models/model_operation'
+require 'merge_crm_client/models/multipart_form_field_request'
+require 'merge_crm_client/models/note'
+require 'merge_crm_client/models/note_endpoint_request'
+require 'merge_crm_client/models/note_request'
+require 'merge_crm_client/models/note_response'
+require 'merge_crm_client/models/opportunity'
+require 'merge_crm_client/models/opportunity_endpoint_request'
+require 'merge_crm_client/models/opportunity_request'
+require 'merge_crm_client/models/opportunity_response'
+require 'merge_crm_client/models/opportunity_status_enum'
+require 'merge_crm_client/models/paginated_account_details_and_actions_list'
+require 'merge_crm_client/models/paginated_account_list'
+require 'merge_crm_client/models/paginated_contact_list'
+require 'merge_crm_client/models/paginated_engagement_list'
+require 'merge_crm_client/models/paginated_engagement_type_list'
+require 'merge_crm_client/models/paginated_issue_list'
+require 'merge_crm_client/models/paginated_lead_list'
+require 'merge_crm_client/models/paginated_note_list'
+require 'merge_crm_client/models/paginated_opportunity_list'
+require 'merge_crm_client/models/paginated_stage_list'
+require 'merge_crm_client/models/paginated_sync_status_list'
+require 'merge_crm_client/models/paginated_task_list'
+require 'merge_crm_client/models/paginated_user_list'
+require 'merge_crm_client/models/phone_number'
+require 'merge_crm_client/models/phone_number_request'
+require 'merge_crm_client/models/remote_data'
+require 'merge_crm_client/models/remote_key'
+require 'merge_crm_client/models/remote_key_for_regeneration_request'
+require 'merge_crm_client/models/remote_response'
+require 'merge_crm_client/models/request_format_enum'
+require 'merge_crm_client/models/stage'
+require 'merge_crm_client/models/sync_status'
+require 'merge_crm_client/models/sync_status_status_enum'
+require 'merge_crm_client/models/task'
+require 'merge_crm_client/models/task_status_enum'
+require 'merge_crm_client/models/user'
+require 'merge_crm_client/models/validation_problem_source'
+require 'merge_crm_client/models/warning_validation_problem'
+require 'merge_crm_client/models/webhook_receiver'
+require 'merge_crm_client/models/webhook_receiver_request'
+
+# APIs
+require 'merge_crm_client/api/account_details_api'
+require 'merge_crm_client/api/account_token_api'
+require 'merge_crm_client/api/accounts_api'
+require 'merge_crm_client/api/available_actions_api'
+require 'merge_crm_client/api/contacts_api'
+require 'merge_crm_client/api/delete_account_api'
+require 'merge_crm_client/api/engagement_types_api'
+require 'merge_crm_client/api/engagements_api'
+require 'merge_crm_client/api/force_resync_api'
+require 'merge_crm_client/api/generate_key_api'
+require 'merge_crm_client/api/issues_api'
+require 'merge_crm_client/api/leads_api'
+require 'merge_crm_client/api/link_token_api'
+require 'merge_crm_client/api/linked_accounts_api'
+require 'merge_crm_client/api/notes_api'
+require 'merge_crm_client/api/opportunities_api'
+require 'merge_crm_client/api/passthrough_api'
+require 'merge_crm_client/api/regenerate_key_api'
+require 'merge_crm_client/api/stages_api'
+require 'merge_crm_client/api/sync_status_api'
+require 'merge_crm_client/api/tasks_api'
+require 'merge_crm_client/api/users_api'
+require 'merge_crm_client/api/webhook_receivers_api'
+
+module MergeCRMClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   MergeCRMClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/merge_crm_client.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+=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
+
+$:.push File.expand_path("../lib", __FILE__)
+require "merge_crm_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "merge_crm_client"
+  s.version     = MergeCRMClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["OpenAPI-Generator"]
+  s.email       = ["hello@merge.dev"]
+  s.homepage    = "https://openapi-generator.tech"
+  s.summary     = "Merge CRM API Ruby Gem"
+  s.description = "The unified API for building rich integrations with multiple CRM platforms."
+  s.license     = "Nonstandard"
+  s.required_ruby_version = ">= 2.4"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/pull_request_template.md

@@ -0,0 +1,19 @@
+## Description of the change
+
+> Description here
+
+## Type of change
+- [ ] Bug fix (non-breaking change that fixes an issue)
+- [ ] New feature (non-breaking change that adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+
+## Checklists
+
+### Development
+
+- [ ] The code changed/added as part of this pull request has been covered with tests, or the description above explains how testing was performed
+
+### Code review
+
+- [ ]  This pull request has a descriptive title and information useful to a reviewer. There may be a screenshot or gif attached. Download "Kap" from the Mac App store for easy gif screen capture.
+

data/spec/api/account_details_api_spec.rb

@@ -0,0 +1,46 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for MergeCRMClient::AccountDetailsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AccountDetailsApi' do
+  before do
+    # run before each test
+    @api_instance = MergeCRMClient::AccountDetailsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AccountDetailsApi' do
+    it 'should create an instance of AccountDetailsApi' do
+      expect(@api_instance).to be_instance_of(MergeCRMClient::AccountDetailsApi)
+    end
+  end
+
+  # unit tests for account_details_retrieve
+  # Get details for a linked account.
+  # @param x_account_token Token identifying the end user.
+  # @param [Hash] opts the optional parameters
+  # @return [AccountDetails]
+  describe 'account_details_retrieve test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/account_token_api_spec.rb

@@ -0,0 +1,46 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for MergeCRMClient::AccountTokenApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AccountTokenApi' do
+  before do
+    # run before each test
+    @api_instance = MergeCRMClient::AccountTokenApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AccountTokenApi' do
+    it 'should create an instance of AccountTokenApi' do
+      expect(@api_instance).to be_instance_of(MergeCRMClient::AccountTokenApi)
+    end
+  end
+
+  # unit tests for account_token_retrieve
+  # Returns the account token for the end user with the provided public token.
+  # @param public_token 
+  # @param [Hash] opts the optional parameters
+  # @return [AccountToken]
+  describe 'account_token_retrieve test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end