peal 0.1.0 → 0.2.0

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.
Files changed (229) hide show
  1. checksums.yaml +4 -4
  2. data/NOTICE +4 -0
  3. data/README.md +5 -4
  4. data/lib/peal/models/api_key.rb +11 -23
  5. data/lib/peal/models/membership.rb +11 -23
  6. data/lib/peal/models/new_api_key.rb +15 -23
  7. data/lib/peal/models/permission.rb +66 -0
  8. data/lib/peal/version.rb +1 -1
  9. data/lib/peal.rb +1 -0
  10. metadata +3 -220
  11. data/Gemfile +0 -9
  12. data/Gemfile.lock +0 -136
  13. data/Rakefile +0 -10
  14. data/docs/AlreadyMemberEncoded.md +0 -18
  15. data/docs/AltTextTooLongEncoded.md +0 -20
  16. data/docs/AnalyticsApi.md +0 -155
  17. data/docs/AnalyticsSummary.md +0 -30
  18. data/docs/ApiKey.md +0 -28
  19. data/docs/ApiKeyNotFoundEncoded.md +0 -18
  20. data/docs/ApiKeysApi.md +0 -220
  21. data/docs/ApiKeysRevoke404Response.md +0 -18
  22. data/docs/AssistantAction.md +0 -24
  23. data/docs/AssistantActionAnyOf.md +0 -20
  24. data/docs/AssistantActionAnyOf1.md +0 -20
  25. data/docs/AssistantActionAnyOf2.md +0 -20
  26. data/docs/AssistantActionAnyOf3.md +0 -18
  27. data/docs/AssistantApi.md +0 -149
  28. data/docs/AssistantFailedEncoded.md +0 -20
  29. data/docs/AssistantInputRejectedEncoded.md +0 -22
  30. data/docs/AssistantQuotaExceededEncoded.md +0 -22
  31. data/docs/AssistantStatus.md +0 -26
  32. data/docs/AssistantTone.md +0 -15
  33. data/docs/AssistantUnavailableEncoded.md +0 -18
  34. data/docs/AttemptResult.md +0 -15
  35. data/docs/Authorization.md +0 -18
  36. data/docs/Billing.md +0 -28
  37. data/docs/BillingApi.md +0 -77
  38. data/docs/BillingSubscription.md +0 -24
  39. data/docs/Channel.md +0 -30
  40. data/docs/ChannelCannotPostEncoded.md +0 -20
  41. data/docs/ChannelMetrics.md +0 -30
  42. data/docs/ChannelNotFoundEncoded.md +0 -18
  43. data/docs/ChannelOptions.md +0 -20
  44. data/docs/ChannelStatus.md +0 -20
  45. data/docs/ChannelStatusAnyOf.md +0 -18
  46. data/docs/ChannelStatusAnyOf1.md +0 -18
  47. data/docs/ChannelStatusAnyOf2.md +0 -20
  48. data/docs/ChannelsApi.md +0 -512
  49. data/docs/ChannelsCompleteConnect404Response.md +0 -18
  50. data/docs/ChoosableAccount.md +0 -26
  51. data/docs/ChooseAccounts.md +0 -20
  52. data/docs/ConnectCallback.md +0 -24
  53. data/docs/ConnectChannel.md +0 -20
  54. data/docs/ConnectFailedEncoded.md +0 -20
  55. data/docs/ConnectFailureReason.md +0 -15
  56. data/docs/ConnectOutcome.md +0 -26
  57. data/docs/ConnectOutcomeAnyOf.md +0 -20
  58. data/docs/ConnectOutcomeAnyOf1.md +0 -24
  59. data/docs/ConnectablePlatforms.md +0 -18
  60. data/docs/ContentViolation.md +0 -54
  61. data/docs/ContentViolationAnyOf.md +0 -18
  62. data/docs/ContentViolationAnyOf1.md +0 -20
  63. data/docs/ContentViolationAnyOf10.md +0 -26
  64. data/docs/ContentViolationAnyOf11.md +0 -22
  65. data/docs/ContentViolationAnyOf12.md +0 -26
  66. data/docs/ContentViolationAnyOf13.md +0 -26
  67. data/docs/ContentViolationAnyOf14.md +0 -26
  68. data/docs/ContentViolationAnyOf15.md +0 -26
  69. data/docs/ContentViolationAnyOf16.md +0 -22
  70. data/docs/ContentViolationAnyOf17.md +0 -26
  71. data/docs/ContentViolationAnyOf18.md +0 -28
  72. data/docs/ContentViolationAnyOf19.md +0 -28
  73. data/docs/ContentViolationAnyOf2.md +0 -20
  74. data/docs/ContentViolationAnyOf20.md +0 -28
  75. data/docs/ContentViolationAnyOf21.md +0 -28
  76. data/docs/ContentViolationAnyOf22.md +0 -30
  77. data/docs/ContentViolationAnyOf23.md +0 -32
  78. data/docs/ContentViolationAnyOf24.md +0 -32
  79. data/docs/ContentViolationAnyOf24Maximum.md +0 -15
  80. data/docs/ContentViolationAnyOf25.md +0 -28
  81. data/docs/ContentViolationAnyOf3.md +0 -24
  82. data/docs/ContentViolationAnyOf4.md +0 -24
  83. data/docs/ContentViolationAnyOf5.md +0 -28
  84. data/docs/ContentViolationAnyOf6.md +0 -24
  85. data/docs/ContentViolationAnyOf7.md +0 -22
  86. data/docs/ContentViolationAnyOf8.md +0 -28
  87. data/docs/ContentViolationAnyOf9.md +0 -24
  88. data/docs/CreatedApiKey.md +0 -20
  89. data/docs/DatabaseUnavailableEncoded.md +0 -18
  90. data/docs/DraftPage.md +0 -20
  91. data/docs/EffectHttpApiErrorBadRequestEncoded.md +0 -18
  92. data/docs/EngagementDay.md +0 -26
  93. data/docs/FailureReason.md +0 -15
  94. data/docs/ForbiddenEncoded.md +0 -18
  95. data/docs/InvalidDateRangeEncoded.md +0 -18
  96. data/docs/InvalidTimeRangeEncoded.md +0 -18
  97. data/docs/InvalidTimeZoneEncoded.md +0 -20
  98. data/docs/Invitation.md +0 -28
  99. data/docs/InvitationNotFoundEncoded.md +0 -18
  100. data/docs/InvitationsApi.md +0 -220
  101. data/docs/InvitationsCreate409Response.md +0 -18
  102. data/docs/InvitationsRevoke404Response.md +0 -18
  103. data/docs/MarkNoticesRead.md +0 -18
  104. data/docs/Me.md +0 -22
  105. data/docs/MeUser.md +0 -28
  106. data/docs/Media.md +0 -40
  107. data/docs/MediaApi.md +0 -516
  108. data/docs/MediaAttachment.md +0 -20
  109. data/docs/MediaContentType.md +0 -15
  110. data/docs/MediaCreate422Response.md +0 -28
  111. data/docs/MediaDescription.md +0 -18
  112. data/docs/MediaDimensions.md +0 -20
  113. data/docs/MediaGet404Response.md +0 -18
  114. data/docs/MediaInUseEncoded.md +0 -20
  115. data/docs/MediaKind.md +0 -15
  116. data/docs/MediaNotFoundEncoded.md +0 -18
  117. data/docs/MediaPage.md +0 -20
  118. data/docs/MediaStatus.md +0 -22
  119. data/docs/MediaStatusAnyOf.md +0 -18
  120. data/docs/MediaStatusAnyOf1.md +0 -20
  121. data/docs/MediaStatusAnyOf2.md +0 -18
  122. data/docs/MediaStatusAnyOf3.md +0 -20
  123. data/docs/MediaStoreUnavailableEncoded.md +0 -18
  124. data/docs/MediaTooLargeEncoded.md +0 -24
  125. data/docs/MediaUsage.md +0 -20
  126. data/docs/MembersApi.md +0 -77
  127. data/docs/Membership.md +0 -26
  128. data/docs/MetricTotals.md +0 -28
  129. data/docs/MetricsSnapshot.md +0 -20
  130. data/docs/NewApiKey.md +0 -22
  131. data/docs/NewInvitation.md +0 -20
  132. data/docs/NewUpload.md +0 -22
  133. data/docs/NonFiniteNumber.md +0 -15
  134. data/docs/Notice.md +0 -26
  135. data/docs/NoticeChannel.md +0 -20
  136. data/docs/NoticeEvent.md +0 -28
  137. data/docs/NoticeEventAnyOf.md +0 -24
  138. data/docs/NoticeEventAnyOf1.md +0 -24
  139. data/docs/NoticeEventAnyOf2.md +0 -22
  140. data/docs/NoticeEventAnyOf3.md +0 -20
  141. data/docs/NoticeEventAnyOf4.md +0 -22
  142. data/docs/NoticePage.md +0 -20
  143. data/docs/NoticesApi.md +0 -285
  144. data/docs/NotificationPreferences.md +0 -20
  145. data/docs/NotificationPreferencesApi.md +0 -144
  146. data/docs/NotificationPreferencesChange.md +0 -20
  147. data/docs/NotificationPreferencesChangeEmail.md +0 -24
  148. data/docs/NotificationPreferencesEmail.md +0 -24
  149. data/docs/PaidPlan.md +0 -15
  150. data/docs/PeriodUsage.md +0 -20
  151. data/docs/Plan.md +0 -15
  152. data/docs/PlanAllowances.md +0 -24
  153. data/docs/PlanLimit.md +0 -15
  154. data/docs/PlanLimitReachedEncoded.md +0 -22
  155. data/docs/PlanOffer.md +0 -20
  156. data/docs/Platform.md +0 -15
  157. data/docs/PlatformUnreachableEncoded.md +0 -18
  158. data/docs/Post.md +0 -30
  159. data/docs/PostAnalytics.md +0 -20
  160. data/docs/PostContent.md +0 -22
  161. data/docs/PostContentInvalidEncoded.md +0 -20
  162. data/docs/PostDraft.md +0 -22
  163. data/docs/PostMetrics.md +0 -26
  164. data/docs/PostNotFoundEncoded.md +0 -18
  165. data/docs/PostOutcome.md +0 -15
  166. data/docs/PostSchedule.md +0 -20
  167. data/docs/PostStatus.md +0 -15
  168. data/docs/PostStatusConflictEncoded.md +0 -20
  169. data/docs/PostTarget.md +0 -36
  170. data/docs/PostTargetStatus.md +0 -15
  171. data/docs/PostsApi.md +0 -960
  172. data/docs/PostsCreate422Response.md +0 -24
  173. data/docs/PostsGet404Response.md +0 -18
  174. data/docs/PostsRepost409Response.md +0 -20
  175. data/docs/PostsSchedule422Response.md +0 -26
  176. data/docs/PreparedUpload.md +0 -20
  177. data/docs/ProbeState.md +0 -15
  178. data/docs/PublicationAttempt.md +0 -30
  179. data/docs/RejectionReason.md +0 -15
  180. data/docs/Role.md +0 -15
  181. data/docs/ScheduleInPastEncoded.md +0 -18
  182. data/docs/SchedulePost.md +0 -22
  183. data/docs/SessionApi.md +0 -74
  184. data/docs/SignedRequest.md +0 -22
  185. data/docs/SubscriptionStatus.md +0 -15
  186. data/docs/Suggestion.md +0 -22
  187. data/docs/SuggestionAnyOf.md +0 -20
  188. data/docs/SuggestionAnyOf1.md +0 -20
  189. data/docs/SuggestionRequest.md +0 -20
  190. data/docs/SystemApi.md +0 -129
  191. data/docs/TargetConfirmation.md +0 -20
  192. data/docs/TargetConfirmationAnyOf.md +0 -20
  193. data/docs/TargetConfirmationAnyOf1.md +0 -18
  194. data/docs/TargetMetrics.md +0 -32
  195. data/docs/TargetOptions.md +0 -48
  196. data/docs/TargetStatusConflictEncoded.md +0 -20
  197. data/docs/TextOverride.md +0 -20
  198. data/docs/TextUnit.md +0 -15
  199. data/docs/TikTokAccount.md +0 -20
  200. data/docs/TikTokAccountPosting.md +0 -22
  201. data/docs/TikTokAccountPostingAnyOf.md +0 -20
  202. data/docs/TikTokAccountPostingAnyOf1.md +0 -20
  203. data/docs/TikTokBlock.md +0 -15
  204. data/docs/TikTokCreator.md +0 -32
  205. data/docs/TikTokOptions.md +0 -34
  206. data/docs/TikTokPrivacyLevel.md +0 -15
  207. data/docs/TiktokApi.md +0 -79
  208. data/docs/TooManyInvitationsEncoded.md +0 -18
  209. data/docs/TopPost.md +0 -30
  210. data/docs/TranslationLanguage.md +0 -15
  211. data/docs/UnauthenticatedEncoded.md +0 -18
  212. data/docs/UnconfirmedReason.md +0 -15
  213. data/docs/UnknownChannelsEncoded.md +0 -20
  214. data/docs/UnknownMediaEncoded.md +0 -20
  215. data/docs/UnreadNotices.md +0 -18
  216. data/docs/UnsupportedMediaTypeEncoded.md +0 -20
  217. data/docs/UploadIncompleteEncoded.md +0 -18
  218. data/docs/UploadPart.md +0 -22
  219. data/docs/UploadRejectedEncoded.md +0 -20
  220. data/docs/UploadTarget.md +0 -26
  221. data/docs/UploadTargetAnyOf.md +0 -22
  222. data/docs/UploadTargetAnyOf1.md +0 -24
  223. data/docs/Usage.md +0 -24
  224. data/docs/WorkspaceMember.md +0 -26
  225. data/docs/WorkspaceNotFoundEncoded.md +0 -18
  226. data/docs/YouTubeOptions.md +0 -32
  227. data/docs/YouTubePrivacy.md +0 -15
  228. data/peal.gemspec +0 -41
  229. data/project.json +0 -17
