basecrm 0.1.2 → 1.0.0

data/lib/basecrm/models/deal.rb

@@ -0,0 +1,58 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class Deal < Model
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time that the deal was created in UTC (ISO8601 format).
+    # attr_reader :created_at
+    # @!attribute [r] creator_id
+    #   @return [Integer] Unique identifier of the user who created the deal.
+    # attr_reader :creator_id
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the deal.
+    # attr_reader :id
+    # @!attribute [r] organization_id
+    #   @return [Integer] Unique identifier of an organization.
+    # attr_reader :organization_id
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of the last update on the deal in UTC (ISO8601 format).
+    # attr_reader :updated_at
+
+    # @!attribute [rw] contact_id
+    #   @return [Integer] Unique identifier of a primary contact.
+    # attr_accessor :contact_id
+    # @!attribute [rw] currency
+    #   @return [String] Currency of the deal, specified in 3-character currency code (ISO4217) format.
+    # attr_accessor :currency
+    # @!attribute [rw] custom_fields
+    #   @return [Hash] Custom fields are key-value data attached to a deal. See more at [Custom Fields](/docs/rest/articles/requests#custom_fields).
+    # attr_accessor :custom_fields
+    # @!attribute [rw] dropbox_email
+    #   @return [String] Dropbox email connected with the deal.
+    # attr_accessor :dropbox_email
+    # @!attribute [rw] hot
+    #   @return [Boolean] Indicator of whether or not the deal is hot.
+    # attr_accessor :hot
+    # @!attribute [rw] loss_reason_id
+    #   @return [Integer] Reason why the deal was lost.
+    # attr_accessor :loss_reason_id
+    # @!attribute [rw] name
+    #   @return [String] Name of the deal.
+    # attr_accessor :name
+    # @!attribute [rw] owner_id
+    #   @return [Integer] Unique identifier of the user that the deal is assigned to.
+    # attr_accessor :owner_id
+    # @!attribute [rw] source_id
+    #   @return [Integer] Unique identifier of the Source.
+    # attr_accessor :source_id
+    # @!attribute [rw] stage_id
+    #   @return [Integer] Unique identifier of the deal's current stage in the pipeline.
+    # attr_accessor :stage_id
+    # @!attribute [rw] tags
+    #   @return [Array<String>] An array of tags for a deal. See more at [Tags](/docs/rest/articles/requests#tags).
+    # attr_accessor :tags
+    # @!attribute [rw] value
+    #   @return [Integer] Value of the deal in a currency specified in the `currency` field.
+    # attr_accessor :value
+  end
+end

data/lib/basecrm/models/lead.rb

@@ -0,0 +1,79 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class Lead < Model
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time of the creation in UTC (ISO8601 format).
+    # attr_reader :created_at
+    # @!attribute [r] creator_id
+    #   @return [Integer] Unique identifier of the user who created the lead.
+    # attr_reader :creator_id
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the lead.
+    # attr_reader :id
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of the last update in UTC (ISO8601 format).
+    # attr_reader :updated_at
+
+    # @!attribute [rw] address
+    #   @return [Address] 
+    # attr_accessor :address
+    # @!attribute [rw] custom_fields
+    #   @return [Hash] Custom fields are a either a single key-value pair attached to a lead or a set of key-value pairs attached to a lead. See more at [Custom Fields](/docs/rest/articles/requests#custom_fields).
+    # attr_accessor :custom_fields
+    # @!attribute [rw] description
+    #   @return [String] Lead description.
+    # attr_accessor :description
+    # @!attribute [rw] email
+    #   @return [String] Lead's email.
+    # attr_accessor :email
+    # @!attribute [rw] facebook
+    #   @return [String] Lead's Facebook nickname.
+    # attr_accessor :facebook
+    # @!attribute [rw] fax
+    #   @return [String] Lead's fax number.
+    # attr_accessor :fax
+    # @!attribute [rw] first_name
+    #   @return [String] First name of the lead.
+    # attr_accessor :first_name
+    # @!attribute [rw] industry
+    #   @return [String] Organization's industry.
+    # attr_accessor :industry
+    # @!attribute [rw] last_name
+    #   @return [String] Last name of the lead. Required unless `organization_name` field is provided.
+    # attr_accessor :last_name
+    # @!attribute [rw] linkedin
+    #   @return [String] Lead's Linkedin nickname.
+    # attr_accessor :linkedin
+    # @!attribute [rw] mobile
+    #   @return [String] Lead's mobile phone number.
+    # attr_accessor :mobile
+    # @!attribute [rw] organization_name
+    #   @return [String] Organization name of the lead. Required unless `last_name` field is provided.
+    # attr_accessor :organization_name
+    # @!attribute [rw] owner_id
+    #   @return [Integer] Unique identifier of the user who currently owns the lead.
+    # attr_accessor :owner_id
+    # @!attribute [rw] phone
+    #   @return [String] Lead's phone number.
+    # attr_accessor :phone
+    # @!attribute [rw] skype
+    #   @return [String] Lead's Skype nickname.
+    # attr_accessor :skype
+    # @!attribute [rw] status
+    #   @return [String] Status of the lead.
+    # attr_accessor :status
+    # @!attribute [rw] tags
+    #   @return [Array<String>] An array of tags for a lead. See more at [Tags](/docs/rest/articles/requests#tags).
+    # attr_accessor :tags
+    # @!attribute [rw] title
+    #   @return [String] Job title of the lead.
+    # attr_accessor :title
+    # @!attribute [rw] twitter
+    #   @return [String] Lead's Twitter handle.
+    # attr_accessor :twitter
+    # @!attribute [rw] website
+    #   @return [String] Lead's website.
+    # attr_accessor :website
+  end
+end

