Class: Files::PartnerSiteRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of PartnerSiteRequest.



7
8
9
10
 
# File 'lib/files.com/models/partner_site_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/partner_site_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/partner_site_request.rb', line 5

def options
  @options
end

Class Method Details

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



145
146
147
 
# File 'lib/files.com/models/partner_site_request.rb', line 145

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

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

Approve partner site request

Raises:



184
185
186
187
188
189
190
191
192
 
# File 'lib/files.com/models/partner_site_request.rb', line 184

def self.approve(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("/partner_site_requests/#{params[:id]}/approve", :post, params, options)
  nil
end

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

Parameters:

partner_id (required) - int64 - Partner ID to link with
site_url (required) - string - Site URL to link to

Raises:



162
163
164
165
166
167
168
169
170
 
# File 'lib/files.com/models/partner_site_request.rb', line 162

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

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

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

Raises:



194
195
196
197
198
199
200
201
202
 
# File 'lib/files.com/models/partner_site_request.rb', line 194

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("/partner_site_requests/#{params[:id]}", :delete, params, options)
  nil
end

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



204
205
206
207
 
# File 'lib/files.com/models/partner_site_request.rb', line 204

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

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

Parameters:

pairing_key (required) - string - Pairing key for the partner site request

Raises:



151
152
153
154
155
156
157
 
# File 'lib/files.com/models/partner_site_request.rb', line 151

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

  Api.send_request("/partner_site_requests/find_by_pairing_key", :get, params, options)
  nil
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:



136
137
138
139
140
141
142
143
 
# File 'lib/files.com/models/partner_site_request.rb', line 136

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(PartnerSiteRequest, params) do
    Api.send_request("/partner_site_requests", :get, params, options)
  end
end

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

Reject partner site request

Raises:



173
174
175
176
177
178
179
180
181
 
# File 'lib/files.com/models/partner_site_request.rb', line 173

def self.reject(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("/partner_site_requests/#{params[:id]}/reject", :post, params, options)
  nil
end

Instance Method Details

#approve(params = {}) ⇒ Object

Approve partner site request

Raises:



97
98
99
100
101
102
103
104
105
 
# File 'lib/files.com/models/partner_site_request.rb', line 97

def approve(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("/partner_site_requests/#{@attributes[:id]}/approve", :post, params, @options)
end

#created_at ⇒ Object

date-time - Request creation date/time



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

def created_at
  @attributes[:created_at]
end

#delete(params = {}) ⇒ Object

Raises:



107
108
109
110
111
112
113
114
115
 
# File 'lib/files.com/models/partner_site_request.rb', line 107

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("/partner_site_requests/#{@attributes[:id]}", :delete, params, @options)
end

#destroy(params = {}) ⇒ Object 



117
118
119
120
 
# File 'lib/files.com/models/partner_site_request.rb', line 117

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

#id ⇒ Object

int64 - Partner Site Request ID



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

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



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

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

#linked_site_id ⇒ Object

int64 - Linked Site ID



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

def linked_site_id
  @attributes[:linked_site_id]
end

#linked_site_id=(value) ⇒ Object 



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

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

#main_site_name ⇒ Object

string - Main Site Name



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

def main_site_name
  @attributes[:main_site_name]
end

#main_site_name=(value) ⇒ Object 



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

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

#pairing_key ⇒ Object

string - Pairing key used to approve this request on the target site



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

def pairing_key
  @attributes[:pairing_key]
end

#pairing_key=(value) ⇒ Object 



62
63
64
 
# File 'lib/files.com/models/partner_site_request.rb', line 62

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

#partner_id ⇒ Object

int64 - Partner ID



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

def partner_id
  @attributes[:partner_id]
end

#partner_id=(value) ⇒ Object 



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

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

#reject(params = {}) ⇒ Object

Reject partner site request

Raises:



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

def reject(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("/partner_site_requests/#{@attributes[:id]}/reject", :post, params, @options)
end

#save ⇒ Object 



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

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

  @attributes = new_obj.attributes
  true
end

#site_url ⇒ Object

string - Site URL to link to



77
78
79
 
# File 'lib/files.com/models/partner_site_request.rb', line 77

def site_url
  @attributes[:site_url]
end

#site_url=(value) ⇒ Object 



81
82
83
 
# File 'lib/files.com/models/partner_site_request.rb', line 81

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

#status ⇒ Object

string - Request status (pending, approved, rejected)



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

def status
  @attributes[:status]
end

#status=(value) ⇒ Object 



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

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

#updated_at ⇒ Object

date-time - Request last updated date/time



72
73
74
 
# File 'lib/files.com/models/partner_site_request.rb', line 72

def updated_at
  @attributes[:updated_at]
end