files.com 1.0.11 → 1.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b07ec4b973debbf46e8dc043ae9b6b02615eef937b9fe54cf9b044b0ef62b517
4
- data.tar.gz: 4e005659c1e11e12df9c1b1268a08fe880e29ad900fa8b7d021aa62572ac1820
3
+ metadata.gz: d97820f3dac19aba86e8641b84d2851ced9926a042845b935eb03ff1d3771132
4
+ data.tar.gz: fa438d71ad50da4c428a0cc10e32533f82848508eb9995bd70f98ce3934c3cb6
5
5
  SHA512:
6
- metadata.gz: 4043ea2df1f37f0ea582d37387d8557c78826ca12176ff50ed06fcba187424d6e4245a24b6a8088f5eb50fd6baad1edd528466954f3c5d4c312eb87a48bc9166
7
- data.tar.gz: b8c03c581111b4ba081f276db0889b98142e96dd82e8e5cc8a2c60c162375b31c1d55ba2c5601c479f10ac00d24ea89931c18eca41dd01fada95e710ea72c03b
6
+ metadata.gz: 1a84b3d8f22dae967eb217f2abe0d93d63bc9c830b5870dda30b7445cb82a10e9f6798e65a28ccd7d38e1584a3a8be30735927de501d49be0d49422acb2748ad
7
+ data.tar.gz: ca4227eff35790cfafc9e74ec5d7d1f9bf45b178c2daf6e808385e5ddd54823db0a08e204f25c715f5a637717fc943fb36ba3180194612da45477df3358d963d
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.11
1
+ 1.0.12
@@ -7,6 +7,7 @@
7
7
  "id": 1,
8
8
  "subject": "",
9
9
  "comment": "",
10
+ "created_at": "",
10
11
  "customer_success_access": "`no`",
11
12
  "priority": "`low`"
12
13
  }
@@ -15,31 +16,83 @@
15
16
  * `id` (int64): ID
16
17
  * `subject` (string): Subject of the support request.
17
18
  * `comment` (string): Main body of the support request.
19
+ * `created_at` (date): When this support request was made.
18
20
  * `customer_success_access` (string): Enable Customer Success access to your user account?
19
21
  * `priority` (string): Priority. Can be `low` (e.g. general or billing/acount questions), `normal` (e.g. the system is impaired), `high` (e.g. a production workflow or business process is impaired), `urgent` (e.g. a production workflow or business process is down), `critical` (e.g. a business-critical workflow or business process is down)
20
22
  * `email` (string): Email address of the user requesting support.
21
23
  * `attachments_files` (array(file)): Files to send to Customer Success along with this support request
22
24
 
23
25
 
26
+ ---
27
+
28
+ ## List Support Requests
29
+
30
+ ```
31
+ Files::SupportRequest.list(
32
+ page: 1,
33
+ per_page: 1
34
+ )
35
+ ```
36
+
37
+ ### Parameters
38
+
39
+ * `page` (int64): Current page number.
40
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
41
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
42
+
43
+
24
44
  ---
25
45
 
26
46
  ## Create Support Request
27
47
 
28
48
  ```
29
49
  Files::SupportRequest.create(
50
+ customer_success_access: "`no`",
30
51
  email: "email",
31
52
  subject: "subject",
32
53
  comment: "comment",
33
- customer_success_access: "`no`",
34
54
  priority: "`low`"
35
55
  )
36
56
  ```
37
57
 
38
58
  ### Parameters
39
59
 
60
+ * `customer_success_access` (string): Enable Customer Success access to your user account?
40
61
  * `email` (string): Required - Email address of the user requesting support.
41
62
  * `subject` (string): Required - Subject of the support request.
42
63
  * `comment` (string): Required - Main body of the support request.
43
- * `customer_success_access` (string): Enable Customer Success access to your user account?
44
64
  * `priority` (string): Priority. Can be `low` (e.g. general or billing/acount questions), `normal` (e.g. the system is impaired), `high` (e.g. a production workflow or business process is impaired), `urgent` (e.g. a production workflow or business process is down), `critical` (e.g. a business-critical workflow or business process is down)
45
65
  * `attachments_files` (array(file)): Files to send to Customer Success along with this support request
66
+
67
+
68
+ ---
69
+
70
+ ## Update Support Request
71
+
72
+ ```
73
+ Files::SupportRequest.update(id,
74
+ customer_success_access: "`no`"
75
+ )
76
+ ```
77
+
78
+ ### Parameters
79
+
80
+ * `id` (int64): Required - Support Request ID.
81
+ * `customer_success_access` (string): Enable Customer Success access to your user account?
82
+
83
+
84
+ ---
85
+
86
+ ## Update Support Request
87
+
88
+ ```
89
+ support_request = Files::SupportRequest.find(1)
90
+ support_request.update(
91
+ customer_success_access: "`no`"
92
+ )
93
+ ```
94
+
95
+ ### Parameters
96
+
97
+ * `id` (int64): Required - Support Request ID.
98
+ * `customer_success_access` (string): Enable Customer Success access to your user account?
@@ -36,6 +36,11 @@ module Files
36
36
  @attributes[:comment] = value
