Class: Merge::Filestorage::Permission

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/filestorage/types/permission.rb

Overview

# The Permission Object

### Description
The Permission object is used to represent a user's or group's access to a File
or Folder. Permissions are unexpanded by default.
### Usage Example
Fetch from the `GET Files` or `GET Folders` endpoint. Permissions are unexpanded
by default. Use the query param `expand=permissions` to see more details.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, user: OMIT, group: OMIT, type: OMIT, roles: OMIT, additional_properties: nil) ⇒ Merge::Filestorage::Permission

Parameters:

  • id (String) (defaults to: OMIT)
  • remote_id (String) (defaults to: OMIT) —

    The third-party API ID of the matching object.

  • created_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was created by Merge.

  • modified_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was modified by Merge.

  • user (Merge::Filestorage::PermissionUser) (defaults to: OMIT) —

    The user that is granted this permission. This will only be populated if the type is ‘USER`.

  • group (Merge::Filestorage::PermissionGroup) (defaults to: OMIT) —

    The group that is granted this permission. This will only be populated if the type is ‘GROUP`.

  • type (Merge::Filestorage::TypeEnum) (defaults to: OMIT) —

    Denotes what type of people have access to the file.

    • ‘USER` - USER

    • ‘GROUP` - GROUP

    • ‘COMPANY` - COMPANY

    • ‘ANYONE` - ANYONE

  • roles (Array<Merge::Filestorage::RolesEnum>) (defaults to: OMIT) —

    The permissions that the user or group has for the File or Folder. It is possible for a user or group to have multiple roles, such as viewing & uploading. Possible values include: ‘READ`, `WRITE`, `OWNER`. In cases where there is no clear mapping, the original value passed through will be returned.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/merge_ruby_client/filestorage/types/permission.rb', line 73

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, user: OMIT, group: OMIT,
               type: OMIT, roles: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @remote_id = remote_id if remote_id != OMIT
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @user = user if user != OMIT
  @group = group if group != OMIT
  @type = type if type != OMIT
  @roles = roles if roles != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "user": user,
    "group": group,
    "type": type,
    "roles": roles
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



47
48
49
 
# File 'lib/merge_ruby_client/filestorage/types/permission.rb', line 47

def additional_properties
  @additional_properties
end

#created_at ⇒ DateTime (readonly)

Returns The datetime that this object was created by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was created by Merge.



26
27
28
 
# File 'lib/merge_ruby_client/filestorage/types/permission.rb', line 26

def created_at
  @created_at
end

#group ⇒ Merge::Filestorage::PermissionGroup (readonly)

Returns The group that is granted this permission. This will only be populated if the type is ‘GROUP`.

Returns:



34
35
36
 
# File 'lib/merge_ruby_client/filestorage/types/permission.rb', line 34

def group
  @group
end

#id ⇒ String (readonly)

Returns:

  • (String) 


22
23
24
 
# File 'lib/merge_ruby_client/filestorage/types/permission.rb', line 22

def id
  @id
end

#modified_at ⇒ DateTime (readonly)

Returns The datetime that this object was modified by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was modified by Merge.



28
29
30
 
# File 'lib/merge_ruby_client/filestorage/types/permission.rb', line 28

def modified_at
  @modified_at
end

#remote_id ⇒ String (readonly)

Returns The third-party API ID of the matching object.

Returns:

  • (String) —

    The third-party API ID of the matching object.



24
25
26
 
# File 'lib/merge_ruby_client/filestorage/types/permission.rb', line 24

def remote_id
  @remote_id
end

#roles ⇒ Array<Merge::Filestorage::RolesEnum> (readonly)

Returns The permissions that the user or group has for the File or Folder. It is possible for a user or group to have multiple roles, such as viewing & uploading. Possible values include: ‘READ`, `WRITE`, `OWNER`. In cases where there is no clear mapping, the original value passed through will be returned.

Returns:

  • (Array<Merge::Filestorage::RolesEnum>) —

    The permissions that the user or group has for the File or Folder. It is possible for a user or group to have multiple roles, such as viewing & uploading. Possible values include: ‘READ`, `WRITE`, `OWNER`. In cases where there is no clear mapping, the original value passed through will be returned.



45
46
47
 
# File 'lib/merge_ruby_client/filestorage/types/permission.rb', line 45

def roles
  @roles
end

#type ⇒ Merge::Filestorage::TypeEnum (readonly)

Returns Denotes what type of people have access to the file.

  • ‘USER` - USER

  • ‘GROUP` - GROUP

  • ‘COMPANY` - COMPANY

  • ‘ANYONE` - ANYONE.

Returns:

  • (Merge::Filestorage::TypeEnum) —

    Denotes what type of people have access to the file.

    • ‘USER` - USER

    • ‘GROUP` - GROUP

    • ‘COMPANY` - COMPANY

    • ‘ANYONE` - ANYONE



40
41
42
 
# File 'lib/merge_ruby_client/filestorage/types/permission.rb', line 40

def type
  @type
end

#user ⇒ Merge::Filestorage::PermissionUser (readonly)

Returns The user that is granted this permission. This will only be populated if the type is ‘USER`.

Returns:



31
32
33
 
# File 'lib/merge_ruby_client/filestorage/types/permission.rb', line 31

def user
  @user
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Filestorage::Permission

Deserialize a JSON object to an instance of Permission

Parameters:

  • json_object (String)

Returns:



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/merge_ruby_client/filestorage/types/permission.rb', line 102

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  remote_id = parsed_json["remote_id"]
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
  if parsed_json["user"].nil?
    user = nil
  else
    user = parsed_json["user"].to_json
    user = Merge::Filestorage::PermissionUser.from_json(json_object: user)
  end
  if parsed_json["group"].nil?
    group = nil
  else
    group = parsed_json["group"].to_json
    group = Merge::Filestorage::PermissionGroup.from_json(json_object: group)
  end
  type = parsed_json["type"]
  roles = parsed_json["roles"]
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    user: user,
    group: group,
    type: type,
    roles: roles,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


149
150
151
152
153
154
155
156
157
158
 
# File 'lib/merge_ruby_client/filestorage/types/permission.rb', line 149

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
  obj.user.nil? || Merge::Filestorage::PermissionUser.validate_raw(obj: obj.user)
  obj.group.nil? || Merge::Filestorage::PermissionGroup.validate_raw(obj: obj.group)
  obj.type&.is_a?(Merge::Filestorage::TypeEnum) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
  obj.roles&.is_a?(Array) != false || raise("Passed value for field obj.roles is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of Permission to a JSON object

Returns:

  • (String) 


139
140
141
 
# File 'lib/merge_ruby_client/filestorage/types/permission.rb', line 139

def to_json(*_args)
  @_field_set&.to_json
end