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
@@ -1,18 +0,0 @@
1
- # Peal::MediaGet404Response
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::MediaGet404Response.new(
15
- _tag: null
16
- )
17
- ```
18
-
@@ -1,20 +0,0 @@
1
- # Peal::MediaInUseEncoded
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **_tag** | **String** | | |
8
- | **post_ids** | **Array<String>** | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'peal'
14
-
15
- instance = Peal::MediaInUseEncoded.new(
16
- _tag: null,
17
- post_ids: null
18
- )
19
- ```
20
-
data/docs/MediaKind.md DELETED
@@ -1,15 +0,0 @@
1
- # Peal::MediaKind
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'peal'
12
-
13
- instance = Peal::MediaKind.new()
14
- ```
15
-
@@ -1,18 +0,0 @@
1
- # Peal::MediaNotFoundEncoded
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::MediaNotFoundEncoded.new(
15
- _tag: null
16
- )
17
- ```
18
-
data/docs/MediaPage.md DELETED
@@ -1,20 +0,0 @@
1
- # Peal::MediaPage
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **items** | [**Array<Media>**](Media.md) | | |
8
- | **next_cursor** | **String** | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'peal'
14
-
15
- instance = Peal::MediaPage.new(
16
- items: null,
17
- next_cursor: null
18
- )
19
- ```
20
-
data/docs/MediaStatus.md DELETED
@@ -1,22 +0,0 @@
1
- # Peal::MediaStatus
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **_tag** | **String** | | |
8
- | **probe** | [**ProbeState**](ProbeState.md) | | |
9
- | **reason** | [**RejectionReason**](RejectionReason.md) | | |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'peal'
15
-
16
- instance = Peal::MediaStatus.new(
17
- _tag: null,
18
- probe: null,
19
- reason: null
20
- )
21
- ```
22
-
@@ -1,18 +0,0 @@
1
- # Peal::MediaStatusAnyOf
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::MediaStatusAnyOf.new(
15
- _tag: null
16
- )
17
- ```
18
-
@@ -1,20 +0,0 @@
1
- # Peal::MediaStatusAnyOf1
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **_tag** | **String** | | |
8
- | **probe** | [**ProbeState**](ProbeState.md) | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'peal'
14
-
15
- instance = Peal::MediaStatusAnyOf1.new(
16
- _tag: null,
17
- probe: null
18
- )
19
- ```
20
-
@@ -1,18 +0,0 @@
1
- # Peal::MediaStatusAnyOf2
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::MediaStatusAnyOf2.new(
15
- _tag: null
16
- )
17
- ```
18
-
@@ -1,20 +0,0 @@
1
- # Peal::MediaStatusAnyOf3
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **_tag** | **String** | | |
8
- | **reason** | [**RejectionReason**](RejectionReason.md) | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'peal'
14
-
15
- instance = Peal::MediaStatusAnyOf3.new(
16
- _tag: null,
17
- reason: null
18
- )
19
- ```
20
-
@@ -1,18 +0,0 @@
1
- # Peal::MediaStoreUnavailableEncoded
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::MediaStoreUnavailableEncoded.new(
15
- _tag: null
16
- )
17
- ```
18
-
@@ -1,24 +0,0 @@
1
- # Peal::MediaTooLargeEncoded
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **_tag** | **String** | | |
8
- | **byte_size** | **Integer** | | |
9
- | **kind** | **String** | | |
10
- | **max_byte_size** | **Integer** | | |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'peal'
16
-
17
- instance = Peal::MediaTooLargeEncoded.new(
18
- _tag: null,
19
- byte_size: null,
20
- kind: null,
21
- max_byte_size: null
22
- )
23
- ```
24
-
data/docs/MediaUsage.md DELETED
@@ -1,20 +0,0 @@
1
- # Peal::MediaUsage
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **drafts** | **Array<String>** | | |
8
- | **scheduled** | **Array<String>** | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'peal'
14
-
15
- instance = Peal::MediaUsage.new(
16
- drafts: null,
17
- scheduled: null
18
- )
19
- ```
20
-
data/docs/MembersApi.md DELETED
@@ -1,77 +0,0 @@
1
- # Peal::MembersApi
2
-
3
- All URIs are relative to *https://app.peal.social*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**members_list**](MembersApi.md#members_list) | **GET** /api/workspaces/{workspaceId}/members | List members |
8
-
9
-
10
- ## members_list
11
-
12
- > <Array<WorkspaceMember>> members_list(workspace_id)
13
-
14
- List members
15
-
16
- Lists the workspace's members, in the order they joined, with their name, email address and role. Every member may see them, as the workspace's settings show them; an API key may not, as members' addresses are not a script's to read.
17
-
18
- ### Examples
19
-
20
- ```ruby
21
- require 'time'
22
- require 'peal'
23
- # setup authorization
24
- Peal.configure do |config|
25
- # Configure Bearer authorization: bearer
26
- config.access_token = 'YOUR_BEARER_TOKEN'
27
- end
28
-
29
- api_instance = Peal::MembersApi.new
30
- workspace_id = 'workspace_id_example' # String |
31
-
32
- begin
33
- # List members
34
- result = api_instance.members_list(workspace_id)
35
- p result
36
- rescue Peal::ApiError => e
37
- puts "Error when calling MembersApi->members_list: #{e}"
38
- end
39
- ```
40
-
41
- #### Using the members_list_with_http_info variant
42
-
43
- This returns an Array which contains the response data, status code and headers.
44
-
45
- > <Array(<Array<WorkspaceMember>>, Integer, Hash)> members_list_with_http_info(workspace_id)
46
-
47
- ```ruby
48
- begin
49
- # List members
50
- data, status_code, headers = api_instance.members_list_with_http_info(workspace_id)
51
- p status_code # => 2xx
52
- p headers # => { ... }
53
- p data # => <Array<WorkspaceMember>>
54
- rescue Peal::ApiError => e
55
- puts "Error when calling MembersApi->members_list_with_http_info: #{e}"
56
- end
57
- ```
58
-
59
- ### Parameters
60
-
61
- | Name | Type | Description | Notes |
62
- | ---- | ---- | ----------- | ----- |
63
- | **workspace_id** | **String** | | |
64
-
65
- ### Return type
66
-
67
- [**Array&lt;WorkspaceMember&gt;**](WorkspaceMember.md)
68
-
69
- ### Authorization
70
-
71
- [bearer](../README.md#bearer)
72
-
73
- ### HTTP request headers
74
-
75
- - **Content-Type**: Not defined
76
- - **Accept**: application/json
77
-
data/docs/Membership.md DELETED
@@ -1,26 +0,0 @@
1
- # Peal::Membership
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | |
8
- | **name** | **String** | | |
9
- | **permissions** | **Array&lt;String&gt;** | | |
10
- | **role** | **String** | | |
11
- | **slug** | **String** | | |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'peal'
17
-
18
- instance = Peal::Membership.new(
19
- id: null,
20
- name: null,
21
- permissions: null,
22
- role: null,
23
- slug: null
24
- )
25
- ```
26
-
data/docs/MetricTotals.md DELETED
@@ -1,28 +0,0 @@
1
- # Peal::MetricTotals
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **impressions** | **Integer** | | |
8
- | **likes** | **Integer** | | |
9
- | **posts** | **Integer** | | |
10
- | **quotes** | **Integer** | | |
11
- | **replies** | **Integer** | | |
12
- | **reposts** | **Integer** | | |
13
-
14
- ## Example
15
-
16
- ```ruby
17
- require 'peal'
18
-
19
- instance = Peal::MetricTotals.new(
20
- impressions: null,
21
- likes: null,
22
- posts: null,
23
- quotes: null,
24
- replies: null,
25
- reposts: null
26
- )
27
- ```
28
-
@@ -1,20 +0,0 @@
1
- # Peal::MetricsSnapshot
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **collected_at** | **String** | | |
8
- | **metrics** | [**PostMetrics**](PostMetrics.md) | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'peal'
14
-
15
- instance = Peal::MetricsSnapshot.new(
16
- collected_at: null,
17
- metrics: null
18
- )
19
- ```
20
-
data/docs/NewApiKey.md DELETED
@@ -1,22 +0,0 @@
1
- # Peal::NewApiKey
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **expires_in_days** | **Integer** | | [optional] |
8
- | **name** | **String** | | |
9
- | **permissions** | **Array&lt;String&gt;** | | |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'peal'
15
-
16
- instance = Peal::NewApiKey.new(
17
- expires_in_days: null,
18
- name: null,
19
- permissions: null
20
- )
21
- ```
22
-
@@ -1,20 +0,0 @@
1
- # Peal::NewInvitation
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **email** | **String** | | |
8
- | **role** | [**Role**](Role.md) | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'peal'
14
-
15
- instance = Peal::NewInvitation.new(
16
- email: null,
17
- role: null
18
- )
19
- ```
20
-
data/docs/NewUpload.md DELETED
@@ -1,22 +0,0 @@
1
- # Peal::NewUpload
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **alt_text** | **String** | | [optional] |
8
- | **byte_size** | **Integer** | | |
9
- | **content_type** | **String** | | |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'peal'
15
-
16
- instance = Peal::NewUpload.new(
17
- alt_text: null,
18
- byte_size: null,
19
- content_type: null
20
- )
21
- ```
22
-
@@ -1,15 +0,0 @@
1
- # Peal::NonFiniteNumber
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'peal'
12
-
13
- instance = Peal::NonFiniteNumber.new()
14
- ```
15
-
data/docs/Notice.md DELETED
@@ -1,26 +0,0 @@
1
- # Peal::Notice
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **created_at** | **String** | | |
8
- | **event** | [**NoticeEvent**](NoticeEvent.md) | | |
9
- | **id** | **String** | | |
10
- | **read_at** | **String** | | |
11
- | **workspace_id** | **String** | | |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'peal'
17
-
18
- instance = Peal::Notice.new(
19
- created_at: null,
20
- event: null,
21
- id: null,
22
- read_at: null,
23
- workspace_id: null
24
- )
25
- ```
26
-
@@ -1,20 +0,0 @@
1
- # Peal::NoticeChannel
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **handle** | **String** | | |
8
- | **platform** | [**Platform**](Platform.md) | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'peal'
14
-
15
- instance = Peal::NoticeChannel.new(
16
- handle: null,
17
- platform: null
18
- )
19
- ```
20
-
data/docs/NoticeEvent.md DELETED
@@ -1,28 +0,0 @@
1
- # Peal::NoticeEvent
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **_tag** | **String** | | |
8
- | **channel** | [**NoticeChannel**](NoticeChannel.md) | | |
9
- | **permalink** | **String** | | |
10
- | **post_id** | **String** | | |
11
- | **reason** | [**FailureReason**](FailureReason.md) | | |
12
- | **expires_at** | **String** | | |
13
-
14
- ## Example
15
-
16
- ```ruby
17
- require 'peal'
18
-
19
- instance = Peal::NoticeEvent.new(
20
- _tag: null,
21
- channel: null,
22
- permalink: null,
23
- post_id: null,
24
- reason: null,
25
- expires_at: null
26
- )
27
- ```
28
-
@@ -1,24 +0,0 @@
1
- # Peal::NoticeEventAnyOf
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **_tag** | **String** | | |
8
- | **channel** | [**NoticeChannel**](NoticeChannel.md) | | |
9
- | **permalink** | **String** | | |
10
- | **post_id** | **String** | | |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'peal'
16
-
17
- instance = Peal::NoticeEventAnyOf.new(
18
- _tag: null,
19
- channel: null,
20
- permalink: null,
21
- post_id: null
22
- )
23
- ```
24
-
@@ -1,24 +0,0 @@
1
- # Peal::NoticeEventAnyOf1
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **_tag** | **String** | | |
8
- | **channel** | [**NoticeChannel**](NoticeChannel.md) | | |
9
- | **post_id** | **String** | | |
10
- | **reason** | [**FailureReason**](FailureReason.md) | | |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'peal'
16
-
17
- instance = Peal::NoticeEventAnyOf1.new(
18
- _tag: null,
19
- channel: null,
20
- post_id: null,
21
- reason: null
22
- )
23
- ```
24
-
@@ -1,22 +0,0 @@
1
- # Peal::NoticeEventAnyOf2
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **_tag** | **String** | | |
8
- | **channel** | [**NoticeChannel**](NoticeChannel.md) | | |
9
- | **post_id** | **String** | | |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'peal'
15
-
16
- instance = Peal::NoticeEventAnyOf2.new(
17
- _tag: null,
18
- channel: null,
19
- post_id: null
20
- )
21
- ```
22
-
@@ -1,20 +0,0 @@
1
- # Peal::NoticeEventAnyOf3
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **_tag** | **String** | | |
8
- | **channel** | [**NoticeChannel**](NoticeChannel.md) | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'peal'
14
-
15
- instance = Peal::NoticeEventAnyOf3.new(
16
- _tag: null,
17
- channel: null
18
- )
19
- ```
20
-