Class: Seam::Clients::AccessCodes

Inherits:
BaseClient show all
Defined in:
lib/seam/clients/access_codes.rb

Instance Attribute Summary

Attributes inherited from BaseClient

#client

Instance Method Summary collapse

Methods inherited from BaseClient

#initialize, #request_seam, #request_seam_object

Constructor Details

This class inherits a constructor from Seam::Clients::BaseClient

Instance Method Details

#create(device_id:, allow_external_modification: nil, attempt_for_offline_device: nil, code: nil, common_code_key: nil, ends_at: nil, is_external_modification_allowed: nil, is_offline_access_code: nil, is_one_time_use: nil, max_time_rounding: nil, name: nil, prefer_native_scheduling: nil, starts_at: nil, sync: nil, use_backup_access_code_pool: nil, use_offline_access_code: nil) ⇒ Object 



14
15
16
17
18
19
20
21
22
 
# File 'lib/seam/clients/access_codes.rb', line 14

def create(device_id:, allow_external_modification: nil, attempt_for_offline_device: nil, code: nil, common_code_key: nil, ends_at: nil, is_external_modification_allowed: nil, is_offline_access_code: nil, is_one_time_use: nil, max_time_rounding: nil, name: nil, prefer_native_scheduling: nil, starts_at: nil, sync: nil, use_backup_access_code_pool: nil, use_offline_access_code: nil)
  request_seam_object(
    :post,
    "/access_codes/create",
    Seam::AccessCode,
    "access_code",
    body: {device_id: device_id, allow_external_modification: allow_external_modification, attempt_for_offline_device: attempt_for_offline_device, code: code, common_code_key: common_code_key, ends_at: ends_at, is_external_modification_allowed: is_external_modification_allowed, is_offline_access_code: is_offline_access_code, is_one_time_use: is_one_time_use, max_time_rounding: max_time_rounding, name: name, prefer_native_scheduling: prefer_native_scheduling, starts_at: starts_at, sync: sync, use_backup_access_code_pool: use_backup_access_code_pool, use_offline_access_code: use_offline_access_code}.compact
  )
end

#create_multiple(device_ids:, allow_external_modification: nil, attempt_for_offline_device: nil, behavior_when_code_cannot_be_shared: nil, code: nil, ends_at: nil, is_external_modification_allowed: nil, is_offline_access_code: nil, is_one_time_use: nil, max_time_rounding: nil, name: nil, prefer_native_scheduling: nil, preferred_code_length: nil, starts_at: nil, use_backup_access_code_pool: nil, use_offline_access_code: nil) ⇒ Object 



24
25
26
27
28
29
30
31
32
 
# File 'lib/seam/clients/access_codes.rb', line 24

def create_multiple(device_ids:, allow_external_modification: nil, attempt_for_offline_device: nil, behavior_when_code_cannot_be_shared: nil, code: nil, ends_at: nil, is_external_modification_allowed: nil, is_offline_access_code: nil, is_one_time_use: nil, max_time_rounding: nil, name: nil, prefer_native_scheduling: nil, preferred_code_length: nil, starts_at: nil, use_backup_access_code_pool: nil, use_offline_access_code: nil)
  request_seam_object(
    :post,
    "/access_codes/create_multiple",
    Seam::AccessCode,
    "access_codes",
    body: {device_ids: device_ids, allow_external_modification: allow_external_modification, attempt_for_offline_device: attempt_for_offline_device, behavior_when_code_cannot_be_shared: behavior_when_code_cannot_be_shared, code: code, ends_at: ends_at, is_external_modification_allowed: is_external_modification_allowed, is_offline_access_code: is_offline_access_code, is_one_time_use: is_one_time_use, max_time_rounding: max_time_rounding, name: name, prefer_native_scheduling: prefer_native_scheduling, preferred_code_length: preferred_code_length, starts_at: starts_at, use_backup_access_code_pool: use_backup_access_code_pool, use_offline_access_code: use_offline_access_code}.compact
  )
end

#delete(access_code_id:, device_id: nil, sync: nil) ⇒ Object 



34
35
36
37
38
39
40
41
42
 
# File 'lib/seam/clients/access_codes.rb', line 34

