zendesk_api 1.25.0 → 1.30.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +176 -0
- data/lib/zendesk_api/client.rb +5 -0
- data/lib/zendesk_api/configuration.rb +4 -0
- data/lib/zendesk_api/middleware/request/upload.rb +5 -2
- data/lib/zendesk_api/resources.rb +50 -0
- data/lib/zendesk_api/version.rb +1 -1
- metadata +10 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 793f89bec6ccc7c03d9fe870346da6f50dc0dd8cde3b46aca5b37cc6504adb3a
|
4
|
+
data.tar.gz: a03de27f833f3d9395bd44f574e70f8c3d9c6e10a06f4b89f71c2e393c0ea1a8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e4426a2dfad01605c661fbe4f71312e86bc444479dc4c293876273c5003169d32774e79b55e2f7c67b54a7cbb48ce0feb32887484f02f73da536c366dc8ac5c7
|
7
|
+
data.tar.gz: f561f3b726990c014aeaa095c21f6065063100bf033c3ce1fafaaa8fa062240dbe068960d9482cab632579e8890986e24db205bdcf40f1034468d94db37b7864
|
data/LICENSE
ADDED
@@ -0,0 +1,176 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
data/lib/zendesk_api/client.rb
CHANGED
@@ -40,6 +40,11 @@ module ZendeskAPI
|
|
40
40
|
method = method.to_s
|
41
41
|
options = args.last.is_a?(Hash) ? args.pop : {}
|
42
42
|
|
43
|
+
unless config.use_resource_cache
|
44
|
+
raise "Resource for #{method} does not exist" unless method_as_class(method)
|
45
|
+
return ZendeskAPI::Collection.new(self, method_as_class(method), options)
|
46
|
+
end
|
47
|
+
|
43
48
|
@resource_cache[method] ||= { :class => nil, :cache => ZendeskAPI::LRUCache.new }
|
44
49
|
if !options.delete(:reload) && (cached = @resource_cache[method][:cache].read(options.hash))
|
45
50
|
cached
|
@@ -42,8 +42,12 @@ module ZendeskAPI
|
|
42
42
|
# @return [ZendeskAPI::LRUCache]
|
43
43
|
attr_accessor :cache
|
44
44
|
|
45
|
+
# @return [Boolean] Whether to use resource_cache or not
|
46
|
+
attr_accessor :use_resource_cache
|
47
|
+
|
45
48
|
def initialize
|
46
49
|
@client_options = {}
|
50
|
+
@use_resource_cache = true
|
47
51
|
|
48
52
|
self.cache = ZendeskAPI::LRUCache.new(1000)
|
49
53
|
end
|
@@ -1,5 +1,5 @@
|
|
1
1
|
require "faraday/middleware"
|
2
|
-
require "
|
2
|
+
require "mini_mime"
|
3
3
|
require 'tempfile'
|
4
4
|
|
5
5
|
module ZendeskAPI
|
@@ -50,7 +50,10 @@ module ZendeskAPI
|
|
50
50
|
hash = hash[key]
|
51
51
|
end
|
52
52
|
|
53
|
-
|
53
|
+
unless defined?(mime_type) && !mime_type.nil?
|
54
|
+
mime_type = MiniMime.lookup_by_filename(path)
|
55
|
+
mime_type = mime_type ? mime_type.content_type : "application/octet-stream"
|
56
|
+
end
|
54
57
|
|
55
58
|
hash[:filename] ||= if file.respond_to?(:original_filename)
|
56
59
|
file.original_filename
|
@@ -10,6 +10,8 @@ module ZendeskAPI
|
|
10
10
|
|
11
11
|
# @internal Begin actual Resource definitions
|
12
12
|
|
13
|
+
class RecipientAddress < Resource; end
|
14
|
+
|
13
15
|
class Locale < ReadResource; end
|
14
16
|
|
15
17
|
class CustomRole < DataResource; end
|
@@ -122,6 +124,8 @@ module ZendeskAPI
|
|
122
124
|
put :clear_badge
|
123
125
|
end
|
124
126
|
|
127
|
+
class OrganizationRelated < DataResource; end
|
128
|
+
|
125
129
|
class Organization < Resource
|
126
130
|
extend CreateMany
|
127
131
|
extend CreateOrUpdate
|
@@ -129,6 +133,7 @@ module ZendeskAPI
|
|
129
133
|
|
130
134
|
has Ability, :inline => true
|
131
135
|
has Group
|
136
|
+
has :related, :class => OrganizationRelated
|
132
137
|
|
133
138
|
has_many Ticket
|
134
139
|
has_many User
|
@@ -179,6 +184,34 @@ module ZendeskAPI
|
|
179
184
|
"help_center/categories"
|
180
185
|
end
|
181
186
|
end
|
187
|
+
|
188
|
+
class Section < Resource
|
189
|
+
end
|
190
|
+
|
191
|
+
has_many Section
|
192
|
+
end
|
193
|
+
|
194
|
+
class Section < ReadResource
|
195
|
+
class << self
|
196
|
+
def resource_path
|
197
|
+
"help_center/sections"
|
198
|
+
end
|
199
|
+
end
|
200
|
+
|
201
|
+
has Category
|
202
|
+
|
203
|
+
class Article < Resource
|
204
|
+
end
|
205
|
+
|
206
|
+
has_many Article
|
207
|
+
end
|
208
|
+
|
209
|
+
class Article < ReadResource
|
210
|
+
class << self
|
211
|
+
def resource_path
|
212
|
+
"help_center/articles"
|
213
|
+
end
|
214
|
+
end
|
182
215
|
end
|
183
216
|
|
184
217
|
class TopicSubscription < Resource
|
@@ -446,6 +479,15 @@ module ZendeskAPI
|
|
446
479
|
put :recover
|
447
480
|
end
|
448
481
|
|
482
|
+
class DeletedTicket < ReadResource
|
483
|
+
include Destroy
|
484
|
+
extend DestroyMany
|
485
|
+
|
486
|
+
# Restores this previously deleted ticket to an actual ticket
|
487
|
+
put :restore
|
488
|
+
put :restore_many
|
489
|
+
end
|
490
|
+
|
449
491
|
class UserViewRow < DataResource
|
450
492
|
has User
|
451
493
|
def self.model_key
|
@@ -484,6 +526,8 @@ module ZendeskAPI
|
|
484
526
|
end
|
485
527
|
end
|
486
528
|
|
529
|
+
class TriggerCategory < Resource; end
|
530
|
+
|
487
531
|
module Conditions
|
488
532
|
def all_conditions=(all_conditions)
|
489
533
|
self.conditions ||= {}
|
@@ -682,6 +726,8 @@ module ZendeskAPI
|
|
682
726
|
false
|
683
727
|
end
|
684
728
|
|
729
|
+
put :merge
|
730
|
+
|
685
731
|
has CustomRole, :inline => true, :include => :roles
|
686
732
|
has Role, :inline => true, :include_key => :name
|
687
733
|
has Ability, :inline => true
|
@@ -721,6 +767,10 @@ module ZendeskAPI
|
|
721
767
|
end
|
722
768
|
end
|
723
769
|
|
770
|
+
class DeletedUser < ReadResource
|
771
|
+
include Destroy
|
772
|
+
end
|
773
|
+
|
724
774
|
class UserField < Resource; end
|
725
775
|
class OrganizationField < Resource; end
|
726
776
|
|
data/lib/zendesk_api/version.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: zendesk_api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.30.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Steven Davidovitz
|
@@ -9,7 +9,7 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date:
|
12
|
+
date: 2021-06-10 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: faraday
|
@@ -40,7 +40,7 @@ dependencies:
|
|
40
40
|
version: 3.5.2
|
41
41
|
- - "<"
|
42
42
|
- !ruby/object:Gem::Version
|
43
|
-
version:
|
43
|
+
version: 5.0.0
|
44
44
|
type: :runtime
|
45
45
|
prerelease: false
|
46
46
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -50,7 +50,7 @@ dependencies:
|
|
50
50
|
version: 3.5.2
|
51
51
|
- - "<"
|
52
52
|
- !ruby/object:Gem::Version
|
53
|
-
version:
|
53
|
+
version: 5.0.0
|
54
54
|
- !ruby/object:Gem::Dependency
|
55
55
|
name: inflection
|
56
56
|
requirement: !ruby/object:Gem::Requirement
|
@@ -80,7 +80,7 @@ dependencies:
|
|
80
80
|
- !ruby/object:Gem::Version
|
81
81
|
version: '2.0'
|
82
82
|
- !ruby/object:Gem::Dependency
|
83
|
-
name:
|
83
|
+
name: mini_mime
|
84
84
|
requirement: !ruby/object:Gem::Requirement
|
85
85
|
requirements:
|
86
86
|
- - ">="
|
@@ -101,6 +101,7 @@ executables: []
|
|
101
101
|
extensions: []
|
102
102
|
extra_rdoc_files: []
|
103
103
|
files:
|
104
|
+
- LICENSE
|
104
105
|
- lib/zendesk_api.rb
|
105
106
|
- lib/zendesk_api/actions.rb
|
106
107
|
- lib/zendesk_api/association.rb
|
@@ -139,12 +140,12 @@ files:
|
|
139
140
|
- util/verb_handler.rb
|
140
141
|
homepage: https://developer.zendesk.com
|
141
142
|
licenses:
|
142
|
-
- Apache
|
143
|
+
- Apache-2.0
|
143
144
|
metadata:
|
144
145
|
bug_tracker_uri: https://github.com/zendesk/zendesk_api_client_rb/issues
|
145
|
-
changelog_uri: https://github.com/zendesk/zendesk_api_client_rb/blob/v1.
|
146
|
-
documentation_uri: https://www.rubydoc.info/gems/zendesk_api/1.
|
147
|
-
source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v1.
|
146
|
+
changelog_uri: https://github.com/zendesk/zendesk_api_client_rb/blob/v1.30.0/CHANGELOG.md
|
147
|
+
documentation_uri: https://www.rubydoc.info/gems/zendesk_api/1.30.0
|
148
|
+
source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v1.30.0
|
148
149
|
wiki_uri: https://github.com/zendesk/zendesk_api_client_rb/wiki
|
149
150
|
post_install_message:
|
150
151
|
rdoc_options: []
|