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.
- checksums.yaml +4 -4
- data/NOTICE +4 -0
- data/README.md +5 -4
- data/lib/peal/models/api_key.rb +11 -23
- data/lib/peal/models/membership.rb +11 -23
- data/lib/peal/models/new_api_key.rb +15 -23
- data/lib/peal/models/permission.rb +66 -0
- data/lib/peal/version.rb +1 -1
- data/lib/peal.rb +1 -0
- metadata +3 -220
- data/Gemfile +0 -9
- data/Gemfile.lock +0 -136
- data/Rakefile +0 -10
- data/docs/AlreadyMemberEncoded.md +0 -18
- data/docs/AltTextTooLongEncoded.md +0 -20
- data/docs/AnalyticsApi.md +0 -155
- data/docs/AnalyticsSummary.md +0 -30
- data/docs/ApiKey.md +0 -28
- data/docs/ApiKeyNotFoundEncoded.md +0 -18
- data/docs/ApiKeysApi.md +0 -220
- data/docs/ApiKeysRevoke404Response.md +0 -18
- data/docs/AssistantAction.md +0 -24
- data/docs/AssistantActionAnyOf.md +0 -20
- data/docs/AssistantActionAnyOf1.md +0 -20
- data/docs/AssistantActionAnyOf2.md +0 -20
- data/docs/AssistantActionAnyOf3.md +0 -18
- data/docs/AssistantApi.md +0 -149
- data/docs/AssistantFailedEncoded.md +0 -20
- data/docs/AssistantInputRejectedEncoded.md +0 -22
- data/docs/AssistantQuotaExceededEncoded.md +0 -22
- data/docs/AssistantStatus.md +0 -26
- data/docs/AssistantTone.md +0 -15
- data/docs/AssistantUnavailableEncoded.md +0 -18
- data/docs/AttemptResult.md +0 -15
- data/docs/Authorization.md +0 -18
- data/docs/Billing.md +0 -28
- data/docs/BillingApi.md +0 -77
- data/docs/BillingSubscription.md +0 -24
- data/docs/Channel.md +0 -30
- data/docs/ChannelCannotPostEncoded.md +0 -20
- data/docs/ChannelMetrics.md +0 -30
- data/docs/ChannelNotFoundEncoded.md +0 -18
- data/docs/ChannelOptions.md +0 -20
- data/docs/ChannelStatus.md +0 -20
- data/docs/ChannelStatusAnyOf.md +0 -18
- data/docs/ChannelStatusAnyOf1.md +0 -18
- data/docs/ChannelStatusAnyOf2.md +0 -20
- data/docs/ChannelsApi.md +0 -512
- data/docs/ChannelsCompleteConnect404Response.md +0 -18
- data/docs/ChoosableAccount.md +0 -26
- data/docs/ChooseAccounts.md +0 -20
- data/docs/ConnectCallback.md +0 -24
- data/docs/ConnectChannel.md +0 -20
- data/docs/ConnectFailedEncoded.md +0 -20
- data/docs/ConnectFailureReason.md +0 -15
- data/docs/ConnectOutcome.md +0 -26
- data/docs/ConnectOutcomeAnyOf.md +0 -20
- data/docs/ConnectOutcomeAnyOf1.md +0 -24
- data/docs/ConnectablePlatforms.md +0 -18
- data/docs/ContentViolation.md +0 -54
- data/docs/ContentViolationAnyOf.md +0 -18
- data/docs/ContentViolationAnyOf1.md +0 -20
- data/docs/ContentViolationAnyOf10.md +0 -26
- data/docs/ContentViolationAnyOf11.md +0 -22
- data/docs/ContentViolationAnyOf12.md +0 -26
- data/docs/ContentViolationAnyOf13.md +0 -26
- data/docs/ContentViolationAnyOf14.md +0 -26
- data/docs/ContentViolationAnyOf15.md +0 -26
- data/docs/ContentViolationAnyOf16.md +0 -22
- data/docs/ContentViolationAnyOf17.md +0 -26
- data/docs/ContentViolationAnyOf18.md +0 -28
- data/docs/ContentViolationAnyOf19.md +0 -28
- data/docs/ContentViolationAnyOf2.md +0 -20
- data/docs/ContentViolationAnyOf20.md +0 -28
- data/docs/ContentViolationAnyOf21.md +0 -28
- data/docs/ContentViolationAnyOf22.md +0 -30
- data/docs/ContentViolationAnyOf23.md +0 -32
- data/docs/ContentViolationAnyOf24.md +0 -32
- data/docs/ContentViolationAnyOf24Maximum.md +0 -15
- data/docs/ContentViolationAnyOf25.md +0 -28
- data/docs/ContentViolationAnyOf3.md +0 -24
- data/docs/ContentViolationAnyOf4.md +0 -24
- data/docs/ContentViolationAnyOf5.md +0 -28
- data/docs/ContentViolationAnyOf6.md +0 -24
- data/docs/ContentViolationAnyOf7.md +0 -22
- data/docs/ContentViolationAnyOf8.md +0 -28
- data/docs/ContentViolationAnyOf9.md +0 -24
- data/docs/CreatedApiKey.md +0 -20
- data/docs/DatabaseUnavailableEncoded.md +0 -18
- data/docs/DraftPage.md +0 -20
- data/docs/EffectHttpApiErrorBadRequestEncoded.md +0 -18
- data/docs/EngagementDay.md +0 -26
- data/docs/FailureReason.md +0 -15
- data/docs/ForbiddenEncoded.md +0 -18
- data/docs/InvalidDateRangeEncoded.md +0 -18
- data/docs/InvalidTimeRangeEncoded.md +0 -18
- data/docs/InvalidTimeZoneEncoded.md +0 -20
- data/docs/Invitation.md +0 -28
- data/docs/InvitationNotFoundEncoded.md +0 -18
- data/docs/InvitationsApi.md +0 -220
- data/docs/InvitationsCreate409Response.md +0 -18
- data/docs/InvitationsRevoke404Response.md +0 -18
- data/docs/MarkNoticesRead.md +0 -18
- data/docs/Me.md +0 -22
- data/docs/MeUser.md +0 -28
- data/docs/Media.md +0 -40
- data/docs/MediaApi.md +0 -516
- data/docs/MediaAttachment.md +0 -20
- data/docs/MediaContentType.md +0 -15
- data/docs/MediaCreate422Response.md +0 -28
- data/docs/MediaDescription.md +0 -18
- data/docs/MediaDimensions.md +0 -20
- data/docs/MediaGet404Response.md +0 -18
- data/docs/MediaInUseEncoded.md +0 -20
- data/docs/MediaKind.md +0 -15
- data/docs/MediaNotFoundEncoded.md +0 -18
- data/docs/MediaPage.md +0 -20
- data/docs/MediaStatus.md +0 -22
- data/docs/MediaStatusAnyOf.md +0 -18
- data/docs/MediaStatusAnyOf1.md +0 -20
- data/docs/MediaStatusAnyOf2.md +0 -18
- data/docs/MediaStatusAnyOf3.md +0 -20
- data/docs/MediaStoreUnavailableEncoded.md +0 -18
- data/docs/MediaTooLargeEncoded.md +0 -24
- data/docs/MediaUsage.md +0 -20
- data/docs/MembersApi.md +0 -77
- data/docs/Membership.md +0 -26
- data/docs/MetricTotals.md +0 -28
- data/docs/MetricsSnapshot.md +0 -20
- data/docs/NewApiKey.md +0 -22
- data/docs/NewInvitation.md +0 -20
- data/docs/NewUpload.md +0 -22
- data/docs/NonFiniteNumber.md +0 -15
- data/docs/Notice.md +0 -26
- data/docs/NoticeChannel.md +0 -20
- data/docs/NoticeEvent.md +0 -28
- data/docs/NoticeEventAnyOf.md +0 -24
- data/docs/NoticeEventAnyOf1.md +0 -24
- data/docs/NoticeEventAnyOf2.md +0 -22
- data/docs/NoticeEventAnyOf3.md +0 -20
- data/docs/NoticeEventAnyOf4.md +0 -22
- data/docs/NoticePage.md +0 -20
- data/docs/NoticesApi.md +0 -285
- data/docs/NotificationPreferences.md +0 -20
- data/docs/NotificationPreferencesApi.md +0 -144
- data/docs/NotificationPreferencesChange.md +0 -20
- data/docs/NotificationPreferencesChangeEmail.md +0 -24
- data/docs/NotificationPreferencesEmail.md +0 -24
- data/docs/PaidPlan.md +0 -15
- data/docs/PeriodUsage.md +0 -20
- data/docs/Plan.md +0 -15
- data/docs/PlanAllowances.md +0 -24
- data/docs/PlanLimit.md +0 -15
- data/docs/PlanLimitReachedEncoded.md +0 -22
- data/docs/PlanOffer.md +0 -20
- data/docs/Platform.md +0 -15
- data/docs/PlatformUnreachableEncoded.md +0 -18
- data/docs/Post.md +0 -30
- data/docs/PostAnalytics.md +0 -20
- data/docs/PostContent.md +0 -22
- data/docs/PostContentInvalidEncoded.md +0 -20
- data/docs/PostDraft.md +0 -22
- data/docs/PostMetrics.md +0 -26
- data/docs/PostNotFoundEncoded.md +0 -18
- data/docs/PostOutcome.md +0 -15
- data/docs/PostSchedule.md +0 -20
- data/docs/PostStatus.md +0 -15
- data/docs/PostStatusConflictEncoded.md +0 -20
- data/docs/PostTarget.md +0 -36
- data/docs/PostTargetStatus.md +0 -15
- data/docs/PostsApi.md +0 -960
- data/docs/PostsCreate422Response.md +0 -24
- data/docs/PostsGet404Response.md +0 -18
- data/docs/PostsRepost409Response.md +0 -20
- data/docs/PostsSchedule422Response.md +0 -26
- data/docs/PreparedUpload.md +0 -20
- data/docs/ProbeState.md +0 -15
- data/docs/PublicationAttempt.md +0 -30
- data/docs/RejectionReason.md +0 -15
- data/docs/Role.md +0 -15
- data/docs/ScheduleInPastEncoded.md +0 -18
- data/docs/SchedulePost.md +0 -22
- data/docs/SessionApi.md +0 -74
- data/docs/SignedRequest.md +0 -22
- data/docs/SubscriptionStatus.md +0 -15
- data/docs/Suggestion.md +0 -22
- data/docs/SuggestionAnyOf.md +0 -20
- data/docs/SuggestionAnyOf1.md +0 -20
- data/docs/SuggestionRequest.md +0 -20
- data/docs/SystemApi.md +0 -129
- data/docs/TargetConfirmation.md +0 -20
- data/docs/TargetConfirmationAnyOf.md +0 -20
- data/docs/TargetConfirmationAnyOf1.md +0 -18
- data/docs/TargetMetrics.md +0 -32
- data/docs/TargetOptions.md +0 -48
- data/docs/TargetStatusConflictEncoded.md +0 -20
- data/docs/TextOverride.md +0 -20
- data/docs/TextUnit.md +0 -15
- data/docs/TikTokAccount.md +0 -20
- data/docs/TikTokAccountPosting.md +0 -22
- data/docs/TikTokAccountPostingAnyOf.md +0 -20
- data/docs/TikTokAccountPostingAnyOf1.md +0 -20
- data/docs/TikTokBlock.md +0 -15
- data/docs/TikTokCreator.md +0 -32
- data/docs/TikTokOptions.md +0 -34
- data/docs/TikTokPrivacyLevel.md +0 -15
- data/docs/TiktokApi.md +0 -79
- data/docs/TooManyInvitationsEncoded.md +0 -18
- data/docs/TopPost.md +0 -30
- data/docs/TranslationLanguage.md +0 -15
- data/docs/UnauthenticatedEncoded.md +0 -18
- data/docs/UnconfirmedReason.md +0 -15
- data/docs/UnknownChannelsEncoded.md +0 -20
- data/docs/UnknownMediaEncoded.md +0 -20
- data/docs/UnreadNotices.md +0 -18
- data/docs/UnsupportedMediaTypeEncoded.md +0 -20
- data/docs/UploadIncompleteEncoded.md +0 -18
- data/docs/UploadPart.md +0 -22
- data/docs/UploadRejectedEncoded.md +0 -20
- data/docs/UploadTarget.md +0 -26
- data/docs/UploadTargetAnyOf.md +0 -22
- data/docs/UploadTargetAnyOf1.md +0 -24
- data/docs/Usage.md +0 -24
- data/docs/WorkspaceMember.md +0 -26
- data/docs/WorkspaceNotFoundEncoded.md +0 -18
- data/docs/YouTubeOptions.md +0 -32
- data/docs/YouTubePrivacy.md +0 -15
- data/peal.gemspec +0 -41
- data/project.json +0 -17
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# Peal::PostsCreate422Response
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **_tag** | **String** | | |
|
|
8
|
-
| **violations** | [**Array<ContentViolation>**](ContentViolation.md) | | |
|
|
9
|
-
| **channel_ids** | **Array<String>** | | |
|
|
10
|
-
| **media_ids** | **Array<String>** | | |
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```ruby
|
|
15
|
-
require 'peal'
|
|
16
|
-
|
|
17
|
-
instance = Peal::PostsCreate422Response.new(
|
|
18
|
-
_tag: null,
|
|
19
|
-
violations: null,
|
|
20
|
-
channel_ids: null,
|
|
21
|
-
media_ids: null
|
|
22
|
-
)
|
|
23
|
-
```
|
|
24
|
-
|
data/docs/PostsGet404Response.md
DELETED
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
# Peal::PostsGet404Response
|
|
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::PostsGet404Response.new(
|
|
15
|
-
_tag: null
|
|
16
|
-
)
|
|
17
|
-
```
|
|
18
|
-
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# Peal::PostsRepost409Response
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **_tag** | **String** | | |
|
|
8
|
-
| **status** | [**PostTargetStatus**](PostTargetStatus.md) | | |
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```ruby
|
|
13
|
-
require 'peal'
|
|
14
|
-
|
|
15
|
-
instance = Peal::PostsRepost409Response.new(
|
|
16
|
-
_tag: null,
|
|
17
|
-
status: null
|
|
18
|
-
)
|
|
19
|
-
```
|
|
20
|
-
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# Peal::PostsSchedule422Response
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **_tag** | **String** | | |
|
|
8
|
-
| **time_zone** | **String** | | |
|
|
9
|
-
| **violations** | [**Array<ContentViolation>**](ContentViolation.md) | | |
|
|
10
|
-
| **channel_ids** | **Array<String>** | | |
|
|
11
|
-
| **media_ids** | **Array<String>** | | |
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```ruby
|
|
16
|
-
require 'peal'
|
|
17
|
-
|
|
18
|
-
instance = Peal::PostsSchedule422Response.new(
|
|
19
|
-
_tag: null,
|
|
20
|
-
time_zone: null,
|
|
21
|
-
violations: null,
|
|
22
|
-
channel_ids: null,
|
|
23
|
-
media_ids: null
|
|
24
|
-
)
|
|
25
|
-
```
|
|
26
|
-
|
data/docs/PreparedUpload.md
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# Peal::PreparedUpload
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **media** | [**Media**](Media.md) | | |
|
|
8
|
-
| **upload** | [**UploadTarget**](UploadTarget.md) | | |
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```ruby
|
|
13
|
-
require 'peal'
|
|
14
|
-
|
|
15
|
-
instance = Peal::PreparedUpload.new(
|
|
16
|
-
media: null,
|
|
17
|
-
upload: null
|
|
18
|
-
)
|
|
19
|
-
```
|
|
20
|
-
|
data/docs/ProbeState.md
DELETED
data/docs/PublicationAttempt.md
DELETED
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
# Peal::PublicationAttempt
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **attempt** | **Integer** | | |
|
|
8
|
-
| **finished_at** | **String** | | |
|
|
9
|
-
| **result** | [**AttemptResult**](AttemptResult.md) | | |
|
|
10
|
-
| **retry_at** | **String** | | |
|
|
11
|
-
| **round** | **Integer** | | |
|
|
12
|
-
| **started_at** | **String** | | |
|
|
13
|
-
| **target_id** | **String** | | |
|
|
14
|
-
|
|
15
|
-
## Example
|
|
16
|
-
|
|
17
|
-
```ruby
|
|
18
|
-
require 'peal'
|
|
19
|
-
|
|
20
|
-
instance = Peal::PublicationAttempt.new(
|
|
21
|
-
attempt: null,
|
|
22
|
-
finished_at: null,
|
|
23
|
-
result: null,
|
|
24
|
-
retry_at: null,
|
|
25
|
-
round: null,
|
|
26
|
-
started_at: null,
|
|
27
|
-
target_id: null
|
|
28
|
-
)
|
|
29
|
-
```
|
|
30
|
-
|
data/docs/RejectionReason.md
DELETED
data/docs/Role.md
DELETED
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
# Peal::ScheduleInPastEncoded
|
|
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::ScheduleInPastEncoded.new(
|
|
15
|
-
_tag: null
|
|
16
|
-
)
|
|
17
|
-
```
|
|
18
|
-
|
data/docs/SchedulePost.md
DELETED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# Peal::SchedulePost
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **at** | **String** | | |
|
|
8
|
-
| **channel_ids** | **Array<String>** | | |
|
|
9
|
-
| **time_zone** | **String** | | |
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```ruby
|
|
14
|
-
require 'peal'
|
|
15
|
-
|
|
16
|
-
instance = Peal::SchedulePost.new(
|
|
17
|
-
at: null,
|
|
18
|
-
channel_ids: null,
|
|
19
|
-
time_zone: null
|
|
20
|
-
)
|
|
21
|
-
```
|
|
22
|
-
|
data/docs/SessionApi.md
DELETED
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
# Peal::SessionApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *https://app.peal.social*
|
|
4
|
-
|
|
5
|
-
| Method | HTTP request | Description |
|
|
6
|
-
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**session_me**](SessionApi.md#session_me) | **GET** /api/me | Get the signed-in user |
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
## session_me
|
|
11
|
-
|
|
12
|
-
> <Me> session_me
|
|
13
|
-
|
|
14
|
-
Get the signed-in user
|
|
15
|
-
|
|
16
|
-
Answers with the signed-in user and every workspace they belong to, with their role and permissions in each. API keys belong to a workspace, not a user, and get 403.
|
|
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::SessionApi.new
|
|
30
|
-
|
|
31
|
-
begin
|
|
32
|
-
# Get the signed-in user
|
|
33
|
-
result = api_instance.session_me
|
|
34
|
-
p result
|
|
35
|
-
rescue Peal::ApiError => e
|
|
36
|
-
puts "Error when calling SessionApi->session_me: #{e}"
|
|
37
|
-
end
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
#### Using the session_me_with_http_info variant
|
|
41
|
-
|
|
42
|
-
This returns an Array which contains the response data, status code and headers.
|
|
43
|
-
|
|
44
|
-
> <Array(<Me>, Integer, Hash)> session_me_with_http_info
|
|
45
|
-
|
|
46
|
-
```ruby
|
|
47
|
-
begin
|
|
48
|
-
# Get the signed-in user
|
|
49
|
-
data, status_code, headers = api_instance.session_me_with_http_info
|
|
50
|
-
p status_code # => 2xx
|
|
51
|
-
p headers # => { ... }
|
|
52
|
-
p data # => <Me>
|
|
53
|
-
rescue Peal::ApiError => e
|
|
54
|
-
puts "Error when calling SessionApi->session_me_with_http_info: #{e}"
|
|
55
|
-
end
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
### Parameters
|
|
59
|
-
|
|
60
|
-
This endpoint does not need any parameter.
|
|
61
|
-
|
|
62
|
-
### Return type
|
|
63
|
-
|
|
64
|
-
[**Me**](Me.md)
|
|
65
|
-
|
|
66
|
-
### Authorization
|
|
67
|
-
|
|
68
|
-
[bearer](../README.md#bearer)
|
|
69
|
-
|
|
70
|
-
### HTTP request headers
|
|
71
|
-
|
|
72
|
-
- **Content-Type**: Not defined
|
|
73
|
-
- **Accept**: application/json
|
|
74
|
-
|
data/docs/SignedRequest.md
DELETED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# Peal::SignedRequest
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **headers** | **Hash<String, String>** | | |
|
|
8
|
-
| **method** | **String** | | |
|
|
9
|
-
| **url** | **String** | | |
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```ruby
|
|
14
|
-
require 'peal'
|
|
15
|
-
|
|
16
|
-
instance = Peal::SignedRequest.new(
|
|
17
|
-
headers: null,
|
|
18
|
-
method: null,
|
|
19
|
-
url: null
|
|
20
|
-
)
|
|
21
|
-
```
|
|
22
|
-
|
data/docs/SubscriptionStatus.md
DELETED
data/docs/Suggestion.md
DELETED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# Peal::Suggestion
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **_tag** | **String** | | |
|
|
8
|
-
| **text** | **String** | | |
|
|
9
|
-
| **hashtags** | **Array<String>** | | |
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```ruby
|
|
14
|
-
require 'peal'
|
|
15
|
-
|
|
16
|
-
instance = Peal::Suggestion.new(
|
|
17
|
-
_tag: null,
|
|
18
|
-
text: null,
|
|
19
|
-
hashtags: null
|
|
20
|
-
)
|
|
21
|
-
```
|
|
22
|
-
|
data/docs/SuggestionAnyOf.md
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# Peal::SuggestionAnyOf
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **_tag** | **String** | | |
|
|
8
|
-
| **text** | **String** | | |
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```ruby
|
|
13
|
-
require 'peal'
|
|
14
|
-
|
|
15
|
-
instance = Peal::SuggestionAnyOf.new(
|
|
16
|
-
_tag: null,
|
|
17
|
-
text: null
|
|
18
|
-
)
|
|
19
|
-
```
|
|
20
|
-
|
data/docs/SuggestionAnyOf1.md
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# Peal::SuggestionAnyOf1
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **_tag** | **String** | | |
|
|
8
|
-
| **hashtags** | **Array<String>** | | |
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```ruby
|
|
13
|
-
require 'peal'
|
|
14
|
-
|
|
15
|
-
instance = Peal::SuggestionAnyOf1.new(
|
|
16
|
-
_tag: null,
|
|
17
|
-
hashtags: null
|
|
18
|
-
)
|
|
19
|
-
```
|
|
20
|
-
|
data/docs/SuggestionRequest.md
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# Peal::SuggestionRequest
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **action** | [**AssistantAction**](AssistantAction.md) | | |
|
|
8
|
-
| **text** | **String** | | |
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```ruby
|
|
13
|
-
require 'peal'
|
|
14
|
-
|
|
15
|
-
instance = Peal::SuggestionRequest.new(
|
|
16
|
-
action: null,
|
|
17
|
-
text: null
|
|
18
|
-
)
|
|
19
|
-
```
|
|
20
|
-
|
data/docs/SystemApi.md
DELETED
|
@@ -1,129 +0,0 @@
|
|
|
1
|
-
# Peal::SystemApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *https://app.peal.social*
|
|
4
|
-
|
|
5
|
-
| Method | HTTP request | Description |
|
|
6
|
-
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**health**](SystemApi.md#health) | **GET** /api/health | Check that the server is up |
|
|
8
|
-
| [**ready**](SystemApi.md#ready) | **GET** /api/ready | Check that the server can take traffic |
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
## health
|
|
12
|
-
|
|
13
|
-
> health
|
|
14
|
-
|
|
15
|
-
Check that the server is up
|
|
16
|
-
|
|
17
|
-
Answers as soon as the server is up, whatever the state of its database. Use it as a liveness or container health check.
|
|
18
|
-
|
|
19
|
-
### Examples
|
|
20
|
-
|
|
21
|
-
```ruby
|
|
22
|
-
require 'time'
|
|
23
|
-
require 'peal'
|
|
24
|
-
|
|
25
|
-
api_instance = Peal::SystemApi.new
|
|
26
|
-
|
|
27
|
-
begin
|
|
28
|
-
# Check that the server is up
|
|
29
|
-
api_instance.health
|
|
30
|
-
rescue Peal::ApiError => e
|
|
31
|
-
puts "Error when calling SystemApi->health: #{e}"
|
|
32
|
-
end
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
#### Using the health_with_http_info variant
|
|
36
|
-
|
|
37
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
38
|
-
|
|
39
|
-
> <Array(nil, Integer, Hash)> health_with_http_info
|
|
40
|
-
|
|
41
|
-
```ruby
|
|
42
|
-
begin
|
|
43
|
-
# Check that the server is up
|
|
44
|
-
data, status_code, headers = api_instance.health_with_http_info
|
|
45
|
-
p status_code # => 2xx
|
|
46
|
-
p headers # => { ... }
|
|
47
|
-
p data # => nil
|
|
48
|
-
rescue Peal::ApiError => e
|
|
49
|
-
puts "Error when calling SystemApi->health_with_http_info: #{e}"
|
|
50
|
-
end
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
### Parameters
|
|
54
|
-
|
|
55
|
-
This endpoint does not need any parameter.
|
|
56
|
-
|
|
57
|
-
### Return type
|
|
58
|
-
|
|
59
|
-
nil (empty response body)
|
|
60
|
-
|
|
61
|
-
### Authorization
|
|
62
|
-
|
|
63
|
-
No authorization required
|
|
64
|
-
|
|
65
|
-
### HTTP request headers
|
|
66
|
-
|
|
67
|
-
- **Content-Type**: Not defined
|
|
68
|
-
- **Accept**: Not defined
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
## ready
|
|
72
|
-
|
|
73
|
-
> ready
|
|
74
|
-
|
|
75
|
-
Check that the server can take traffic
|
|
76
|
-
|
|
77
|
-
Answers once the server can reach its database, and fails with DatabaseUnavailable while it cannot. Use it as a readiness check before sending traffic.
|
|
78
|
-
|
|
79
|
-
### Examples
|
|
80
|
-
|
|
81
|
-
```ruby
|
|
82
|
-
require 'time'
|
|
83
|
-
require 'peal'
|
|
84
|
-
|
|
85
|
-
api_instance = Peal::SystemApi.new
|
|
86
|
-
|
|
87
|
-
begin
|
|
88
|
-
# Check that the server can take traffic
|
|
89
|
-
api_instance.ready
|
|
90
|
-
rescue Peal::ApiError => e
|
|
91
|
-
puts "Error when calling SystemApi->ready: #{e}"
|
|
92
|
-
end
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
#### Using the ready_with_http_info variant
|
|
96
|
-
|
|
97
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
98
|
-
|
|
99
|
-
> <Array(nil, Integer, Hash)> ready_with_http_info
|
|
100
|
-
|
|
101
|
-
```ruby
|
|
102
|
-
begin
|
|
103
|
-
# Check that the server can take traffic
|
|
104
|
-
data, status_code, headers = api_instance.ready_with_http_info
|
|
105
|
-
p status_code # => 2xx
|
|
106
|
-
p headers # => { ... }
|
|
107
|
-
p data # => nil
|
|
108
|
-
rescue Peal::ApiError => e
|
|
109
|
-
puts "Error when calling SystemApi->ready_with_http_info: #{e}"
|
|
110
|
-
end
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
### Parameters
|
|
114
|
-
|
|
115
|
-
This endpoint does not need any parameter.
|
|
116
|
-
|
|
117
|
-
### Return type
|
|
118
|
-
|
|
119
|
-
nil (empty response body)
|
|
120
|
-
|
|
121
|
-
### Authorization
|
|
122
|
-
|
|
123
|
-
No authorization required
|
|
124
|
-
|
|
125
|
-
### HTTP request headers
|
|
126
|
-
|
|
127
|
-
- **Content-Type**: Not defined
|
|
128
|
-
- **Accept**: application/json
|
|
129
|
-
|
data/docs/TargetConfirmation.md
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# Peal::TargetConfirmation
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **_tag** | **String** | | |
|
|
8
|
-
| **permalink** | **String** | | |
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```ruby
|
|
13
|
-
require 'peal'
|
|
14
|
-
|
|
15
|
-
instance = Peal::TargetConfirmation.new(
|
|
16
|
-
_tag: null,
|
|
17
|
-
permalink: null
|
|
18
|
-
)
|
|
19
|
-
```
|
|
20
|
-
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# Peal::TargetConfirmationAnyOf
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **_tag** | **String** | | |
|
|
8
|
-
| **permalink** | **String** | | |
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```ruby
|
|
13
|
-
require 'peal'
|
|
14
|
-
|
|
15
|
-
instance = Peal::TargetConfirmationAnyOf.new(
|
|
16
|
-
_tag: null,
|
|
17
|
-
permalink: null
|
|
18
|
-
)
|
|
19
|
-
```
|
|
20
|
-
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
# Peal::TargetConfirmationAnyOf1
|
|
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::TargetConfirmationAnyOf1.new(
|
|
15
|
-
_tag: null
|
|
16
|
-
)
|
|
17
|
-
```
|
|
18
|
-
|
data/docs/TargetMetrics.md
DELETED
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
# Peal::TargetMetrics
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **channel_id** | **String** | | |
|
|
8
|
-
| **collecting** | **Boolean** | | |
|
|
9
|
-
| **last_collected_at** | **String** | | |
|
|
10
|
-
| **latest** | [**PostMetrics**](PostMetrics.md) | | |
|
|
11
|
-
| **permalink** | **String** | | |
|
|
12
|
-
| **published_at** | **String** | | |
|
|
13
|
-
| **snapshots** | [**Array<MetricsSnapshot>**](MetricsSnapshot.md) | | |
|
|
14
|
-
| **target_id** | **String** | | |
|
|
15
|
-
|
|
16
|
-
## Example
|
|
17
|
-
|
|
18
|
-
```ruby
|
|
19
|
-
require 'peal'
|
|
20
|
-
|
|
21
|
-
instance = Peal::TargetMetrics.new(
|
|
22
|
-
channel_id: null,
|
|
23
|
-
collecting: null,
|
|
24
|
-
last_collected_at: null,
|
|
25
|
-
latest: null,
|
|
26
|
-
permalink: null,
|
|
27
|
-
published_at: null,
|
|
28
|
-
snapshots: null,
|
|
29
|
-
target_id: null
|
|
30
|
-
)
|
|
31
|
-
```
|
|
32
|
-
|