Class: Paperdrive::Client

Inherits:
Object
  • Object
show all
Includes:
Activities, ActivityFields, ActivityTypes, Currencies, DealFields, Deals, Filters, GlobalMessages, MailMessages, MailThreads, NoteFields, Notes, OrganizationFields, OrganizationRelationships, Organizations, PermissionSets, PersonFields, Persons, Pipelines, ProductFields, Products, Recents, Roles, SearchResults, Stages, UserConnections, UserSettings, Users, Webhooks
Defined in:
lib/paperdrive/client.rb,
lib/paperdrive/client/deals.rb,
lib/paperdrive/client/notes.rb,
lib/paperdrive/client/roles.rb,
lib/paperdrive/client/users.rb,
lib/paperdrive/client/stages.rb,
lib/paperdrive/client/filters.rb,
lib/paperdrive/client/persons.rb,
lib/paperdrive/client/recents.rb,
lib/paperdrive/client/products.rb,
lib/paperdrive/client/webhooks.rb,
lib/paperdrive/client/pipelines.rb,
lib/paperdrive/client/activities.rb,
lib/paperdrive/client/currencies.rb,
lib/paperdrive/client/deal_fields.rb,
lib/paperdrive/client/note_fields.rb,
lib/paperdrive/client/mail_threads.rb,
lib/paperdrive/client/mail_messages.rb,
lib/paperdrive/client/organizations.rb,
lib/paperdrive/client/person_fields.rb,
lib/paperdrive/client/user_settings.rb,
lib/paperdrive/client/activity_types.rb,
lib/paperdrive/client/product_fields.rb,
lib/paperdrive/client/search_results.rb,
lib/paperdrive/client/activity_fields.rb,
lib/paperdrive/client/global_messages.rb,
lib/paperdrive/client/permission_sets.rb,
lib/paperdrive/client/user_connections.rb,
lib/paperdrive/client/organization_fields.rb,
lib/paperdrive/client/organization_relationships.rb

Overview

Client to aceess API

Defined Under Namespace

Modules: Activities, ActivityFields, ActivityTypes, Currencies, DealFields, Deals, Filters, GlobalMessages, MailMessages, MailThreads, NoteFields, Notes, OrganizationFields, OrganizationRelationships, Organizations, PermissionSets, PersonFields, Persons, Pipelines, ProductFields, Products, Recents, Roles, SearchResults, Stages, UserConnections, UserSettings, Users, Webhooks

Constant Summary collapse

API_BASEURL = 
'https://api.pipedrive.com/v1'

Instance Method Summary collapse

Methods included from Webhooks

#all_webhooks, #create_webhook, #delete_webhook

Methods included from UserSettings

#current_user_settings

Methods included from UserConnections

#all_user_connections

Methods included from Users

#all_users, #create_user, #create_user_blacklisted_email, #create_user_permission_set_assignment, #create_user_role_assignment, #current_user, #delete_user_permission_set_assignment, #delete_user_role_assignment, #find_users_by_name, #update_user, #user, #user_activities, #user_blacklisted_emails, #user_followers, #user_permission_set_assignments, #user_permissions, #user_role_assignments, #user_role_settings

Methods included from Stages

#all_stages, #create_stage, #delete_stage, #delete_stages, #stage, #stage_deals, #update_stage

Methods included from SearchResults

#search, #specific_search

Methods included from Roles

#all_roles, #create_or_update_role_setting, #create_role, #create_role_assignment, #delete_role, #delete_role_assignment, #role, #role_assignments, #role_settings, #role_sub_roles, #update_role_details

Methods included from Recents

#recents

Methods included from Products

#all_products, #create_product, #create_product_follower, #delete_product, #delete_product_follower, #find_products_by_name, #product, #product_deals, #product_files, #product_followers, #product_permitted_users, #update_product

Methods included from ProductFields

#all_product_fields, #create_product_field, #delete_product_field, #delete_product_fields, #product_field, #update_product_field

Methods included from Pipelines