data/lib/basecrm/models/loss_reason.rb

@@ -0,0 +1,22 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class LossReason < Model
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time of creation in UTC ISO8601 format.
+    # attr_reader :created_at
+    # @!attribute [r] creator_id
+    #   @return [Integer] Unique identifier of the user the loss reason was created by.
+    # attr_reader :creator_id
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the loss reason.
+    # attr_reader :id
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of the last update in UTC ISO8601 format.
+    # attr_reader :updated_at
+
+    # @!attribute [rw] name
+    #   @return [String] Human-friendly loss reason explanation.
+    # attr_accessor :name
+  end
+end

data/lib/basecrm/models/note.rb

@@ -0,0 +1,28 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class Note < Model
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time of creation in UTC (ISO8601 format).
+    # attr_reader :created_at
+    # @!attribute [r] creator_id
+    #   @return [Integer] Unique identifier of the user that created the note.
+    # attr_reader :creator_id
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the note.
+    # attr_reader :id
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of the last update in UTC (ISO8601 format).
+    # attr_reader :updated_at
+
+    # @!attribute [rw] content
+    #   @return [String] Content of the note.
+    # attr_accessor :content
+    # @!attribute [rw] resource_id
+    #   @return [Integer] Unique identifier of the resource the note is attached to.
+    # attr_accessor :resource_id
+    # @!attribute [rw] resource_type
+    #   @return [String] Type name of the resource the note is attached to.
+    # attr_accessor :resource_type
+  end
+end

data/lib/basecrm/models/pipeline.rb

@@ -0,0 +1,19 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class Pipeline < Model
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time of creation in UTC ISO8601 format.
+    # attr_reader :created_at
+    # @!attribute [r] id
+    #   @return [Integer] The unique identifier of the pipeline.
+    # attr_reader :id
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of last update in UTC ISO8601 format.
+    # attr_reader :updated_at
+
+    # @!attribute [rw] name
+    #   @return [String] Human-friendly name of the pipeline.
+    # attr_accessor :name
+  end
+end

data/lib/basecrm/models/source.rb

@@ -0,0 +1,22 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class Source < Model
+    # @!attribute [r] created_at
+    #   @return [String] Date and time of creation in UTC (ISO 8601 format).
+    # attr_reader :created_at
+    # @!attribute [r] creator_id
+    #   @return [Integer] Unique identifier of the user that created the source.
+    # attr_reader :creator_id
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the deal source.
+    # attr_reader :id
+    # @!attribute [r] updated_at
+    #   @return [String] Date and time of the last update in UTC (ISO 8601 format).
+    # attr_reader :updated_at
+
+    # @!attribute [rw] name
+    #   @return [String] Name of the source.
+    # attr_accessor :name
+  end
+end

data/lib/basecrm/models/stage.rb

@@ -0,0 +1,34 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class Stage < Model
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time of creation in UTC ISO8601 format.
+    # attr_reader :created_at
+    # @!attribute [r] id
+    #   @return [Integer] The unique identifier of the stage.
+    # attr_reader :id
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of last update in UTC ISO8601 format.
+    # attr_reader :updated_at
+
+    # @!attribute [rw] active
+    #   @return [Boolean] Indicator whether or not the stage contains finalized deals.
+    # attr_accessor :active
+    # @!attribute [rw] category
+    #   @return [String] The unique category name of the stage.
+    # attr_accessor :category
+    # @!attribute [rw] likelihood
+    #   @return [Integer] The likelihood that a deal will be won, set for the stage as percentage.
+    # attr_accessor :likelihood
+    # @!attribute [rw] name
+    #   @return [String] Human-friendly name of the stage.
+    # attr_accessor :name
+    # @!attribute [rw] pipeline_id
+    #   @return [Integer] Unique identifier of the pipeline that contains this stage.
+    # attr_accessor :pipeline_id
+    # @!attribute [rw] position
+    #   @return [Integer] The stage's position in the pipeline.
+    # attr_accessor :position
+  end
+end

data/lib/basecrm/models/tag.rb

