Class: Files::UserRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/user_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ UserRequest

Returns a new instance of UserRequest.



7
8
9
10
 
# File 'lib/files.com/models/user_request.rb', line 7

def initialize(attributes = {}, options = {})
  @attributes = attributes || {}
  @options = options || {}
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



5
6
7
 
# File 'lib/files.com/models/user_request.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/files.com/models/user_request.rb', line 5

def options
  @options
end

Class Method Details

.all(params = {}, options = {}) ⇒ Object 



86
87
88
 
# File 'lib/files.com/models/user_request.rb', line 86

def self.all(params = {}, options = {})
  list(params, options)
end

.create(params = {}, options = {}) ⇒ Object

Parameters:

name (required) - string - Name of user requested
email (required) - string - Email of user requested
details (required) - string - Details of the user request

Raises:



110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/files.com/models/user_request.rb', line 110

def self.create(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: email must be an String") if params.dig(:email) and !params.dig(:email).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: details must be an String") if params.dig(:details) and !params.dig(:details).is_a?(String)
  raise MissingParameterError.new("Parameter missing: name") unless params.dig(:name)
  raise MissingParameterError.new("Parameter missing: email") unless params.dig(:email)
  raise MissingParameterError.new("Parameter missing: details") unless params.dig(:details)

  response, options = Api.send_request("/user_requests", :post, params, options)
  UserRequest.new(response.data, options)
end

.delete(id, params = {}, options = {}) ⇒ Object

Raises:



122
123
124
125
126
127
128
129
130
 
# File 'lib/files.com/models/user_request.rb', line 122

def self.delete(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)

  response, _options = Api.send_request("/user_requests/#{params[:id]}", :delete, params, options)
  response.data
end

.destroy(id, params = {}, options = {}) ⇒ Object 



132
133
134
 
# File 'lib/files.com/models/user_request.rb', line 132

def self.destroy(id, params = {}, options = {})
  delete(id, params, options)
end

.find(id, params = {}, options = {}) ⇒ Object

Parameters:

id (required) - int64 - User Request ID.

Raises:



92
93
94
95
96
97
98
99
100
 
# File 'lib/files.com/models/user_request.rb', line 92

def self.find(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)

  response, options = Api.send_request("/user_requests/#{params[:id]}", :get, params, options)
  UserRequest.new(response.data, options)
end

.get(id, params = {}, options = {}) ⇒ Object 



102
103
104
 
# File 'lib/files.com/models/user_request.rb', line 102

def self.get(id, params = {}, options = {})
  find(id, params, options)
end

.list(params = {}, options = {}) ⇒ Object

Parameters:

page - int64 - Current page number.
per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.

Raises:



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/files.com/models/user_request.rb', line 75

def self.list(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)

  response, options = Api.send_request("/user_requests", :get, params, options)
  response.data.map do |entity_data|
    UserRequest.new(entity_data, options)
  end
end

Instance Method Details

#delete(params = {}) ⇒ Object

Raises:



48
49
50
51
52
53
54
55
56
 
# File 'lib/files.com/models/user_request.rb', line 48

def delete(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)

  Api.send_request("/user_requests/#{@attributes[:id]}", :delete, params, @options)
end

#destroy(params = {}) ⇒ Object 



58
59
60
 
# File 'lib/files.com/models/user_request.rb', line 58

def destroy(params = {})
  delete(params)
end

#details ⇒ Object

string - Details of the user’s request



40
41
42
 
# File 'lib/files.com/models/user_request.rb', line 40

def details
  @attributes[:details]
end

#details=(value) ⇒ Object 



44
45
46
 
# File 'lib/files.com/models/user_request.rb', line 44

def details=(value)
  @attributes[:details] = value
end

#email ⇒ Object

email - User email address



31
32
33
 
# File 'lib/files.com/models/user_request.rb', line 31

def email
  @attributes[:email]
end

#email=(value) ⇒ Object 



35
36
37
 
# File 'lib/files.com/models/user_request.rb', line 35

def email=(value)
  @attributes[:email] = value
end

#id ⇒ Object

int64 - ID



13
14
15
 
# File 'lib/files.com/models/user_request.rb', line 13

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



17
18
19
 
# File 'lib/files.com/models/user_request.rb', line 17

def id=(value)
  @attributes[:id] = value
end

#name ⇒ Object

string - User’s full name



22
23
24
 
# File 'lib/files.com/models/user_request.rb', line 22

def name
  @attributes[:name]
end

#name=(value) ⇒ Object 



26
27
28
 
# File 'lib/files.com/models/user_request.rb', line 26

def name=(value)
  @attributes[:name] = value
end

#save ⇒ Object 



62
63
64
65
66
67
68
69
 
# File 'lib/files.com/models/user_request.rb', line 62

def save
  if @attributes[:id]
    raise NotImplementedError.new("The UserRequest object doesn't support updates.")
  else
    new_obj = UserRequest.create(@attributes, @options)
    @attributes = new_obj.attributes
  end
end