postboost 1.0.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 +7 -0
- data/Gemfile +9 -0
- data/LICENSE +21 -0
- data/README.md +0 -0
- data/Rakefile +10 -0
- data/docs/Account.md +34 -0
- data/docs/AccountsApi.md +149 -0
- data/docs/AddGenericSubscriptionRequest.md +22 -0
- data/docs/ChangeSubscriptionPlanRequest.md +24 -0
- data/docs/CheckoutSubscription200Response.md +18 -0
- data/docs/CheckoutSubscriptionRequest.md +22 -0
- data/docs/DeleteMediaBulkRequest.md +18 -0
- data/docs/DeleteMode.md +15 -0
- data/docs/DeletePostRequest.md +20 -0
- data/docs/DeletePostsBulkRequest.md +22 -0
- data/docs/DeleteReceiptsBulkRequest.md +18 -0
- data/docs/DeleteResult.md +22 -0
- data/docs/DeleteUser400Response.md +20 -0
- data/docs/DeleteUsersBulkRequest.md +18 -0
- data/docs/DeleteWorkspacesBulkRequest.md +18 -0
- data/docs/GetRemoteUploadStatus200Response.md +20 -0
- data/docs/InitiateChunkedUpload200Response.md +22 -0
- data/docs/InitiateChunkedUploadRequest.md +22 -0
- data/docs/InitiateRemoteUpload200Response.md +49 -0
- data/docs/InitiateRemoteUpload200ResponseOneOf.md +18 -0
- data/docs/InitiateRemoteUploadRequest.md +20 -0
- data/docs/ListAccounts200Response.md +18 -0
- data/docs/ListMedia200Response.md +22 -0
- data/docs/ListPosts200Response.md +22 -0
- data/docs/ListReceipts200Response.md +22 -0
- data/docs/ListTags200Response.md +18 -0
- data/docs/ListUsers200Response.md +22 -0
- data/docs/ListWorkspaces200Response.md +22 -0
- data/docs/Media.md +34 -0
- data/docs/MediaApi.md +810 -0
- data/docs/PaginationMeta.md +20 -0
- data/docs/PaginationMetaLinks.md +24 -0
- data/docs/PaginationMetaMeta.md +28 -0
- data/docs/Post.md +36 -0
- data/docs/PostContent.md +24 -0
- data/docs/PostInput.md +34 -0
- data/docs/PostStatus.md +15 -0
- data/docs/PostVersion.md +24 -0
- data/docs/PostsApi.md +659 -0
- data/docs/Receipt.md +36 -0
- data/docs/ReceiptInput.md +34 -0
- data/docs/ReceiptUpdateInput.md +32 -0
- data/docs/ReceiptsApi.md +421 -0
- data/docs/RemoveUserFromWorkspaceRequest.md +18 -0
- data/docs/SchedulePostRequest.md +18 -0
- data/docs/ScheduleResult.md +20 -0
- data/docs/Subscription.md +32 -0
- data/docs/SubscriptionInput.md +24 -0
- data/docs/SubscriptionStatus.md +15 -0
- data/docs/SubscriptionUpdateInput.md +24 -0
- data/docs/SubscriptionsApi.md +699 -0
- data/docs/Tag.md +24 -0
- data/docs/TagInput.md +20 -0
- data/docs/TagsApi.md +357 -0
- data/docs/UpdateMediaRequest.md +18 -0
- data/docs/UploadChunk200Response.md +18 -0
- data/docs/User.md +28 -0
- data/docs/UserInput.md +26 -0
- data/docs/UserUpdateInput.md +26 -0
- data/docs/UsersApi.md +419 -0
- data/docs/Workspace.md +28 -0
- data/docs/WorkspaceInput.md +24 -0
- data/docs/WorkspaceUserInput.md +24 -0
- data/docs/WorkspacesApi.md +637 -0
- data/git_push.sh +57 -0
- data/lib/postboost/api/accounts_api.rb +154 -0
- data/lib/postboost/api/media_api.rb +836 -0
- data/lib/postboost/api/posts_api.rb +673 -0
- data/lib/postboost/api/receipts_api.rb +409 -0
- data/lib/postboost/api/subscriptions_api.rb +689 -0
- data/lib/postboost/api/tags_api.rb +367 -0
- data/lib/postboost/api/users_api.rb +406 -0
- data/lib/postboost/api/workspaces_api.rb +640 -0
- data/lib/postboost/api_client.rb +394 -0
- data/lib/postboost/api_error.rb +58 -0
- data/lib/postboost/configuration.rb +308 -0
- data/lib/postboost/models/account.rb +321 -0
- data/lib/postboost/models/add_generic_subscription_request.rb +274 -0
- data/lib/postboost/models/change_subscription_plan_request.rb +303 -0
- data/lib/postboost/models/checkout_subscription200_response.rb +214 -0
- data/lib/postboost/models/checkout_subscription_request.rb +280 -0
- data/lib/postboost/models/delete_media_bulk_request.rb +224 -0
- data/lib/postboost/models/delete_mode.rb +41 -0
- data/lib/postboost/models/delete_post_request.rb +249 -0
- data/lib/postboost/models/delete_posts_bulk_request.rb +269 -0
- data/lib/postboost/models/delete_receipts_bulk_request.rb +223 -0
- data/lib/postboost/models/delete_result.rb +232 -0
- data/lib/postboost/models/delete_user400_response.rb +223 -0
- data/lib/postboost/models/delete_users_bulk_request.rb +223 -0
- data/lib/postboost/models/delete_workspaces_bulk_request.rb +223 -0
- data/lib/postboost/models/get_remote_upload_status200_response.rb +258 -0
- data/lib/postboost/models/initiate_chunked_upload200_response.rb +232 -0
- data/lib/postboost/models/initiate_chunked_upload_request.rb +273 -0
- data/lib/postboost/models/initiate_remote_upload200_response.rb +105 -0
- data/lib/postboost/models/initiate_remote_upload200_response_one_of.rb +214 -0
- data/lib/postboost/models/initiate_remote_upload_request.rb +250 -0
- data/lib/postboost/models/list_accounts200_response.rb +216 -0
- data/lib/postboost/models/list_media200_response.rb +241 -0
- data/lib/postboost/models/list_posts200_response.rb +241 -0
- data/lib/postboost/models/list_receipts200_response.rb +241 -0
- data/lib/postboost/models/list_tags200_response.rb +216 -0
- data/lib/postboost/models/list_users200_response.rb +241 -0
- data/lib/postboost/models/list_workspaces200_response.rb +241 -0
- data/lib/postboost/models/media.rb +320 -0
- data/lib/postboost/models/pagination_meta.rb +223 -0
- data/lib/postboost/models/pagination_meta_links.rb +241 -0
- data/lib/postboost/models/pagination_meta_meta.rb +259 -0
- data/lib/postboost/models/post.rb +323 -0
- data/lib/postboost/models/post_content.rb +247 -0
- data/lib/postboost/models/post_input.rb +324 -0
- data/lib/postboost/models/post_status.rb +41 -0
- data/lib/postboost/models/post_version.rb +267 -0
- data/lib/postboost/models/receipt.rb +295 -0
- data/lib/postboost/models/receipt_input.rb +335 -0
- data/lib/postboost/models/receipt_update_input.rb +312 -0
- data/lib/postboost/models/remove_user_from_workspace_request.rb +221 -0
- data/lib/postboost/models/schedule_post_request.rb +221 -0
- data/lib/postboost/models/schedule_result.rb +223 -0
- data/lib/postboost/models/subscription.rb +299 -0
- data/lib/postboost/models/subscription_input.rb +285 -0
- data/lib/postboost/models/subscription_status.rb +44 -0
- data/lib/postboost/models/subscription_update_input.rb +279 -0
- data/lib/postboost/models/tag.rb +241 -0
- data/lib/postboost/models/tag_input.rb +237 -0
- data/lib/postboost/models/update_media_request.rb +222 -0
- data/lib/postboost/models/upload_chunk200_response.rb +215 -0
- data/lib/postboost/models/user.rb +259 -0
- data/lib/postboost/models/user_input.rb +304 -0
- data/lib/postboost/models/user_update_input.rb +272 -0
- data/lib/postboost/models/workspace.rb +293 -0
- data/lib/postboost/models/workspace_input.rb +315 -0
- data/lib/postboost/models/workspace_user_input.rb +303 -0
- data/lib/postboost/version.rb +15 -0
- data/lib/postboost.rb +103 -0
- data/postboost.gemspec +39 -0
- data/spec/api/accounts_api_spec.rb +60 -0
- data/spec/api/media_api_spec.rb +182 -0
- data/spec/api/posts_api_spec.rb +152 -0
- data/spec/api/receipts_api_spec.rb +103 -0
- data/spec/api/subscriptions_api_spec.rb +151 -0
- data/spec/api/tags_api_spec.rb +95 -0
- data/spec/api/users_api_spec.rb +102 -0
- data/spec/api/workspaces_api_spec.rb +142 -0
- data/spec/models/account_spec.rb +88 -0
- data/spec/models/add_generic_subscription_request_spec.rb +48 -0
- data/spec/models/change_subscription_plan_request_spec.rb +58 -0
- data/spec/models/checkout_subscription200_response_spec.rb +36 -0
- data/spec/models/checkout_subscription_request_spec.rb +52 -0
- data/spec/models/delete_media_bulk_request_spec.rb +36 -0
- data/spec/models/delete_mode_spec.rb +30 -0
- data/spec/models/delete_post_request_spec.rb +42 -0
- data/spec/models/delete_posts_bulk_request_spec.rb +48 -0
- data/spec/models/delete_receipts_bulk_request_spec.rb +36 -0
- data/spec/models/delete_result_spec.rb +48 -0
- data/spec/models/delete_user400_response_spec.rb +42 -0
- data/spec/models/delete_users_bulk_request_spec.rb +36 -0
- data/spec/models/delete_workspaces_bulk_request_spec.rb +36 -0
- data/spec/models/get_remote_upload_status200_response_spec.rb +46 -0
- data/spec/models/initiate_chunked_upload200_response_spec.rb +48 -0
- data/spec/models/initiate_chunked_upload_request_spec.rb +48 -0
- data/spec/models/initiate_remote_upload200_response_one_of_spec.rb +36 -0
- data/spec/models/initiate_remote_upload200_response_spec.rb +32 -0
- data/spec/models/initiate_remote_upload_request_spec.rb +42 -0
- data/spec/models/list_accounts200_response_spec.rb +36 -0
- data/spec/models/list_media200_response_spec.rb +48 -0
- data/spec/models/list_posts200_response_spec.rb +48 -0
- data/spec/models/list_receipts200_response_spec.rb +48 -0
- data/spec/models/list_tags200_response_spec.rb +36 -0
- data/spec/models/list_users200_response_spec.rb +48 -0
- data/spec/models/list_workspaces200_response_spec.rb +48 -0
- data/spec/models/media_spec.rb +88 -0
- data/spec/models/pagination_meta_links_spec.rb +54 -0
- data/spec/models/pagination_meta_meta_spec.rb +66 -0
- data/spec/models/pagination_meta_spec.rb +42 -0
- data/spec/models/post_content_spec.rb +54 -0
- data/spec/models/post_input_spec.rb +84 -0
- data/spec/models/post_spec.rb +90 -0
- data/spec/models/post_status_spec.rb +30 -0
- data/spec/models/post_version_spec.rb +54 -0
- data/spec/models/receipt_input_spec.rb +84 -0
- data/spec/models/receipt_spec.rb +90 -0
- data/spec/models/receipt_update_input_spec.rb +78 -0
- data/spec/models/remove_user_from_workspace_request_spec.rb +36 -0
- data/spec/models/schedule_post_request_spec.rb +36 -0
- data/spec/models/schedule_result_spec.rb +42 -0
- data/spec/models/subscription_input_spec.rb +54 -0
- data/spec/models/subscription_spec.rb +78 -0
- data/spec/models/subscription_status_spec.rb +30 -0
- data/spec/models/subscription_update_input_spec.rb +54 -0
- data/spec/models/tag_input_spec.rb +42 -0
- data/spec/models/tag_spec.rb +54 -0
- data/spec/models/update_media_request_spec.rb +36 -0
- data/spec/models/upload_chunk200_response_spec.rb +36 -0
- data/spec/models/user_input_spec.rb +60 -0
- data/spec/models/user_spec.rb +66 -0
- data/spec/models/user_update_input_spec.rb +60 -0
- data/spec/models/workspace_input_spec.rb +58 -0
- data/spec/models/workspace_spec.rb +70 -0
- data/spec/models/workspace_user_input_spec.rb +58 -0
- data/spec/spec_helper.rb +111 -0
- metadata +358 -0
data/docs/TagInput.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PostBoost::TagInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | |
|
|
8
|
+
| **hex_color** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'postboost'
|
|
14
|
+
|
|
15
|
+
instance = PostBoost::TagInput.new(
|
|
16
|
+
name: null,
|
|
17
|
+
hex_color: #3B82F6
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/TagsApi.md
ADDED
|
@@ -0,0 +1,357 @@
|
|
|
1
|
+
# PostBoost::TagsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://postboost.co/app/api*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_tag**](TagsApi.md#create_tag) | **POST** /{workspaceUuid}/tags | Create tag |
|
|
8
|
+
| [**delete_tag**](TagsApi.md#delete_tag) | **DELETE** /{workspaceUuid}/tags/{tagUuid} | Delete tag |
|
|
9
|
+
| [**get_tag**](TagsApi.md#get_tag) | **GET** /{workspaceUuid}/tags/{tagUuid} | Get tag |
|
|
10
|
+
| [**list_tags**](TagsApi.md#list_tags) | **GET** /{workspaceUuid}/tags | List tags |
|
|
11
|
+
| [**update_tag**](TagsApi.md#update_tag) | **PUT** /{workspaceUuid}/tags/{tagUuid} | Update tag |
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## create_tag
|
|
15
|
+
|
|
16
|
+
> <Tag> create_tag(workspace_uuid, tag_input)
|
|
17
|
+
|
|
18
|
+
Create tag
|
|
19
|
+
|
|
20
|
+
### Examples
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'time'
|
|
24
|
+
require 'postboost'
|
|
25
|
+
# setup authorization
|
|
26
|
+
PostBoost.configure do |config|
|
|
27
|
+
# Configure Bearer authorization: bearerAuth
|
|
28
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
api_instance = PostBoost::TagsApi.new
|
|
32
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
33
|
+
tag_input = PostBoost::TagInput.new({name: 'name_example', hex_color: '#3B82F6'}) # TagInput |
|
|
34
|
+
|
|
35
|
+
begin
|
|
36
|
+
# Create tag
|
|
37
|
+
result = api_instance.create_tag(workspace_uuid, tag_input)
|
|
38
|
+
p result
|
|
39
|
+
rescue PostBoost::ApiError => e
|
|
40
|
+
puts "Error when calling TagsApi->create_tag: #{e}"
|
|
41
|
+
end
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
#### Using the create_tag_with_http_info variant
|
|
45
|
+
|
|
46
|
+
This returns an Array which contains the response data, status code and headers.
|
|
47
|
+
|
|
48
|
+
> <Array(<Tag>, Integer, Hash)> create_tag_with_http_info(workspace_uuid, tag_input)
|
|
49
|
+
|
|
50
|
+
```ruby
|
|
51
|
+
begin
|
|
52
|
+
# Create tag
|
|
53
|
+
data, status_code, headers = api_instance.create_tag_with_http_info(workspace_uuid, tag_input)
|
|
54
|
+
p status_code # => 2xx
|
|
55
|
+
p headers # => { ... }
|
|
56
|
+
p data # => <Tag>
|
|
57
|
+
rescue PostBoost::ApiError => e
|
|
58
|
+
puts "Error when calling TagsApi->create_tag_with_http_info: #{e}"
|
|
59
|
+
end
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Parameters
|
|
63
|
+
|
|
64
|
+
| Name | Type | Description | Notes |
|
|
65
|
+
| ---- | ---- | ----------- | ----- |
|
|
66
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
67
|
+
| **tag_input** | [**TagInput**](TagInput.md) | | |
|
|
68
|
+
|
|
69
|
+
### Return type
|
|
70
|
+
|
|
71
|
+
[**Tag**](Tag.md)
|
|
72
|
+
|
|
73
|
+
### Authorization
|
|
74
|
+
|
|
75
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
76
|
+
|
|
77
|
+
### HTTP request headers
|
|
78
|
+
|
|
79
|
+
- **Content-Type**: application/json
|
|
80
|
+
- **Accept**: application/json
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
## delete_tag
|
|
84
|
+
|
|
85
|
+
> Object delete_tag(workspace_uuid, tag_uuid)
|
|
86
|
+
|
|
87
|
+
Delete tag
|
|
88
|
+
|
|
89
|
+
### Examples
|
|
90
|
+
|
|
91
|
+
```ruby
|
|
92
|
+
require 'time'
|
|
93
|
+
require 'postboost'
|
|
94
|
+
# setup authorization
|
|
95
|
+
PostBoost.configure do |config|
|
|
96
|
+
# Configure Bearer authorization: bearerAuth
|
|
97
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
api_instance = PostBoost::TagsApi.new
|
|
101
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
102
|
+
tag_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the tag.
|
|
103
|
+
|
|
104
|
+
begin
|
|
105
|
+
# Delete tag
|
|
106
|
+
result = api_instance.delete_tag(workspace_uuid, tag_uuid)
|
|
107
|
+
p result
|
|
108
|
+
rescue PostBoost::ApiError => e
|
|
109
|
+
puts "Error when calling TagsApi->delete_tag: #{e}"
|
|
110
|
+
end
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
#### Using the delete_tag_with_http_info variant
|
|
114
|
+
|
|
115
|
+
This returns an Array which contains the response data, status code and headers.
|
|
116
|
+
|
|
117
|
+
> <Array(Object, Integer, Hash)> delete_tag_with_http_info(workspace_uuid, tag_uuid)
|
|
118
|
+
|
|
119
|
+
```ruby
|
|
120
|
+
begin
|
|
121
|
+
# Delete tag
|
|
122
|
+
data, status_code, headers = api_instance.delete_tag_with_http_info(workspace_uuid, tag_uuid)
|
|
123
|
+
p status_code # => 2xx
|
|
124
|
+
p headers # => { ... }
|
|
125
|
+
p data # => Object
|
|
126
|
+
rescue PostBoost::ApiError => e
|
|
127
|
+
puts "Error when calling TagsApi->delete_tag_with_http_info: #{e}"
|
|
128
|
+
end
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### Parameters
|
|
132
|
+
|
|
133
|
+
| Name | Type | Description | Notes |
|
|
134
|
+
| ---- | ---- | ----------- | ----- |
|
|
135
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
136
|
+
| **tag_uuid** | **String** | UUID of the tag. | |
|
|
137
|
+
|
|
138
|
+
### Return type
|
|
139
|
+
|
|
140
|
+
**Object**
|
|
141
|
+
|
|
142
|
+
### Authorization
|
|
143
|
+
|
|
144
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
145
|
+
|
|
146
|
+
### HTTP request headers
|
|
147
|
+
|
|
148
|
+
- **Content-Type**: Not defined
|
|
149
|
+
- **Accept**: application/json
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
## get_tag
|
|
153
|
+
|
|
154
|
+
> <Tag> get_tag(workspace_uuid, tag_uuid)
|
|
155
|
+
|
|
156
|
+
Get tag
|
|
157
|
+
|
|
158
|
+
### Examples
|
|
159
|
+
|
|
160
|
+
```ruby
|
|
161
|
+
require 'time'
|
|
162
|
+
require 'postboost'
|
|
163
|
+
# setup authorization
|
|
164
|
+
PostBoost.configure do |config|
|
|
165
|
+
# Configure Bearer authorization: bearerAuth
|
|
166
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
167
|
+
end
|
|
168
|
+
|
|
169
|
+
api_instance = PostBoost::TagsApi.new
|
|
170
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
171
|
+
tag_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the tag.
|
|
172
|
+
|
|
173
|
+
begin
|
|
174
|
+
# Get tag
|
|
175
|
+
result = api_instance.get_tag(workspace_uuid, tag_uuid)
|
|
176
|
+
p result
|
|
177
|
+
rescue PostBoost::ApiError => e
|
|
178
|
+
puts "Error when calling TagsApi->get_tag: #{e}"
|
|
179
|
+
end
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
#### Using the get_tag_with_http_info variant
|
|
183
|
+
|
|
184
|
+
This returns an Array which contains the response data, status code and headers.
|
|
185
|
+
|
|
186
|
+
> <Array(<Tag>, Integer, Hash)> get_tag_with_http_info(workspace_uuid, tag_uuid)
|
|
187
|
+
|
|
188
|
+
```ruby
|
|
189
|
+
begin
|
|
190
|
+
# Get tag
|
|
191
|
+
data, status_code, headers = api_instance.get_tag_with_http_info(workspace_uuid, tag_uuid)
|
|
192
|
+
p status_code # => 2xx
|
|
193
|
+
p headers # => { ... }
|
|
194
|
+
p data # => <Tag>
|
|
195
|
+
rescue PostBoost::ApiError => e
|
|
196
|
+
puts "Error when calling TagsApi->get_tag_with_http_info: #{e}"
|
|
197
|
+
end
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
### Parameters
|
|
201
|
+
|
|
202
|
+
| Name | Type | Description | Notes |
|
|
203
|
+
| ---- | ---- | ----------- | ----- |
|
|
204
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
205
|
+
| **tag_uuid** | **String** | UUID of the tag. | |
|
|
206
|
+
|
|
207
|
+
### Return type
|
|
208
|
+
|
|
209
|
+
[**Tag**](Tag.md)
|
|
210
|
+
|
|
211
|
+
### Authorization
|
|
212
|
+
|
|
213
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
214
|
+
|
|
215
|
+
### HTTP request headers
|
|
216
|
+
|
|
217
|
+
- **Content-Type**: Not defined
|
|
218
|
+
- **Accept**: application/json
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
## list_tags
|
|
222
|
+
|
|
223
|
+
> <ListTags200Response> list_tags(workspace_uuid)
|
|
224
|
+
|
|
225
|
+
List tags
|
|
226
|
+
|
|
227
|
+
### Examples
|
|
228
|
+
|
|
229
|
+
```ruby
|
|
230
|
+
require 'time'
|
|
231
|
+
require 'postboost'
|
|
232
|
+
# setup authorization
|
|
233
|
+
PostBoost.configure do |config|
|
|
234
|
+
# Configure Bearer authorization: bearerAuth
|
|
235
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
236
|
+
end
|
|
237
|
+
|
|
238
|
+
api_instance = PostBoost::TagsApi.new
|
|
239
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
240
|
+
|
|
241
|
+
begin
|
|
242
|
+
# List tags
|
|
243
|
+
result = api_instance.list_tags(workspace_uuid)
|
|
244
|
+
p result
|
|
245
|
+
rescue PostBoost::ApiError => e
|
|
246
|
+
puts "Error when calling TagsApi->list_tags: #{e}"
|
|
247
|
+
end
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
#### Using the list_tags_with_http_info variant
|
|
251
|
+
|
|
252
|
+
This returns an Array which contains the response data, status code and headers.
|
|
253
|
+
|
|
254
|
+
> <Array(<ListTags200Response>, Integer, Hash)> list_tags_with_http_info(workspace_uuid)
|
|
255
|
+
|
|
256
|
+
```ruby
|
|
257
|
+
begin
|
|
258
|
+
# List tags
|
|
259
|
+
data, status_code, headers = api_instance.list_tags_with_http_info(workspace_uuid)
|
|
260
|
+
p status_code # => 2xx
|
|
261
|
+
p headers # => { ... }
|
|
262
|
+
p data # => <ListTags200Response>
|
|
263
|
+
rescue PostBoost::ApiError => e
|
|
264
|
+
puts "Error when calling TagsApi->list_tags_with_http_info: #{e}"
|
|
265
|
+
end
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
### Parameters
|
|
269
|
+
|
|
270
|
+
| Name | Type | Description | Notes |
|
|
271
|
+
| ---- | ---- | ----------- | ----- |
|
|
272
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
273
|
+
|
|
274
|
+
### Return type
|
|
275
|
+
|
|
276
|
+
[**ListTags200Response**](ListTags200Response.md)
|
|
277
|
+
|
|
278
|
+
### Authorization
|
|
279
|
+
|
|
280
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
281
|
+
|
|
282
|
+
### HTTP request headers
|
|
283
|
+
|
|
284
|
+
- **Content-Type**: Not defined
|
|
285
|
+
- **Accept**: application/json
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
## update_tag
|
|
289
|
+
|
|
290
|
+
> Object update_tag(workspace_uuid, tag_uuid, tag_input)
|
|
291
|
+
|
|
292
|
+
Update tag
|
|
293
|
+
|
|
294
|
+
### Examples
|
|
295
|
+
|
|
296
|
+
```ruby
|
|
297
|
+
require 'time'
|
|
298
|
+
require 'postboost'
|
|
299
|
+
# setup authorization
|
|
300
|
+
PostBoost.configure do |config|
|
|
301
|
+
# Configure Bearer authorization: bearerAuth
|
|
302
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
303
|
+
end
|
|
304
|
+
|
|
305
|
+
api_instance = PostBoost::TagsApi.new
|
|
306
|
+
workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
|
|
307
|
+
tag_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the tag.
|
|
308
|
+
tag_input = PostBoost::TagInput.new({name: 'name_example', hex_color: '#3B82F6'}) # TagInput |
|
|
309
|
+
|
|
310
|
+
begin
|
|
311
|
+
# Update tag
|
|
312
|
+
result = api_instance.update_tag(workspace_uuid, tag_uuid, tag_input)
|
|
313
|
+
p result
|
|
314
|
+
rescue PostBoost::ApiError => e
|
|
315
|
+
puts "Error when calling TagsApi->update_tag: #{e}"
|
|
316
|
+
end
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
#### Using the update_tag_with_http_info variant
|
|
320
|
+
|
|
321
|
+
This returns an Array which contains the response data, status code and headers.
|
|
322
|
+
|
|
323
|
+
> <Array(Object, Integer, Hash)> update_tag_with_http_info(workspace_uuid, tag_uuid, tag_input)
|
|
324
|
+
|
|
325
|
+
```ruby
|
|
326
|
+
begin
|
|
327
|
+
# Update tag
|
|
328
|
+
data, status_code, headers = api_instance.update_tag_with_http_info(workspace_uuid, tag_uuid, tag_input)
|
|
329
|
+
p status_code # => 2xx
|
|
330
|
+
p headers # => { ... }
|
|
331
|
+
p data # => Object
|
|
332
|
+
rescue PostBoost::ApiError => e
|
|
333
|
+
puts "Error when calling TagsApi->update_tag_with_http_info: #{e}"
|
|
334
|
+
end
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
### Parameters
|
|
338
|
+
|
|
339
|
+
| Name | Type | Description | Notes |
|
|
340
|
+
| ---- | ---- | ----------- | ----- |
|
|
341
|
+
| **workspace_uuid** | **String** | UUID of the workspace. | |
|
|
342
|
+
| **tag_uuid** | **String** | UUID of the tag. | |
|
|
343
|
+
| **tag_input** | [**TagInput**](TagInput.md) | | |
|
|
344
|
+
|
|
345
|
+
### Return type
|
|
346
|
+
|
|
347
|
+
**Object**
|
|
348
|
+
|
|
349
|
+
### Authorization
|
|
350
|
+
|
|
351
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
352
|
+
|
|
353
|
+
### HTTP request headers
|
|
354
|
+
|
|
355
|
+
- **Content-Type**: application/json
|
|
356
|
+
- **Accept**: application/json
|
|
357
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# PostBoost::UpdateMediaRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **alt_text** | **String** | Alternative text for accessibility. | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'postboost'
|
|
13
|
+
|
|
14
|
+
instance = PostBoost::UpdateMediaRequest.new(
|
|
15
|
+
alt_text: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# PostBoost::UploadChunk200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **received** | **Integer** | Number of chunks received so far. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'postboost'
|
|
13
|
+
|
|
14
|
+
instance = PostBoost::UploadChunk200Response.new(
|
|
15
|
+
received: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/User.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# PostBoost::User
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **Integer** | | [optional] |
|
|
8
|
+
| **name** | **String** | | [optional] |
|
|
9
|
+
| **email** | **String** | | [optional] |
|
|
10
|
+
| **is_admin** | **Boolean** | | [optional] |
|
|
11
|
+
| **email_verified_at** | **Time** | | [optional] |
|
|
12
|
+
| **created_at** | **Time** | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'postboost'
|
|
18
|
+
|
|
19
|
+
instance = PostBoost::User.new(
|
|
20
|
+
id: null,
|
|
21
|
+
name: null,
|
|
22
|
+
email: null,
|
|
23
|
+
is_admin: null,
|
|
24
|
+
email_verified_at: null,
|
|
25
|
+
created_at: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
data/docs/UserInput.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# PostBoost::UserInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | |
|
|
8
|
+
| **email** | **String** | | |
|
|
9
|
+
| **password** | **String** | | |
|
|
10
|
+
| **password_confirmation** | **String** | | |
|
|
11
|
+
| **is_admin** | **Boolean** | | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'postboost'
|
|
17
|
+
|
|
18
|
+
instance = PostBoost::UserInput.new(
|
|
19
|
+
name: null,
|
|
20
|
+
email: null,
|
|
21
|
+
password: null,
|
|
22
|
+
password_confirmation: null,
|
|
23
|
+
is_admin: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# PostBoost::UserUpdateInput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | |
|
|
8
|
+
| **email** | **String** | | |
|
|
9
|
+
| **password** | **String** | Omit or set to null to keep the current password. | [optional] |
|
|
10
|
+
| **password_confirmation** | **String** | | [optional] |
|
|
11
|
+
| **is_admin** | **Boolean** | | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'postboost'
|
|
17
|
+
|
|
18
|
+
instance = PostBoost::UserUpdateInput.new(
|
|
19
|
+
name: null,
|
|
20
|
+
email: null,
|
|
21
|
+
password: null,
|
|
22
|
+
password_confirmation: null,
|
|
23
|
+
is_admin: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|