@@ -0,0 +1,25 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class Tag < Model
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time of creation in UTC (ISO8601 format).
+    # attr_reader :created_at
+    # @!attribute [r] creator_id
+    #   @return [Integer] User ID of the tag's creator.
+    # attr_reader :creator_id
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the tag.
+    # attr_reader :id
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of the last update in UTC (ISO8601 format).
+    # attr_reader :updated_at
+
+    # @!attribute [rw] name
+    #   @return [String] Name of the tag.
+    # attr_accessor :name
+    # @!attribute [rw] resource_type
+    #   @return [String] Type name of the resource the tag is attached to.
+    # attr_accessor :resource_type
+  end
+end

data/lib/basecrm/models/task.rb

@@ -0,0 +1,46 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class Task < Model
+    # @!attribute [r] completed_at
+    #   @return [DateTime] Date and time of the task's completion in UTC (ISO8601 format).
+    # attr_reader :completed_at
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time of task creation in UTC (ISO8601 format).
+    # attr_reader :created_at
+    # @!attribute [r] creator_id
+    #   @return [Integer] Unique identifier of the user who created the task.
+    # attr_reader :creator_id
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the task.
+    # attr_reader :id
+    # @!attribute [r] overdue
+    #   @return [Boolean] Indicator for whether the task has passed the `due_date` or not.
+    # attr_reader :overdue
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of the last update to the task in UTC (ISO8601 format).
+    # attr_reader :updated_at
+
+    # @!attribute [rw] completed
+    #   @return [Boolean] Indicator of whether the task is completed or not.
+    # attr_accessor :completed
+    # @!attribute [rw] content
+    #   @return [String] Content of the task.
+    # attr_accessor :content
+    # @!attribute [rw] due_date
+    #   @return [DateTime] Date and time of creation in UTC (ISO8601 format).
+    # attr_accessor :due_date
+    # @!attribute [rw] owner_id
+    #   @return [Integer] Unique identifier of the user the task is assigned to.
+    # attr_accessor :owner_id
+    # @!attribute [rw] remind_at
+    #   @return [DateTime] Date and time that we should send you a reminder in UTC (ISO8601 format).
+    # attr_accessor :remind_at
+    # @!attribute [rw] resource_id
+    #   @return [Integer] Unique identifier of the resource the task is attached to.
+    # attr_accessor :resource_id
+    # @!attribute [rw] resource_type
+    #   @return [String] Name of the resource type the task is attached to.
+    # attr_accessor :resource_type
+  end
+end

data/lib/basecrm/models/user.rb

@@ -0,0 +1,31 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class User < Model
+    # @!attribute [r] confirmed
+    #   @return [Boolean] Indicates whether the user's account has been confirmed or not.
+    # attr_reader :confirmed
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time of creation in UTC (ISO8601 format).
+    # attr_reader :created_at
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the user.
+    # attr_reader :id
+    # @!attribute [r] role
+    #   @return [String] Role of the user.
+    # attr_reader :role
+    # @!attribute [r] status
+    #   @return [String] Status of the user's account. Usually `active`.
+    # attr_reader :status
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of the last update in UTC (ISO8601 format).
+    # attr_reader :updated_at
+
+    # @!attribute [rw] email
+    #   @return [String] Email address of the user.
+    # attr_accessor :email
+    # @!attribute [rw] name
+    #   @return [String] Full name of the user.
+    # attr_accessor :name
+  end
+end

data/lib/basecrm/paginated_resource.rb

@@ -0,0 +1,32 @@
+module BaseCRM
+  class PaginatedResource
+    include Enumerable
+
+    attr_reader :current_page
+
+    def initialize(service, *args)
+      raise TypeError unless service.respond_to?(:where)
+
+      @service = service
+      @args = args
+      @options = args.last.kind_of?(Hash) ? args.pop : {}
+    end
+
+    def each(&block)
+      return to_enum(:each) unless block_given?
+
+      current_page = 1
+      per_page = 25
+
+      search_options = @options.merge(page: current_page, per_page: per_page)
+
+      until (resources = @service.where(*@args, search_options)).empty?
+        resources.each(&block)
+        current_page += 1
+        search_options[:page] = current_page
+      end
+
+      self
+    end
+  end
+end

data/lib/basecrm/services/accounts_service.rb

@@ -0,0 +1,33 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class AccountsService
+    def initialize(client)
+      @client = client
+    end
+  
+    # Retrieve account details
+    # 
+    # get '/accounts/self'
+    #
+    # Returns detailed information about your account
+    #
+    # @return [Account] Resource object. 
+    def self
+      _, _, root = @client.get("/accounts/self")
+      Account.new(root[:data])
+    end
+
+
+  private
+    def validate_type!(account)
+      raise TypeError unless account.is_a?(Account) || account.is_a?(Hash)
+    end
+
+    def extract_params!(account, *args)
+      params = account.to_h.select{ |k, _| args.include?(k) }
+      raise ArgumentError, "one of required attributes is missing. Expected: #{args.join(',')}" if params.count != args.length
+      params
+    end
+  end
+end