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 



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

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

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

Parameters:

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

Raises:



157
158
159
160
161
162
163
 
# File 'lib/files.com/models/partner_site_request.rb', line 157

def self.approve(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/approve", :post, params, options)
  nil
end

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

Parameters:

host_partner_id (required) - int64 - Host Partner ID to link with
guest_site_url (required) - string - Guest Site URL to link to

Raises:



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

def self.create(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: host_partner_id must be an Integer") if params[:host_partner_id] and !params[:host_partner_id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: guest_site_url must be an String") if params[:guest_site_url] and !params[:guest_site_url].is_a?(String)
  raise MissingParameterError.new("Parameter missing: host_partner_id") unless params[:host_partner_id]
  raise MissingParameterError.new("Parameter missing: guest_site_url") unless params[:guest_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:



165
166
167
168
169
170
171
172
173
 
# File 'lib/files.com/models/partner_site_request.rb', line 165

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 



175
176
177
178
 
# File 'lib/files.com/models/partner_site_request.rb', line 175

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:



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

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: 10000, 1,000 or less is recommended).
sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `host_partner_id`.
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `host_partner_id`.

Raises:



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

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)
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)

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

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

Parameters:

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

Raises:



147
148
149
150
151
152
153
 
# File 'lib/files.com/models/partner_site_request.rb', line 147

def self.reject(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/reject", :post, params, options)
  nil
end

Instance Method Details

#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:



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

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 



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

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

#guest_site_url ⇒ Object

string - Guest Site URL



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

def guest_site_url
  @attributes[:guest_site_url]
end

#guest_site_url=(value) ⇒ Object 



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

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

#host_partner_id ⇒ Object

int64 - Host Partner ID



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

def host_partner_id
  @attributes[:host_partner_id]
end

#host_partner_id=(value) ⇒ Object 



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

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

#host_site_name ⇒ Object

string - Host Site Name



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

def host_site_name
  @attributes[:host_site_name]
end

#host_site_name=(value) ⇒ Object 



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

def host_site_name=(value)
  @attributes[:host_site_name] = value
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

#pairing_key ⇒ Object

string - Pairing key used to approve this request on the Guest 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

#save ⇒ Object 



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

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

#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