Sha256: f4b234d59b64a8b927de69b098c76546c9ef0243418282d2f9d78cfbfd58947b

Contents?: true

Size: 1.89 KB

Versions: 19

Compression:

Stored size: 1.89 KB

Contents

module CreateSend
  # Represents a person and associated functionality.
  class Person < CreateSend
    attr_reader :client_id
    attr_reader :email_address

    def initialize(auth, client_id, email_address)
      @client_id = client_id
      @email_address = email_address
      super
    end

    # Gets a person by client ID and email address.
    def self.get(auth, client_id, email_address)
      options = { :query => { :email => email_address } }
      cs = CreateSend.new auth
      response = cs.get "/clients/#{client_id}/people.json", options
      Hashie::Mash.new(response)
    end

    # Adds a person to the client. Password is optional. If ommitted, an
    # email invitation will be sent to the person
    def self.add(auth, client_id, email_address, name, access_level, password)
      options = { :body => {
        :EmailAddress => email_address,
        :Name => name,
        :AccessLevel => access_level,
        :Password => password }.to_json }
      cs = CreateSend.new auth
      response = cs.post "/clients/#{client_id}/people.json", options
      Hashie::Mash.new(response)
    end

    # Updates the person details. password is optional and will only be
    # updated if supplied
    def update(new_email_address, name, access_level, password)
      options = {
        :query => { :email => @email_address },
        :body => {
          :EmailAddress => new_email_address,
          :Name => name,
          :AccessLevel => access_level,
          :Password => password }.to_json }
      put uri_for(client_id), options
      # Update @email_address, so this object can continue to be used reliably
      @email_address = new_email_address
    end

    # deletes this person from the client
    def delete
      options = { :query => { :email => @email_address } }
      super uri_for(client_id), options
    end

    def uri_for(client_id)
      "/clients/#{client_id}/people.json"
    end
  end
end

Version data entries

19 entries across 19 versions & 2 rubygems

Version Path
createsend-6.1.1 lib/createsend/person.rb
createsend-sendowlfork-6.1.0.pre.hashie5 lib/createsend/person.rb
createsend-6.1.0 lib/createsend/person.rb
createsend-6.0.0 lib/createsend/person.rb
createsend-5.1.1 lib/createsend/person.rb
createsend-5.1.0 lib/createsend/person.rb
createsend-5.0.0 lib/createsend/person.rb
createsend-4.1.2 lib/createsend/person.rb
createsend-4.1.1 lib/createsend/person.rb
createsend-4.1.0 lib/createsend/person.rb
createsend-4.0.2 lib/createsend/person.rb
createsend-4.0.1 lib/createsend/person.rb
createsend-4.0.0 lib/createsend/person.rb
createsend-3.4.0 lib/createsend/person.rb
createsend-3.3.0 lib/createsend/person.rb
createsend-3.2.0 lib/createsend/person.rb
createsend-3.1.1 lib/createsend/person.rb
createsend-3.1.0 lib/createsend/person.rb
createsend-3.0.0 lib/createsend/person.rb