Module: BaseCRM

Defined in:
lib/basecrm/models/tag.rb,
lib/basecrm.rb,
lib/basecrm/sync.rb,
lib/basecrm/model.rb,
lib/basecrm/errors.rb,
lib/basecrm/version.rb,
lib/basecrm/envelope.rb,
lib/basecrm/http_client.rb,
lib/basecrm/models/deal.rb,
lib/basecrm/models/lead.rb,
lib/basecrm/models/meta.rb,
lib/basecrm/models/note.rb,
lib/basecrm/models/task.rb,
lib/basecrm/models/user.rb,
lib/basecrm/models/stage.rb,
lib/basecrm/configuration.rb,
lib/basecrm/models/source.rb,
lib/basecrm/models/account.rb,
lib/basecrm/models/address.rb,
lib/basecrm/models/contact.rb,
lib/basecrm/utils/coercion.rb,
lib/basecrm/models/pipeline.rb,
lib/basecrm/models/sync_meta.rb,
lib/basecrm/models/sync_queue.rb,
lib/basecrm/models/loss_reason.rb,
lib/basecrm/paginated_resource.rb,
lib/basecrm/models/sync_session.rb,
lib/basecrm/services/sync_service.rb,
lib/basecrm/services/tags_service.rb,
lib/basecrm/services/deals_service.rb,
lib/basecrm/services/leads_service.rb,
lib/basecrm/services/notes_service.rb,
lib/basecrm/services/tasks_service.rb,
lib/basecrm/services/users_service.rb,
lib/basecrm/middlewares/raise_error.rb,
lib/basecrm/services/stages_service.rb,
lib/basecrm/services/sources_service.rb,
lib/basecrm/models/associated_contact.rb,
lib/basecrm/services/accounts_service.rb,
lib/basecrm/services/contacts_service.rb,
lib/basecrm/services/pipelines_service.rb,
lib/basecrm/services/loss_reasons_service.rb,
lib/basecrm/middlewares/oauth_bearer_token.rb,
lib/basecrm/services/associated_contacts_service.rb

Overview

WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema

Defined Under Namespace

Modules: Envelope, Middlewares Classes: Account, AccountsService, Address, AssociatedContact, AssociatedContactsService, BaseError, Client, Coercion, Configuration, ConfigurationError, ConnectionError, Contact, ContactsService, Deal, DealsService, ErrorsCollection, HttpClient, Lead, LeadsService, LossReason, LossReasonsService, Meta, Model, Note, NotesService, PaginatedResource, Pipeline, PipelinesService, RequestError, ResourceError, ServerError, Source, SourcesService, Stage, StagesService, Sync, SyncMeta, SyncQueue, SyncService, SyncSession, Tag, TagsService, Task, TasksService, User, UsersService

Constant Summary collapse

VERSION = 
"1.2.3"

Instance Attribute Summary collapse

Instance Attribute Details

#active ⇒ Boolean

Returns Indicator whether or not the stage contains finalized deals.

Returns:

  • (Boolean) —

    Indicator whether or not the stage contains finalized deals.




# File 'lib/basecrm/models/stage.rb', line 15

#address ⇒ Address

Returns:




# File 'lib/basecrm/models/lead.rb', line 18

#category ⇒ String

Returns The unique category name of the stage.

Returns:

  • (String) —

    The unique category name of the stage.




# File 'lib/basecrm/models/stage.rb', line 15

#city ⇒ String

Returns City name.

Returns:

  • (String) —

    City name.




# File 'lib/basecrm/models/address.rb', line 6

#completed ⇒ Boolean

Returns Indicator of whether the task is completed or not.

Returns:

  • (Boolean) —

    Indicator of whether the task is completed or not.




# File 'lib/basecrm/models/task.rb', line 24

#completed_at ⇒ DateTime (readonly)

Returns Date and time of the task’s completion in UTC (ISO8601 format).

Returns:

  • (DateTime) —

    Date and time of the task’s completion in UTC (ISO8601 format).




