Class: Zype::Pin

Inherits:
BaseModel show all
Defined in:
lib/zype/models/pin.rb

Overview

Read more at docs.zype.com/v1.0/reference#device-linking

Since:

  • 0.15.0

Constant Summary

Constants inherited from BaseModel

BaseModel::ACCEPTED_KEYS

Instance Attribute Summary

Attributes inherited from BaseModel

#client, #path

Instance Method Summary collapse

Methods inherited from BaseModel

#all, #auth=, #create, #delete, #find, #initialize, #update

Constructor Details

This class inherits a constructor from Zype::BaseModel

Instance Method Details

#acquire(linked_device_id:) ⇒ Hash

Create the device pin

Parameters:

  • linked_device_id (String)

Returns:

  • (Hash) —

    the device pin

Since:

  • 0.15.0



18
19
20
 
# File 'lib/zype/models/pin.rb', line 18

def acquire(linked_device_id:)
  client.execute(method: :post, path: '/pin/acquire', params: { linked_device_id: linked_device_id })
end

#link(consumer_id:, pin:) ⇒ Hash

Returns the consumer.

Returns:

  • (Hash) —

    the consumer

Since:

  • 0.15.0



24
25
26
 
# File 'lib/zype/models/pin.rb', line 24

def link(consumer_id:, pin:)
  client.execute(method: :put, path: '/pin/link', params: { consumer_id: consumer_id, pin: pin })
end

#status(linked_device_id:) ⇒ Hash

Retrieve the pin for the device

Parameters:

  • linked_device_id (String)

Returns:

  • (Hash) —

    the device pin

Since:

  • 0.15.0



10
11
12
 
# File 'lib/zype/models/pin.rb', line 10

def status(linked_device_id:)
  client.execute(method: :get, path: '/pin/status', params: { linked_device_id: linked_device_id })
end

#unlink(consumer_id:, pin:) ⇒ Hash

Returns the consumer.

Returns:

  • (Hash) —

    the consumer

Since:

  • 0.15.0



29
30
31
 
# File 'lib/zype/models/pin.rb', line 29

def unlink(consumer_id:, pin:)
  client.execute(method: :put, path: '/pin/unlink', params: { consumer_id: consumer_id, pin: pin })
end