def delete(access_code_id:, device_id: nil, sync: nil)
  request_seam(
    :post,
    "/access_codes/delete",
    body: {access_code_id: access_code_id, device_id: device_id, sync: sync}.compact
  )

  nil
end

#generate_code(device_id:) ⇒ Object 



44
45
46
47
48
49
50
51
52
 
# File 'lib/seam/clients/access_codes.rb', line 44

def generate_code(device_id:)
  request_seam_object(
    :post,
    "/access_codes/generate_code",
    Seam::AccessCode,
    "generated_code",
    body: {device_id: device_id}.compact
  )
end

#get(access_code_id: nil, code: nil, device_id: nil) ⇒ Object 



54
55
56
57
58
59
60
61
62
 
# File 'lib/seam/clients/access_codes.rb', line 54

def get(access_code_id: nil, code: nil, device_id: nil)
  request_seam_object(
    :post,
    "/access_codes/get",
    Seam::AccessCode,
    "access_code",
    body: {access_code_id: access_code_id, code: code, device_id: device_id}.compact
  )
end

#list(access_code_ids: nil, device_id: nil, user_identifier_key: nil) ⇒ Object 



64
65
66
67
68
69
70
71
72
 
# File 'lib/seam/clients/access_codes.rb', line 64

def list(access_code_ids: nil, device_id: nil, user_identifier_key: nil)
  request_seam_object(
    :post,
    "/access_codes/list",
    Seam::AccessCode,
    "access_codes",
    body: {access_code_ids: access_code_ids, device_id: device_id, user_identifier_key: user_identifier_key}.compact
  )
end

#pull_backup_access_code(access_code_id:) ⇒ Object 



74
75
76
77
78
79
80
81
82
 
# File 'lib/seam/clients/access_codes.rb', line 74

def pull_backup_access_code(access_code_id:)
  request_seam_object(
    :post,
    "/access_codes/pull_backup_access_code",
    Seam::AccessCode,
    "backup_access_code",
    body: {access_code_id: access_code_id}.compact
  )
end

#simulate ⇒ Object 



6
7
8
 
# File 'lib/seam/clients/access_codes.rb', line 6

def simulate
  @simulate ||= Seam::Clients::AccessCodesSimulate.new(self)
end

#unmanaged ⇒ Object 



10
11
12
 
# File 'lib/seam/clients/access_codes.rb', line 10

def unmanaged
  @unmanaged ||= Seam::Clients::AccessCodesUnmanaged.new(self)
end

#update(access_code_id:, allow_external_modification: nil, attempt_for_offline_device: nil, code: nil, device_id: nil, ends_at: nil, is_external_modification_allowed: nil, is_managed: nil, is_offline_access_code: nil, is_one_time_use: nil, max_time_rounding: nil, name: nil, prefer_native_scheduling: nil, starts_at: nil, sync: nil, type: nil, use_backup_access_code_pool: nil, use_offline_access_code: nil) ⇒ Object 



84
85
86
87
88
89
90
91
92
 
# File 'lib/seam/clients/access_codes.rb', line 84

def update(access_code_id:, allow_external_modification: nil, attempt_for_offline_device: nil, code: nil, device_id: nil, ends_at: nil, is_external_modification_allowed: nil, is_managed: nil, is_offline_access_code: nil, is_one_time_use: nil, max_time_rounding: nil, name: nil, prefer_native_scheduling: nil, starts_at: nil, sync: nil, type: nil, use_backup_access_code_pool: nil, use_offline_access_code: nil)
  request_seam(
    :post,
    "/access_codes/update",
    body: {access_code_id: access_code_id, allow_external_modification: allow_external_modification, attempt_for_offline_device: attempt_for_offline_device, code: code, device_id: device_id, ends_at: ends_at, is_external_modification_allowed: is_external_modification_allowed, is_managed: is_managed, is_offline_access_code: is_offline_access_code, is_one_time_use: is_one_time_use, max_time_rounding: max_time_rounding, name: name, prefer_native_scheduling: prefer_native_scheduling, starts_at: starts_at, sync: sync, type: type, use_backup_access_code_pool: use_backup_access_code_pool, use_offline_access_code: use_offline_access_code}.compact
  )

  nil
end