# File 'lib/basecrm/models/task.rb', line 5

#confirmed ⇒ Boolean (readonly)

Returns Indicates whether the user’s account has been confirmed or not.

Returns:

  • (Boolean) —

    Indicates whether the user’s account has been confirmed or not.




# File 'lib/basecrm/models/user.rb', line 5

#contact_id ⇒ Integer

Returns Unique identifier of the contact to be associated with the deal.

Returns:

  • (Integer) —

    Unique identifier of the contact to be associated with the deal.




# File 'lib/basecrm/models/contact.rb', line 18

#content ⇒ String

Returns Content of the task.

Returns:

  • (String) —

    Content of the task.




# File 'lib/basecrm/models/note.rb', line 18

#country ⇒ String

Returns Country name.

Returns:

  • (String) —

    Country name.




# File 'lib/basecrm/models/address.rb', line 6

#created_at ⇒ DateTime (readonly)

Returns Date and time that the associated contact was created in UTC (ISO8601 format).

Returns:

  • (DateTime) —

    Date and time that the associated contact was created in UTC (ISO8601 format).




# File 'lib/basecrm/models/tag.rb', line 5

#creator_id ⇒ Integer (readonly)

Returns Unique identifier of the user the loss reason was created by.

Returns:

  • (Integer) —

    Unique identifier of the user the loss reason was created by.




# File 'lib/basecrm/models/tag.rb', line 5

#currency ⇒ String

Returns Currency of the account as the 3-character currency code in ISO4217 format.

Returns:

  • (String) —

    Currency of the account as the 3-character currency code in ISO4217 format.




# File 'lib/basecrm/models/account.rb', line 15

#custom_fields ⇒ Hash