data/Gemfile.lock DELETED
@@ -1,136 +0,0 @@
1
- PATH
2
- remote: .
3
- specs:
4
- peal (0.1.0)
5
- faraday (>= 1.0.1, < 3.0)
6
- faraday-multipart
7
- marcel
8
-
9
- GEM
10
- remote: https://rubygems.org/
11
- specs:
12
- ast (2.4.3)
13
- byebug (13.0.0)
14
- reline (>= 0.6.0)
15
- coderay (1.1.3)
16
- date (3.6.0)
17
- diff-lcs (1.6.2)
18
- faraday (2.15.1)
19
- faraday-net_http (>= 2.0, < 3.6)
20
- json
21
- logger
22
- faraday-multipart (1.2.0)
23
- multipart-post (~> 2.0)
24
- faraday-net_http (3.5.0)
25
- net-http (~> 0.5)
26
- io-console (0.9.5)
27
- jaro_winkler (1.5.6)
28
- json (3.1.0)
29
- logger (1.7.0)
30
- marcel (2.1.0)
31
- method_source (1.1.0)
32
- multipart-post (2.4.1)
33
- net-http (0.10.0)
34
- net-protocol (>= 0.3.0)
35
- uri (>= 0.11.1)
36
- net-protocol (0.4.0)
37
- timeout
38
- parallel (1.28.0)
39
- parser (3.3.13.0)
40
- ast (~> 2.4.1)
41
- racc
42
- pry (0.16.1)
43
- coderay (~> 1.1)
44
- method_source (~> 1.0)
45
- reline (>= 0.6.0)
46
- pry-byebug (3.12.0)
47
- byebug (~> 13.0)
48
- pry (>= 0.13, < 0.17)
49
- psych (5.5.0)
50
- date
51
- stringio
52
- racc (1.8.1)
53
- rainbow (3.1.1)
54
- rake (13.0.6)
55
- reline (0.7.0)
56
- io-console (~> 0.5)
57
- rspec (3.13.2)
58
- rspec-core (~> 3.13.0)
59
- rspec-expectations (~> 3.13.0)
60
- rspec-mocks (~> 3.13.0)
61
- rspec-core (3.13.7)
62
- rspec-support (~> 3.13.0)
63
- rspec-expectations (3.13.6)
64
- diff-lcs (>= 1.2.0, < 2.0)
65
- rspec-support (~> 3.13.0)
66
- rspec-mocks (3.13.9)
67
- diff-lcs (>= 1.2.0, < 2.0)
68
- rspec-support (~> 3.13.0)
69
- rspec-support (3.13.8)
70
- rubocop (0.66.0)
71
- jaro_winkler (~> 1.5.1)
72
- parallel (~> 1.10)
73
- parser (>= 2.5, != 2.5.1.1)
74
- psych (>= 3.1.0)
75
- rainbow (>= 2.2.2, < 4.0)
76
- ruby-progressbar (~> 1.7)
77
- unicode-display_width (>= 1.4.0, < 1.6)
78
- ruby-progressbar (1.13.0)
79
- stringio (3.2.0)
80
- timeout (0.6.1)
81
- unicode-display_width (1.5.0)
82
- uri (1.1.2)
83
-
84
- PLATFORMS
85
- ruby
86
- x86_64-linux
87
-
88
- DEPENDENCIES
89
- peal!
90
- pry-byebug
91
- rake (~> 13.0.1)
92
- rspec (~> 3.6, >= 3.6.0)
93
- rubocop (~> 0.66.0)
94
-
95
- CHECKSUMS
96
- ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
97
- byebug (13.0.0) sha256=d2263efe751941ca520fa29744b71972d39cbc41839496706f5d9b22e92ae05d
98
- coderay (1.1.3) sha256=dc530018a4684512f8f38143cd2a096c9f02a1fc2459edcfe534787a7fc77d4b
99
- date (3.6.0) sha256=18ac945c4e24ebd93534f8eab8c2fd8c5604b3e977105b3798d62a1e8d27b580
100
- diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
101
- faraday (2.15.1) sha256=8708154deda739c5e86cc42b74960e23e8491fce0eba9e11639a6a34b1ac288f
102
- faraday-multipart (1.2.0) sha256=7d89a949693714176f612323ca13746a2ded204031a6ba528adee788694ef757
103
- faraday-net_http (3.5.0) sha256=2e7094c34e38754ee048cc3df47376f8657005d9375f8473bce1c3b526a22e36
104
- io-console (0.9.5) sha256=83dd9bbf4c4680416629245b39cd4212eb5f4d9a4ea91804870c1f6b846414d5
105
- jaro_winkler (1.5.6) sha256=007db7805527ada1cc12f2547676181d63b0a504ec4dd7a9a2eb2424521ccd81
106
- json (3.1.0) sha256=3ce7ccf8fde58960177a3a756c31f292a4c1e1dedee884547096a5b0604e3bd8
107
- logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
108
- marcel (2.1.0) sha256=f8b0327111dc7e516331eeefe052e981ce50e2bd826c1042a53cdf047fcc3512
109
- method_source (1.1.0) sha256=181301c9c45b731b4769bc81e8860e72f9161ad7d66dd99103c9ab84f560f5c5
110
- multipart-post (2.4.1) sha256=9872d03a8e552020ca096adadbf5e3cb1cd1cdd6acd3c161136b8a5737cdb4a8
111
- net-http (0.10.0) sha256=1a2ff6e37a05724973c43f2bf7bf105f59c36a4cd0a7e9b1c021a0a566987c27
112
- net-protocol (0.4.0) sha256=f9f90c8c6f64794a45160bf422177a336db12809de3beeeaa26b88fcd2e8c853
113
- parallel (1.28.0) sha256=33e6de1484baf2524792d178b0913fc8eb94c628d6cfe45599ad4458c638c970
114
- parser (3.3.13.0) sha256=e02f9b63c2fe05b0c68f692ba4df89b3cb113b663964f75d988fbebfd6c3deca
115
- peal (0.1.0)
116
- pry (0.16.1) sha256=d92d82c86e7f2dc34beec6d2892d5cf5ea517eea22eed3ceabb38ee62a98accc
117
- pry-byebug (3.12.0) sha256=594e094ae8a8390a7ad4c7b36ae36e13304ed02664c67417d108dc5f7213d1b7
118
- psych (5.5.0) sha256=4b245bbbd0f3238df8ccee766ebc1a6b062b10e4ee1d3284eb588739ba156a0a
119
- racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
120
- rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a
121
- rake (13.0.6) sha256=5ce4bf5037b4196c24ac62834d8db1ce175470391026bd9e557d669beeb19097
122
- reline (0.7.0) sha256=5b012d8e55dbf9d450f12bde2cf7d15ff546ae80b3f8f3b30e570d431815583d
123
- rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
124
- rspec-core (3.13.7) sha256=c64ff16d9788119805cbc6a3f4b6d87cc22417c2d25976a3330de136896b5469
125
- rspec-expectations (3.13.6) sha256=bf538ca6d367ff5b0d85a87fdb5c0c6038f2cd1308a0eeba07476caa02d22f35
126
- rspec-mocks (3.13.9) sha256=ea5c7ff3054a6098ca6039aacef80aec69d5a8a3ef80be8fc88337359b672a30
127
- rspec-support (3.13.8) sha256=e4160030309b7e3e9d9863dfe720a35dfcc577162f5402cd68fc8c5258a0ffd6
128
- rubocop (0.66.0) sha256=f05a6896f367765b3f0fba663d0add120444f8de604dada405662b10a0860f5a
129
- ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
130
- stringio (3.2.0) sha256=c37cb2e58b4ffbd33fe5cd948c05934af997b36e0b6ca6fdf43afa234cf222e1
131
- timeout (0.6.1) sha256=78f57368a7e7bbadec56971f78a3f5ecbcfb59b7fcbb0a3ed6ddc08a5094accb
132
- unicode-display_width (1.5.0) sha256=9890eebd24feb4cb0e0542c9b8c6beecb40cda27be8c7afe49312625b36156eb
133
- uri (1.1.2) sha256=89292e98eabbef6248b0a0ed5e7e398e152f83f17560023a6d94a7f492b169fb
134
-
135
- BUNDLED WITH
136
- 4.0.20
data/Rakefile DELETED
@@ -1,10 +0,0 @@
1
- require "bundler/gem_tasks"
2
-
3
- begin
4
- require 'rspec/core/rake_task'
5
-
6
- RSpec::Core::RakeTask.new(:spec)
7
- task default: :spec
8
- rescue LoadError
9
- # no rspec available
10
- end
@@ -1,18 +0,0 @@
1
- # Peal::AlreadyMemberEncoded
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **_tag** | **String** | | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'peal'
13
-
14
- instance = Peal::AlreadyMemberEncoded.new(
15
- _tag: null
16
- )
17
- ```
18
-
@@ -1,20 +0,0 @@
1
- # Peal::AltTextTooLongEncoded
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **_tag** | **String** | | |
8
- | **max_length** | **Integer** | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'peal'
14
-
15
- instance = Peal::AltTextTooLongEncoded.new(
16
- _tag: null,
17
- max_length: null
18
- )
19
- ```
20
-
data/docs/AnalyticsApi.md DELETED
@@ -1,155 +0,0 @@
1
- # Peal::AnalyticsApi
2
-
3
- All URIs are relative to *https://app.peal.social*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**analytics_post**](AnalyticsApi.md#analytics_post) | **GET** /api/workspaces/{workspaceId}/analytics/posts/{postId} | Get a post&#39;s analytics |
8
- | [**analytics_summary**](AnalyticsApi.md#analytics_summary) | **GET** /api/workspaces/{workspaceId}/analytics/summary | Summarize the workspace&#39;s analytics |
9
-
10
-
11
- ## analytics_post
12
-
13
- > <PostAnalytics> analytics_post(workspace_id, post_id)
14
-
15
- Get a post's analytics
16
-
17
- Answers with the counts of a post on each channel it went live on, over time. A post not published yet, or whose counts were not read yet, has no targets. Needs analytics:read.
18
-
19
- ### Examples
20
-
21
- ```ruby
22
- require 'time'
23
- require 'peal'
24
- # setup authorization
25
- Peal.configure do |config|
26
- # Configure Bearer authorization: bearer
27
- config.access_token = 'YOUR_BEARER_TOKEN'
28
- end
29
-
30
- api_instance = Peal::AnalyticsApi.new
31
- workspace_id = 'workspace_id_example' # String |
32
- post_id = 'post_id_example' # String |
33
-
34
- begin
35
- # Get a post's analytics
36
- result = api_instance.analytics_post(workspace_id, post_id)
37
- p result
38
- rescue Peal::ApiError => e
39
- puts "Error when calling AnalyticsApi->analytics_post: #{e}"
40
- end
41
- ```
42
-
43
- #### Using the analytics_post_with_http_info variant
44
-
45
- This returns an Array which contains the response data, status code and headers.
46
-
47
- > <Array(<PostAnalytics>, Integer, Hash)> analytics_post_with_http_info(workspace_id, post_id)
48
-
49
- ```ruby
50
- begin
51
- # Get a post's analytics
52
- data, status_code, headers = api_instance.analytics_post_with_http_info(workspace_id, post_id)
53
- p status_code # => 2xx
54
- p headers # => { ... }
55
- p data # => <PostAnalytics>
56
- rescue Peal::ApiError => e
57
- puts "Error when calling AnalyticsApi->analytics_post_with_http_info: #{e}"
58
- end
59
- ```
60
-
61
- ### Parameters
62
-
63
- | Name | Type | Description | Notes |
64
- | ---- | ---- | ----------- | ----- |
65
- | **workspace_id** | **String** | | |
66
- | **post_id** | **String** | | |
67
-
68
- ### Return type
69
-
70
- [**PostAnalytics**](PostAnalytics.md)
71
-
72
- ### Authorization
73
-
74
- [bearer](../README.md#bearer)
75
-
76
- ### HTTP request headers
77
-
78
- - **Content-Type**: Not defined
79
- - **Accept**: application/json
80
-
81
-
82
- ## analytics_summary
83
-
84
- > <AnalyticsSummary> analytics_summary(workspace_id, from, time_zone, to)
85
-
86
- Summarize the workspace's analytics
87
-
88
- Sums up the posts published from `from` to `to`, both included and at most 366 days, as days run in `timeZone` (an IANA zone such as Europe/Paris): their latest counts in all and by channel, what they gained each day, and the five with the most engagement (likes, reposts, replies and quotes). Counts are read from the platforms every hour for 48 hours after a post goes live, then every day until it is 30 days old. Needs analytics:read.
89
-
90
- ### Examples
91
-
92
- ```ruby
93
- require 'time'
94
- require 'peal'
95
- # setup authorization
96
- Peal.configure do |config|
97
- # Configure Bearer authorization: bearer
98
- config.access_token = 'YOUR_BEARER_TOKEN'
99
- end
100
-
101
- api_instance = Peal::AnalyticsApi.new
102
- workspace_id = 'workspace_id_example' # String |
103
- from = 'from_example' # String |
104
- time_zone = 'time_zone_example' # String |
105
- to = 'to_example' # String |
106
-
107
- begin
108
- # Summarize the workspace's analytics
109
- result = api_instance.analytics_summary(workspace_id, from, time_zone, to)
110
- p result
111
- rescue Peal::ApiError => e
112
- puts "Error when calling AnalyticsApi->analytics_summary: #{e}"
113
- end
114
- ```
115
-
116
- #### Using the analytics_summary_with_http_info variant
117
-
118
- This returns an Array which contains the response data, status code and headers.
119
-
120
- > <Array(<AnalyticsSummary>, Integer, Hash)> analytics_summary_with_http_info(workspace_id, from, time_zone, to)
121
-
122
- ```ruby
123
- begin
124
- # Summarize the workspace's analytics
125
- data, status_code, headers = api_instance.analytics_summary_with_http_info(workspace_id, from, time_zone, to)
126
- p status_code # => 2xx
127
- p headers # => { ... }
128
- p data # => <AnalyticsSummary>
129
- rescue Peal::ApiError => e
130
- puts "Error when calling AnalyticsApi->analytics_summary_with_http_info: #{e}"
131
- end
132
- ```
133
-
134
- ### Parameters
135
-
136
- | Name | Type | Description | Notes |
137
- | ---- | ---- | ----------- | ----- |
138
- | **workspace_id** | **String** | | |
139
- | **from** | **String** | | |
140
- | **time_zone** | **String** | | |
141
- | **to** | **String** | | |
142
-
143
- ### Return type
144
-
145
- [**AnalyticsSummary**](AnalyticsSummary.md)
146
-
147
- ### Authorization
148
-
149
- [bearer](../README.md#bearer)
150
-
151
- ### HTTP request headers
152
-
153
- - **Content-Type**: Not defined
154
- - **Accept**: application/json
155
-
@@ -1,30 +0,0 @@
1
- # Peal::AnalyticsSummary
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **channels** | [**Array&lt;ChannelMetrics&gt;**](ChannelMetrics.md) | | |
8
- | **days** | [**Array&lt;EngagementDay&gt;**](EngagementDay.md) | | |
9
- | **from** | **String** | | |
10
- | **time_zone** | **String** | | |
11
- | **to** | **String** | | |
12
- | **top_posts** | [**Array&lt;TopPost&gt;**](TopPost.md) | | |
13
- | **totals** | [**MetricTotals**](MetricTotals.md) | | |
14
-
15
- ## Example
16
-
17
- ```ruby
18
- require 'peal'
19
-
20
- instance = Peal::AnalyticsSummary.new(
21
- channels: null,
22
- days: null,
23
- from: null,
24
- time_zone: null,
25
- to: null,
26
- top_posts: null,
27
- totals: null
28
- )
29
- ```
30
-
data/docs/ApiKey.md DELETED
@@ -1,28 +0,0 @@
1
- # Peal::ApiKey
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **created_at** | **String** | | |
8
- | **expires_at** | **String** | | |
9
- | **id** | **String** | | |
10
- | **name** | **String** | | |
11
- | **permissions** | **Array&lt;String&gt;** | | |
12
- | **start** | **String** | | |
13
-
14
- ## Example
15
-
16
- ```ruby
17
- require 'peal'
18
-
19
- instance = Peal::ApiKey.new(
20
- created_at: null,
21
- expires_at: null,
22
- id: null,
23
- name: null,
24
- permissions: null,
25
- start: null
26
- )
27
- ```
28
-
@@ -1,18 +0,0 @@
1
- # Peal::ApiKeyNotFoundEncoded
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **_tag** | **String** | | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'peal'
13
-
14
- instance = Peal::ApiKeyNotFoundEncoded.new(
15
- _tag: null
16
- )
17
- ```
18
-
data/docs/ApiKeysApi.md DELETED
@@ -1,220 +0,0 @@
1
- # Peal::ApiKeysApi
2
-
3
- All URIs are relative to *https://app.peal.social*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**api_keys_create**](ApiKeysApi.md#api_keys_create) | **POST** /api/workspaces/{workspaceId}/api-keys | Create an API key |
8
- | [**api_keys_list**](ApiKeysApi.md#api_keys_list) | **GET** /api/workspaces/{workspaceId}/api-keys | List API keys |
9
- | [**api_keys_revoke**](ApiKeysApi.md#api_keys_revoke) | **DELETE** /api/workspaces/{workspaceId}/api-keys/{apiKeyId} | Revoke an API key |
10
-
11
-
12
- ## api_keys_create
13
-
14
- > <CreatedApiKey> api_keys_create(workspace_id, new_api_key)
15
-
16
- Create an API key
17
-
18
- Creates an API key for the workspace with some of the caller's permissions, and answers with the key itself, which is not shown again. Needs apiKey:create, and a signed-in member: API keys cannot create keys.
19
-
20
- ### Examples
21
-
22
- ```ruby
23
- require 'time'
24
- require 'peal'
25
- # setup authorization
26
- Peal.configure do |config|
27
- # Configure Bearer authorization: bearer
28
- config.access_token = 'YOUR_BEARER_TOKEN'
29
- end
30
-
31
- api_instance = Peal::ApiKeysApi.new
32
- workspace_id = 'workspace_id_example' # String |
33
- new_api_key = Peal::NewApiKey.new({name: 'name_example', permissions: ['analytics:read']}) # NewApiKey |
34
-
35
- begin
36
- # Create an API key
37
- result = api_instance.api_keys_create(workspace_id, new_api_key)
38
- p result
39
- rescue Peal::ApiError => e
40
- puts "Error when calling ApiKeysApi->api_keys_create: #{e}"
41
- end
42
- ```
43
-
44
- #### Using the api_keys_create_with_http_info variant
45
-
46
- This returns an Array which contains the response data, status code and headers.
47
-
48
- > <Array(<CreatedApiKey>, Integer, Hash)> api_keys_create_with_http_info(workspace_id, new_api_key)
49
-
50
- ```ruby
51
- begin
52
- # Create an API key
53
- data, status_code, headers = api_instance.api_keys_create_with_http_info(workspace_id, new_api_key)
54
- p status_code # => 2xx
55
- p headers # => { ... }
56
- p data # => <CreatedApiKey>
57
- rescue Peal::ApiError => e
58
- puts "Error when calling ApiKeysApi->api_keys_create_with_http_info: #{e}"
59
- end
60
- ```
61
-
62
- ### Parameters
63
-
64
- | Name | Type | Description | Notes |
65
- | ---- | ---- | ----------- | ----- |
66
- | **workspace_id** | **String** | | |
67
- | **new_api_key** | [**NewApiKey**](NewApiKey.md) | | |
68
-
69
- ### Return type
70
-
71
- [**CreatedApiKey**](CreatedApiKey.md)
72
-
73
- ### Authorization
74
-
75
- [bearer](../README.md#bearer)
76
-
77
- ### HTTP request headers
78
-
79
- - **Content-Type**: application/json
80
- - **Accept**: application/json
81
-
82
-
83
- ## api_keys_list
84
-
85
- > <Array<ApiKey>> api_keys_list(workspace_id)
86
-
87
- List API keys
88
-
89
- Lists the workspace's API keys. Needs apiKey:read.
90
-
91
- ### Examples
92
-
93
- ```ruby
94
- require 'time'
95
- require 'peal'
96
- # setup authorization
97
- Peal.configure do |config|
98
- # Configure Bearer authorization: bearer
99
- config.access_token = 'YOUR_BEARER_TOKEN'
100
- end
101
-
102
- api_instance = Peal::ApiKeysApi.new
103
- workspace_id = 'workspace_id_example' # String |
104
-
105
- begin
106
- # List API keys
107
- result = api_instance.api_keys_list(workspace_id)
108
- p result
109
- rescue Peal::ApiError => e
110
- puts "Error when calling ApiKeysApi->api_keys_list: #{e}"
111
- end
112
- ```
113
-
114
- #### Using the api_keys_list_with_http_info variant
115
-
116
- This returns an Array which contains the response data, status code and headers.
117
-
118
- > <Array(<Array<ApiKey>>, Integer, Hash)> api_keys_list_with_http_info(workspace_id)
119
-
120
- ```ruby
121
- begin
122
- # List API keys
123
- data, status_code, headers = api_instance.api_keys_list_with_http_info(workspace_id)
124
- p status_code # => 2xx
125
- p headers # => { ... }
126
- p data # => <Array<ApiKey>>
127
- rescue Peal::ApiError => e
128
- puts "Error when calling ApiKeysApi->api_keys_list_with_http_info: #{e}"
129
- end
130
- ```
131
-
132
- ### Parameters
133
-
134
- | Name | Type | Description | Notes |
135
- | ---- | ---- | ----------- | ----- |
136
- | **workspace_id** | **String** | | |
137
-
138
- ### Return type
139
-
140
- [**Array&lt;ApiKey&gt;**](ApiKey.md)
141
-
142
- ### Authorization
143
-
144
- [bearer](../README.md#bearer)
145
-
146
- ### HTTP request headers
147
-
148
- - **Content-Type**: Not defined
149
- - **Accept**: application/json
150
-
151
-
152
- ## api_keys_revoke
153
-
154
- > api_keys_revoke(workspace_id, api_key_id)
155
-
156
- Revoke an API key
157
-
158
- Revokes an API key of the workspace: it stops working at once. Needs apiKey:delete.
159
-
160
- ### Examples
161
-
162
- ```ruby
163
- require 'time'
164
- require 'peal'
165
- # setup authorization
166
- Peal.configure do |config|
167
- # Configure Bearer authorization: bearer
168
- config.access_token = 'YOUR_BEARER_TOKEN'
169
- end
170
-
171
- api_instance = Peal::ApiKeysApi.new
172
- workspace_id = 'workspace_id_example' # String |
173
- api_key_id = 'api_key_id_example' # String |
174
-
175
- begin
176
- # Revoke an API key
177
- api_instance.api_keys_revoke(workspace_id, api_key_id)
178
- rescue Peal::ApiError => e
179
- puts "Error when calling ApiKeysApi->api_keys_revoke: #{e}"
180
- end
181
- ```
182
-
183
- #### Using the api_keys_revoke_with_http_info variant
184
-
185
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
186
-
187
- > <Array(nil, Integer, Hash)> api_keys_revoke_with_http_info(workspace_id, api_key_id)
188
-
189
- ```ruby
190
- begin
191
- # Revoke an API key
192
- data, status_code, headers = api_instance.api_keys_revoke_with_http_info(workspace_id, api_key_id)
193
- p status_code # => 2xx
194
- p headers # => { ... }
195
- p data # => nil
196
- rescue Peal::ApiError => e
197
- puts "Error when calling ApiKeysApi->api_keys_revoke_with_http_info: #{e}"
198
- end
199
- ```
200
-
201
- ### Parameters
202
-
203
- | Name | Type | Description | Notes |
204
- | ---- | ---- | ----------- | ----- |
205
- | **workspace_id** | **String** | | |
206
- | **api_key_id** | **String** | | |
207
-
208
- ### Return type
209
-
210
- nil (empty response body)
211
-
212
- ### Authorization
213
-
214
- [bearer](../README.md#bearer)
215
-
216
- ### HTTP request headers
217
-
218
- - **Content-Type**: Not defined
219
- - **Accept**: application/json
220
-
@@ -1,18 +0,0 @@
1
- # Peal::ApiKeysRevoke404Response
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **_tag** | **String** | | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'peal'
13
-
14
- instance = Peal::ApiKeysRevoke404Response.new(
15
- _tag: null
16
- )
17
- ```
18
-
@@ -1,24 +0,0 @@
1
- # Peal::AssistantAction
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **_tag** | **String** | | |
8
- | **tone** | [**AssistantTone**](AssistantTone.md) | | |
9
- | **platform** | [**Platform**](Platform.md) | | |
10
- | **language** | [**TranslationLanguage**](TranslationLanguage.md) | | |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'peal'
16
-
17
- instance = Peal::AssistantAction.new(
18
- _tag: null,
19
- tone: null,
20
- platform: null,
21
- language: null
22
- )
23
- ```
24
-
@@ -1,20 +0,0 @@
1
- # Peal::AssistantActionAnyOf
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **_tag** | **String** | | |
8
- | **tone** | [**AssistantTone**](AssistantTone.md) | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'peal'
14
-
15
- instance = Peal::AssistantActionAnyOf.new(
16
- _tag: null,
17
- tone: null
18
- )
19
- ```
20
-