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 



95
96
97
 
# File 'lib/files.com/models/user_request.rb', line 95

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
company - string - Company of the user requested

Raises:



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

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

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

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

Raises:



133
134
135
136
137
138
139
140
141
 
# File 'lib/files.com/models/user_request.rb', line 133

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

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

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



143
144
145
146
 
# File 'lib/files.com/models/user_request.rb', line 143

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

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

Parameters:

id (required) - int64 - User Request ID.

Raises:



101
102
103
104
105
106
107
108
109
 
# File 'lib/files.com/models/user_request.rb', line 101

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

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

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



111
112
113
 
# File 'lib/files.com/models/user_request.rb', line 111

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

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

Parameters:

cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).

Raises:



86
87
88
89
90
91
92
93
 
# File 'lib/files.com/models/user_request.rb', line 86

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

  List.new(UserRequest, params) do
    Api.send_request("/user_requests", :get, params, options)
  end
end

Instance Method Details

#company ⇒ Object

string - User’s company name



49
50
51
 
# File 'lib/files.com/models/user_request.rb', line 49

def company
  @attributes[:company]
end

#company=(value) ⇒ Object 



53
54
55
 
# File 'lib/files.com/models/user_request.rb', line 53

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

#delete(params = {}) ⇒ Object

Raises:



57
58
59
60
61
62
63
64
65
 
# File 'lib/files.com/models/user_request.rb', line 57

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[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

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

#destroy(params = {}) ⇒ Object 



67
68
69
70
 
# File 'lib/files.com/models/user_request.rb', line 67

def destroy(params = {})
  delete(params)
  nil
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 



72
73
74
75
76
77
78
79
80
81
 
# File 'lib/files.com/models/user_request.rb', line 72

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

  @attributes = new_obj.attributes
  true
end