#all_pipelines, #create_pipeline, #delete_pipeline, #pipeline, #pipeline_deals, #pipeline_deals_cvr, #pipeline_deals_movements, #update_pipeline

Methods included from PersonFields

#all_person_fields, #create_person_field, #delete_person_field, #delete_person_fields, #person_field, #update_person_field

Methods included from Persons

#all_persons, #create_person, #create_person_follower, #delete_person, #delete_person_follower, #delete_person_picture, #delete_persons, #find_persons_by_name, #merge_persons, #person, #person_activities, #person_deals, #person_files, #person_followers, #person_mail_messages, #person_permitted_users, #person_products, #person_updates, #update_person

Methods included from PermissionSets

#all_permission_set_assignments, #all_permission_sets, #create_permission_set_assignment, #delete_permission_set_assignment, #permission_set, #update_permission_set

Methods included from OrganizationRelationships

#all_organization_relationships, #create_organization_relationship, #delete_organization_relationship, #organization_relationship, #update_organization_relationship

Methods included from OrganizationFields

#all_organization_fields, #create_organization_field, #delete_organization_field, #delete_organization_fields, #organization_field, #update_organization_field

Methods included from Organizations

#add_follower_to_organization, #all_organizations, #create_organization, #delete_organization, #delete_organization_follower, #delete_organizations, #find_organizations_by_name, #merge_organizations, #organization_activities, #organization_deals, #organization_detail, #organization_files, #organization_followers, #organization_mail_messages, #organization_permitted_users, #organization_persons, #organization_updates, #update_organization

Methods included from NoteFields

#all_note_fields

Methods included from Notes

#all_notes, #create_note, #delete_note, #edit_note, #note_detail

Methods included from MailThreads

#all_mail_threads, #delete_mail_thread, #mail_thread, #mail_thread_mail_messages, #update_mail_thread

Methods included from MailMessages

#mail_message

Methods included from GlobalMessages

#all_global_messages, #delete_global_message

Methods included from Filters

#all_filters, #create_filter, #delete_filter, #delete_filters, #filter, #update_filter

Methods included from DealFields

#all_deal_fields, #create_deal_field, #deal_field, #delete_deal_field, #delete_deal_fields, #update_deal_field

Methods included from Deals

#add_follower_to_deal, #add_participant_to_deal, #add_product_to_deal, #all_deals, #create_deal, #deal_activities, #deal_detail, #deal_files, #deal_followers, #deal_mail_messages, #deal_participants, #deal_permitted_users, #deal_persons, #deal_products, #deal_updates, #deals_timeline, #delete_deal, #delete_deal_follower, #delete_deal_participants, #delete_deal_product, #delete_deals, #duplicate_deal, #find_deals_by_name, #merge_deals, #update_deal, #update_deal_product

Methods included from Currencies

#all_currencies

Methods included from ActivityTypes

#all_activity_types, #create_activity_type, #delete_activitiy_types, #delete_activity_type, #edit_activity_type

Methods included from ActivityFields

#all_activities

Methods included from Activities

#activity_detail, #all_activities, #create_activity, #delete_activities, #delete_activity, #edit_activity

Constructor Details

#initialize(token: nil) ⇒ Paperdrive::Client

build instances by
using arguments: pass the token as ‘token:`
or using environment variables: set the token to ENV

Parameters:

  • token: (String) (defaults to: nil) —

    Paperdrive API access token

Raises:



81
82
83
84
85
86
 
# File 'lib/paperdrive/client.rb', line 81

def initialize(token: nil)
  token ||= ENV['PAPERDRIVE_TOKEN']
  raise Paperdrive::AuthTokenNotSpecified unless token || token.is_a?(String)

  @token = token
end

Instance Method Details

#inspect ⇒ String

masking tokens to prevent casually displaying tokens

Returns:

  • (String) —

    inspected and token masked string



91
92
93
94
 
# File 'lib/paperdrive/client.rb', line 91

def inspect
  inspected = super
  inspected.gsub!(@token, 'MASKED_TOKEN') if @token
end