Returns Custom fields are a key-value pair attached to a contact. See more at [Custom Fields](/docs/rest/articles/requests#custom_fields).

Returns:

  • (Hash) —

    Custom fields are a key-value pair attached to a contact. See more at [Custom Fields](/docs/rest/articles/requests#custom_fields).




# File 'lib/basecrm/models/lead.rb', line 18

#customer_status ⇒ String

Returns The customer status of the contact.

Returns:

  • (String) —

    The customer status of the contact.




# File 'lib/basecrm/models/contact.rb', line 18

#description ⇒ String

Returns The contact’s description.

Returns:

  • (String) —

    The contact’s description.




# File 'lib/basecrm/models/lead.rb', line 18

#due_date ⇒ DateTime

Returns Date and time of creation in UTC (ISO8601 format).

Returns:

  • (DateTime) —

    Date and time of creation in UTC (ISO8601 format).




# File 'lib/basecrm/models/task.rb', line 24

#email ⇒ String

Returns The contact’s email address.

Returns:

  • (String) —

    The contact’s email address.




# File 'lib/basecrm/models/lead.rb', line 18

#facebook ⇒ String

Returns The contact’s Facebook nickname.

Returns:

  • (String) —

    The contact’s Facebook nickname.




# File 'lib/basecrm/models/lead.rb', line 18

#fax ⇒ String

Returns The contact’s fax number.

Returns:

  • (String) —

    The contact’s fax number.




# File 'lib/basecrm/models/lead.rb', line 18

#first_name ⇒ String

Returns First name of the contact.

Returns:

  • (String) —

    First name of the contact.




# File 'lib/basecrm/models/lead.rb', line 18

#id ⇒ String (readonly)

Returns Unique identifier for the sync session.

Returns:

  • (String) —

    Unique identifier for the sync session.




# File 'lib/basecrm/models/tag.rb', line 5

#industry ⇒ String

Returns The contact’s industry.

Returns:

  • (String) —

    The contact’s industry.




# File 'lib/basecrm/models/lead.rb', line 18

#is_organization ⇒ Boolean

Returns Indicator of whether or not this contact refers to an organization or an individual. This value can be set only during creation and cannot be changed later. The default value is ‘false`.

Returns:

  • (Boolean) —

    Indicator of whether or not this contact refers to an organization or an individual. This value can be set only during creation and cannot be changed later. The default value is ‘false`.




# File 'lib/basecrm/models/contact.rb', line 18

#last_name ⇒ String

Returns Last name of the contact. Required only if the contact is an individual.

Returns:

  • (String) —

    Last name of the contact. Required only if the contact is an individual.




# File 'lib/basecrm/models/lead.rb', line 18

#likelihood ⇒ Integer

Returns The likelihood that a deal will be won, set for the stage as percentage.

Returns:

  • (Integer) —

    The likelihood that a deal will be won, set for the stage as percentage.




# File 'lib/basecrm/models/stage.rb', line 15

#line1 ⇒ String

Returns Line 1 of the address e.g. number, street, suite, apt #, etc.

Returns:

  • (String) —

    Line 1 of the address e.g. number, street, suite, apt #, etc.




# File 'lib/basecrm/models/address.rb', line 6

#linkedin ⇒ String

Returns The contact’s Linkedin nickname.

Returns:

  • (String) —

    The contact’s Linkedin nickname.




# File 'lib/basecrm/models/lead.rb', line 18

#mobile ⇒ String

Returns The contact’s mobile phone number.

Returns:

  • (String) —

    The contact’s mobile phone number.




# File 'lib/basecrm/models/lead.rb', line 18

#name ⇒ String

Returns Human-friendly loss reason explanation.

Returns:

  • (String) —

    Human-friendly loss reason explanation.




# File 'lib/basecrm/models/tag.rb', line 18

#organization_name ⇒ String

Returns Organization name of the lead. Required unless ‘last_name` field is provided.

Returns:

  • (String) —

    Organization name of the lead. Required unless ‘last_name` field is provided.




# File 'lib/basecrm/models/lead.rb', line 18

#overdue ⇒ Boolean (readonly)

Returns Indicator for whether the task has passed the ‘due_date` or not.

Returns:

  • (Boolean) —

    Indicator for whether the task has passed the ‘due_date` or not.




# File 'lib/basecrm/models/task.rb', line 5

#owner_id ⇒ Integer

Returns The unique identifier of the user the contact is currently assigned to.

Returns:

  • (Integer) —

    The unique identifier of the user the contact is currently assigned to.




# File 'lib/basecrm/models/lead.rb', line 18

#pages ⇒ Integer (readonly)

Returns Number of pages to request.

Returns:

  • (Integer) —

    Number of pages to request.




# File 'lib/basecrm/models/sync_queue.rb', line 7

#phone ⇒ String

Returns The contact’s phone number.

Returns:

  • (String) —

    The contact’s phone number.




# File 'lib/basecrm/models/lead.rb', line 18

#pipeline_id ⇒ Integer

Returns Unique identifier of the pipeline that contains this stage.

Returns:

  • (Integer) —

    Unique identifier of the pipeline that contains this stage.




# File 'lib/basecrm/models/stage.rb', line 15

#position ⇒ Integer

Returns The stage’s position in the pipeline.

Returns:

  • (Integer) —

    The stage’s position in the pipeline.




# File 'lib/basecrm/models/stage.rb', line 15

#postal_code ⇒ String

Returns Zip code or equivalent.

Returns:

  • (String) —

    Zip code or equivalent.




# File 'lib/basecrm/models/address.rb', line 6

#prospect_status ⇒ String

Returns The prospect status of the contact.

Returns:

  • (String) —

    The prospect status of the contact.




# File 'lib/basecrm/models/contact.rb', line 18

#queues ⇒ Array<SyncQueue> (readonly)

Returns A list of sync queues.

Returns:

  • (Array<SyncQueue>) —

    A list of sync queues.




# File 'lib/basecrm/models/sync_session.rb', line 7

#remind_at ⇒ DateTime

Returns Date and time that we should send you a reminder in UTC (ISO8601 format).

Returns:

  • (DateTime) —

    Date and time that we should send you a reminder in UTC (ISO8601 format).




# File 'lib/basecrm/models/task.rb', line 24

#resource_id ⇒ Integer

Returns Unique identifier of the resource the task is attached to.

Returns:

  • (Integer) —

    Unique identifier of the resource the task is attached to.




# File 'lib/basecrm/models/note.rb', line 18

#resource_type ⇒ String

Returns Name of the resource type the task is attached to.

Returns:

  • (String) —

    Name of the resource type the task is attached to.




# File 'lib/basecrm/models/tag.rb', line 18

#role ⇒ String

Returns Role name.

Returns:

  • (String) —

    Role name.




# File 'lib/basecrm/models/user.rb', line 5

#skype ⇒ String

Returns The contact’s Skype nickname.

Returns:

  • (String) —

    The contact’s Skype nickname.




# File 'lib/basecrm/models/lead.rb', line 18

#source_id ⇒ Integer

Returns Unique identifier of the Source.

Returns:

  • (Integer) —

    Unique identifier of the Source.




# File 'lib/basecrm/models/lead.rb', line 18

#state ⇒ String

Returns State name.

Returns:

  • (String) —

    State name.




# File 'lib/basecrm/models/address.rb', line 6

#status ⇒ String

Returns Status of the user’s account. Usually ‘active`.

Returns:

  • (String) —

    Status of the user’s account. Usually ‘active`.




# File 'lib/basecrm/models/lead.rb', line 18

#sync ⇒ SyncMeta (readonly)

Returns An entity which represents sync metadata. See below for it’s attributes.

Returns:

  • (SyncMeta) —

    An entity which represents sync metadata. See below for it’s attributes.




# File 'lib/basecrm/models/meta.rb', line 7

#tags ⇒ Array<String>

Returns An array of tags for the contact. See more at [Tags](/docs/rest/articles/requests#tags).

Returns:

  • (Array<String>) —

    An array of tags for the contact. See more at [Tags](/docs/rest/articles/requests#tags).




# File 'lib/basecrm/models/lead.rb', line 18

#time_format ⇒ String

Returns Time format used for the account. Either 12-hour clock ‘12H` or 24-hour clock `24H`.

Returns:

  • (String) —

    Time format used for the account. Either 12-hour clock ‘12H` or 24-hour clock `24H`.




# File 'lib/basecrm/models/account.rb', line 15

#timezone ⇒ String

Returns Timezone of the account as the offset from Coordinated Universal Time (UTC) in the format ‘UTC(+|-):[mm]`.

Returns:

  • (String) —

    Timezone of the account as the offset from Coordinated Universal Time (UTC) in the format ‘UTC(+|-):[mm]`.




# File 'lib/basecrm/models/account.rb', line 15

#title ⇒ String

Returns The contact’s job title.

Returns:

  • (String) —

    The contact’s job title.




# File 'lib/basecrm/models/lead.rb', line 18

#total_count ⇒ Integer (readonly)

Returns Total number of items in the queue to synchronize.

Returns:

  • (Integer) —

    Total number of items in the queue to synchronize.




# File 'lib/basecrm/models/sync_queue.rb', line 11

#twitter ⇒ String

Returns The contact’s Twitter handle.

Returns:

  • (String) —

    The contact’s Twitter handle.




# File 'lib/basecrm/models/lead.rb', line 18

#type ⇒ String (readonly)

Returns An entity type.

Returns:

  • (String) —

    An entity type.




# File 'lib/basecrm/models/meta.rb', line 3

#updated_at ⇒ DateTime (readonly)

Returns Date and time of the last update on the associated contact in UTC (ISO8601 format).

Returns:

  • (DateTime) —

    Date and time of the last update on the associated contact in UTC (ISO8601 format).




# File 'lib/basecrm/models/tag.rb', line 5

#website ⇒ String

Returns The contact’s website address.

Returns:

  • (String) —

    The contact’s website address.




# File 'lib/basecrm/models/lead.rb', line 18