37
37
  end
38
38
 
39
+ # date - When this support request was made.
40
+ def created_at
41
+ @attributes[:created_at]
42
+ end
43
+
39
44
  # string - Enable Customer Success access to your user account?
40
45
  def customer_success_access
41
46
  @attributes[:customer_success_access]
@@ -72,9 +77,22 @@ module Files
72
77
  @attributes[:attachments_files] = value
73
78
  end
74
79
 
80
+ # Parameters:
81
+ # customer_success_access - string - Enable Customer Success access to your user account?
82
+ def update(params = {})
83
+ params ||= {}
84
+ params[:id] = @attributes[:id]
85
+ raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
86
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
87
+ raise InvalidParameterError.new("Bad parameter: customer_success_access must be an String") if params.dig(:customer_success_access) and !params.dig(:customer_success_access).is_a?(String)
88
+ raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
89
+
90
+ Api.send_request("/support_requests/#{@attributes[:id]}", :patch, params, @options)
91
+ end
92
+
75
93
  def save
76
94
  if @attributes[:id]
77
- raise NotImplementedError.new("The SupportRequest object doesn't support updates.")
95
+ update(@attributes)
78
96
  else
79
97
  new_obj = SupportRequest.create(@attributes, @options)
80
98
  @attributes = new_obj.attributes
@@ -82,17 +100,34 @@ module Files
82
100
  end
83
101
 
84
102
  # Parameters:
103
+ # page - integer - Current page number.
104
+ # per_page - integer - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
105
+ # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
106
+ def self.list(params = {}, options = {})
107
+ raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
108
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
109
+ raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
110
+
111
+ response, options = Api.send_request("/support_requests", :get, params, options)
112
+ response.data.map { |object| SupportRequest.new(object, options) }
113
+ end
114
+
115
+ def self.all(params = {}, options = {})
116
+ list(params, options)
117
+ end
118
+
119
+ # Parameters:
120
+ # customer_success_access - string - Enable Customer Success access to your user account?
85
121
  # email (required) - string - Email address of the user requesting support.
86
122
  # subject (required) - string - Subject of the support request.
87
123
  # comment (required) - string - Main body of the support request.
88
- # customer_success_access - string - Enable Customer Success access to your user account?
89
124
  # priority - string - Priority. Can be `low` (e.g. general or billing/acount questions), `normal` (e.g. the system is impaired), `high` (e.g. a production workflow or business process is impaired), `urgent` (e.g. a production workflow or business process is down), `critical` (e.g. a business-critical workflow or business process is down)
90
125
  # attachments_files - array - Files to send to Customer Success along with this support request
91
126
  def self.create(params = {}, options = {})
127
+ raise InvalidParameterError.new("Bad parameter: customer_success_access must be an String") if params.dig(:customer_success_access) and !params.dig(:customer_success_access).is_a?(String)
92
128
  raise InvalidParameterError.new("Bad parameter: email must be an String") if params.dig(:email) and !params.dig(:email).is_a?(String)
93
129
  raise InvalidParameterError.new("Bad parameter: subject must be an String") if params.dig(:subject) and !params.dig(:subject).is_a?(String)
94
130
  raise InvalidParameterError.new("Bad parameter: comment must be an String") if params.dig(:comment) and !params.dig(:comment).is_a?(String)
95
- raise InvalidParameterError.new("Bad parameter: customer_success_access must be an String") if params.dig(:customer_success_access) and !params.dig(:customer_success_access).is_a?(String)
96
131
  raise InvalidParameterError.new("Bad parameter: priority must be an String") if params.dig(:priority) and !params.dig(:priority).is_a?(String)
97
132
  raise InvalidParameterError.new("Bad parameter: attachments_files must be an Array") if params.dig(:attachments_files) and !params.dig(:attachments_files).is_a?(Array)
98
133
  raise MissingParameterError.new("Parameter missing: email") unless params.dig(:email)
@@ -102,5 +137,18 @@ module Files
102
137
  response, options = Api.send_request("/support_requests", :post, params, options)
103
138
  SupportRequest.new(response.data, options)
104
139
  end
140
+
141
+ # Parameters:
142
+ # customer_success_access - string - Enable Customer Success access to your user account?
143
+ def self.update(id, params = {}, options = {})
144
+ params ||= {}
145
+ params[:id] = id
146
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
147
+ raise InvalidParameterError.new("Bad parameter: customer_success_access must be an String") if params.dig(:customer_success_access) and !params.dig(:customer_success_access).is_a?(String)
148
+ raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
149
+
150
+ response, options = Api.send_request("/support_requests/#{params[:id]}", :patch, params, options)
151
+ SupportRequest.new(response.data, options)
152
+ end
105
153
  end
106
154
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: files.com
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.11
4
+ version: 1.0.12
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-01-10 00:00:00.000000000 Z
11
+ date: 2020-01-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday