postboost 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 69b47ffd2944596cfb6f7fe0d7b48f3f2331274977ab92955f8a6e6ae2e14920
+  data.tar.gz: 2d81ba41fd16eb6e79e64c9285753ff960cea738e6facbc6528b5dc50f5db62e
+SHA512:
+  metadata.gz: ddd0dfd8a3b77864e846970aeff826e882e28bf0f5213431d8096e12730b3f0043683720689205d1b5b38c325bb387e0aa10d25a76f0ab0df55abec460c9eda4
+  data.tar.gz: 4a07a1a17a732112644b0b1b5b8c5885895834d646371d48c477e35c49218e080ba9e5b733d89ba136d0ab0dcc665a6bd31b103c3d5c9b950b84ee129e689e00

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 PostBoost
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Account.md

@@ -0,0 +1,34 @@
+# PostBoost::Account
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **uuid** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **username** | **String** |  | [optional] |
+| **image** | **String** |  | [optional] |
+| **provider** | **String** |  | [optional] |
+| **data** | **Object** | Provider-specific metadata. | [optional] |
+| **authorized** | **Boolean** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::Account.new(
+  id: null,
+  uuid: null,
+  name: My Instagram,
+  username: myhandle,
+  image: null,
+  provider: null,
+  data: null,
+  authorized: null,
+  created_at: null
+)
+```
+

data/docs/AccountsApi.md

@@ -0,0 +1,149 @@
+# PostBoost::AccountsApi
+
+All URIs are relative to *https://postboost.co/app/api*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_account**](AccountsApi.md#get_account) | **GET** /{workspaceUuid}/accounts/{accountUuid} | Get account |
+| [**list_accounts**](AccountsApi.md#list_accounts) | **GET** /{workspaceUuid}/accounts | List accounts |
+
+
+## get_account
+
+> <Account> get_account(workspace_uuid, account_uuid)
+
+Get account
+
+Returns a single social media account.
+
+### Examples
+
+```ruby
+require 'time'
+require 'postboost'
+# setup authorization
+PostBoost.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PostBoost::AccountsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+account_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the social media account.
+
+begin
+  # Get account
+  result = api_instance.get_account(workspace_uuid, account_uuid)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountsApi->get_account: #{e}"
+end
+```
+
+#### Using the get_account_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Account>, Integer, Hash)> get_account_with_http_info(workspace_uuid, account_uuid)
+
+```ruby
+begin
+  # Get account
+  data, status_code, headers = api_instance.get_account_with_http_info(workspace_uuid, account_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Account>
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountsApi->get_account_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **account_uuid** | **String** | UUID of the social media account. |  |
+
+### Return type
+
+[**Account**](Account.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_accounts
+
+> <ListAccounts200Response> list_accounts(workspace_uuid)
+
+List accounts
+
+Returns all social media accounts connected to the workspace.
+
+### Examples
+
+```ruby
+require 'time'
+require 'postboost'
+# setup authorization
+PostBoost.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PostBoost::AccountsApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+
+begin
+  # List accounts
+  result = api_instance.list_accounts(workspace_uuid)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountsApi->list_accounts: #{e}"
+end
+```
+
+#### Using the list_accounts_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListAccounts200Response>, Integer, Hash)> list_accounts_with_http_info(workspace_uuid)
+
+```ruby
+begin
+  # List accounts
+  data, status_code, headers = api_instance.list_accounts_with_http_info(workspace_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListAccounts200Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling AccountsApi->list_accounts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+
+### Return type
+
+[**ListAccounts200Response**](ListAccounts200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AddGenericSubscriptionRequest.md

@@ -0,0 +1,22 @@
+# PostBoost::AddGenericSubscriptionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **plan_id** | **Integer** |  |  |
+| **trial_days** | **Integer** |  | [optional] |
+| **keep_prev_trial_ends_at** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::AddGenericSubscriptionRequest.new(
+  plan_id: null,
+  trial_days: null,
+  keep_prev_trial_ends_at: null
+)
+```
+

data/docs/ChangeSubscriptionPlanRequest.md

@@ -0,0 +1,24 @@
+# PostBoost::ChangeSubscriptionPlanRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **plan_id** | **Integer** |  |  |
+| **cycle** | **String** |  |  |
+| **prorate** | **Boolean** |  |  |
+| **billing_immediately** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ChangeSubscriptionPlanRequest.new(
+  plan_id: null,
+  cycle: null,
+  prorate: null,
+  billing_immediately: null
+)
+```
+

data/docs/CheckoutSubscription200Response.md

@@ -0,0 +1,18 @@
+# PostBoost::CheckoutSubscription200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::CheckoutSubscription200Response.new(
+  url: null
+)
+```
+

data/docs/CheckoutSubscriptionRequest.md

@@ -0,0 +1,22 @@
+# PostBoost::CheckoutSubscriptionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **plan_id** | **Integer** |  |  |
+| **cycle** | **String** |  |  |
+| **coupon** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::CheckoutSubscriptionRequest.new(
+  plan_id: null,
+  cycle: null,
+  coupon: null
+)
+```
+

data/docs/DeleteMediaBulkRequest.md

@@ -0,0 +1,18 @@
+# PostBoost::DeleteMediaBulkRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | **Array<Integer>** | Array of media IDs to delete. |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::DeleteMediaBulkRequest.new(
+  items: null
+)
+```
+

data/docs/DeleteMode.md

@@ -0,0 +1,15 @@
+# PostBoost::DeleteMode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::DeleteMode.new()
+```
+

data/docs/DeletePostRequest.md

@@ -0,0 +1,20 @@
+# PostBoost::DeletePostRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **trash** | **Boolean** |  | [optional][default to false] |
+| **delete_mode** | [**DeleteMode**](DeleteMode.md) |  | [optional][default to 'app_only'] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::DeletePostRequest.new(
+  trash: null,
+  delete_mode: null
+)
+```
+

data/docs/DeletePostsBulkRequest.md

@@ -0,0 +1,22 @@
+# PostBoost::DeletePostsBulkRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **posts** | **Array<String>** | Array of post UUIDs to delete. |  |
+| **trash** | **Boolean** | Move to trash instead of permanent delete. | [optional][default to false] |
+| **delete_mode** | [**DeleteMode**](DeleteMode.md) |  | [optional][default to 'app_only'] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::DeletePostsBulkRequest.new(
+  posts: null,
+  trash: null,
+  delete_mode: null
+)
+```
+

data/docs/DeleteReceiptsBulkRequest.md

@@ -0,0 +1,18 @@
+# PostBoost::DeleteReceiptsBulkRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **receipts** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::DeleteReceiptsBulkRequest.new(
+  receipts: null
+)
+```
+

data/docs/DeleteResult.md

@@ -0,0 +1,22 @@
+# PostBoost::DeleteResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deleted** | **Boolean** |  | [optional] |
+| **deleted_from_app** | **Boolean** |  | [optional] |
+| **to_trash** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::DeleteResult.new(
+  deleted: null,
+  deleted_from_app: null,
+  to_trash: null
+)
+```
+

data/docs/DeleteUser400Response.md

@@ -0,0 +1,20 @@
+# PostBoost::DeleteUser400Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::DeleteUser400Response.new(
+  success: false,
+  message: You cannot delete yourself.
+)
+```
+

data/docs/DeleteUsersBulkRequest.md

@@ -0,0 +1,18 @@
+# PostBoost::DeleteUsersBulkRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **users** | **Array<Integer>** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::DeleteUsersBulkRequest.new(
+  users: null
+)
+```
+

data/docs/DeleteWorkspacesBulkRequest.md

@@ -0,0 +1,18 @@
+# PostBoost::DeleteWorkspacesBulkRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspaces** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::DeleteWorkspacesBulkRequest.new(
+  workspaces: null
+)
+```
+

data/docs/GetRemoteUploadStatus200Response.md

@@ -0,0 +1,20 @@
+# PostBoost::GetRemoteUploadStatus200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional] |
+| **media** | [**Media**](Media.md) | Present when status is complete. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::GetRemoteUploadStatus200Response.new(
+  status: null,
+  media: null
+)
+```
+

data/docs/InitiateChunkedUpload200Response.md

@@ -0,0 +1,22 @@
+# PostBoost::InitiateChunkedUpload200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **upload_uuid** | **String** |  | [optional] |
+| **chunk_size** | **Integer** |  | [optional] |
+| **total_chunks** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::InitiateChunkedUpload200Response.new(
+  upload_uuid: null,
+  chunk_size: null,
+  total_chunks: null
+)
+```
+

data/docs/InitiateChunkedUploadRequest.md

@@ -0,0 +1,22 @@
+# PostBoost::InitiateChunkedUploadRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filename** | **String** |  |  |
+| **mime_type** | **String** |  |  |
+| **total_size** | **Integer** | Total file size in bytes. |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::InitiateChunkedUploadRequest.new(
+  filename: null,
+  mime_type: video/mp4,
+  total_size: null
+)
+```
+

data/docs/InitiateRemoteUpload200Response.md

@@ -0,0 +1,49 @@
+# PostBoost::InitiateRemoteUpload200Response
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'postboost'
+
+PostBoost::InitiateRemoteUpload200Response.openapi_one_of
+# =>
+# [
+#   :'InitiateRemoteUpload200ResponseOneOf',
+#   :'Media'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'postboost'
+
+PostBoost::InitiateRemoteUpload200Response.build(data)
+# => #<InitiateRemoteUpload200ResponseOneOf:0x00007fdd4aab02a0>
+
+PostBoost::InitiateRemoteUpload200Response.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `InitiateRemoteUpload200ResponseOneOf`
+- `Media`
+- `nil` (if no type matches)
+

data/docs/InitiateRemoteUpload200ResponseOneOf.md

@@ -0,0 +1,18 @@
+# PostBoost::InitiateRemoteUpload200ResponseOneOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **download_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::InitiateRemoteUpload200ResponseOneOf.new(
+  download_id: null
+)
+```
+

data/docs/InitiateRemoteUploadRequest.md

@@ -0,0 +1,20 @@
+# PostBoost::InitiateRemoteUploadRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | URL of the remote file to download. |  |
+| **alt_text** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::InitiateRemoteUploadRequest.new(
+  url: null,
+  alt_text: null
+)
+```
+

data/docs/ListAccounts200Response.md

@@ -0,0 +1,18 @@
+# PostBoost::ListAccounts200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Account>**](Account.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ListAccounts200Response.new(
+  data: null
+)
+```
+