postboost 1.0.0

data/docs/ReceiptInput.md

@@ -0,0 +1,34 @@
+# PostBoost::ReceiptInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** |  |  |
+| **transaction_id** | **String** |  |  |
+| **invoice_number** | **String** |  |  |
+| **amount** | **Float** |  |  |
+| **tax** | **Float** |  |  |
+| **currency** | **String** |  |  |
+| **description** | **String** |  | [optional] |
+| **receipt_url** | **String** |  | [optional] |
+| **paid_at** | **Date** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ReceiptInput.new(
+  workspace_uuid: null,
+  transaction_id: null,
+  invoice_number: null,
+  amount: null,
+  tax: null,
+  currency: USD,
+  description: null,
+  receipt_url: null,
+  paid_at: null
+)
+```
+

data/docs/ReceiptUpdateInput.md

@@ -0,0 +1,32 @@
+# PostBoost::ReceiptUpdateInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **String** |  |  |
+| **invoice_number** | **String** |  |  |
+| **amount** | **Float** |  |  |
+| **tax** | **Float** |  | [optional] |
+| **currency** | **String** |  |  |
+| **description** | **String** |  | [optional] |
+| **receipt_url** | **String** |  | [optional] |
+| **paid_at** | **Date** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ReceiptUpdateInput.new(
+  transaction_id: null,
+  invoice_number: null,
+  amount: null,
+  tax: null,
+  currency: null,
+  description: null,
+  receipt_url: null,
+  paid_at: null
+)
+```
+

data/docs/ReceiptsApi.md

@@ -0,0 +1,421 @@
+# PostBoost::ReceiptsApi
+
+All URIs are relative to *https://postboost.co/app/api*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_receipt**](ReceiptsApi.md#create_receipt) | **POST** /panel/receipts | Create receipt |
+| [**delete_receipt**](ReceiptsApi.md#delete_receipt) | **DELETE** /panel/receipts/{receiptUuid} | Delete receipt |
+| [**delete_receipts_bulk**](ReceiptsApi.md#delete_receipts_bulk) | **DELETE** /panel/receipts | Delete receipts (bulk) |
+| [**get_receipt**](ReceiptsApi.md#get_receipt) | **GET** /panel/receipts/{receiptUuid} | Get receipt |
+| [**list_receipts**](ReceiptsApi.md#list_receipts) | **GET** /panel/receipts | List receipts |
+| [**update_receipt**](ReceiptsApi.md#update_receipt) | **PUT** /panel/receipts/{receiptUuid} | Update receipt |
+
+
+## create_receipt
+
+> <Receipt> create_receipt(receipt_input)
+
+Create receipt
+
+### 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::ReceiptsApi.new
+receipt_input = PostBoost::ReceiptInput.new({workspace_uuid: 'workspace_uuid_example', transaction_id: 'transaction_id_example', invoice_number: 'invoice_number_example', amount: 3.56, tax: 3.56, currency: 'USD', paid_at: Date.today}) # ReceiptInput | 
+
+begin
+  # Create receipt
+  result = api_instance.create_receipt(receipt_input)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling ReceiptsApi->create_receipt: #{e}"
+end
+```
+
+#### Using the create_receipt_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Receipt>, Integer, Hash)> create_receipt_with_http_info(receipt_input)
+
+```ruby
+begin
+  # Create receipt
+  data, status_code, headers = api_instance.create_receipt_with_http_info(receipt_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Receipt>
+rescue PostBoost::ApiError => e
+  puts "Error when calling ReceiptsApi->create_receipt_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **receipt_input** | [**ReceiptInput**](ReceiptInput.md) |  |  |
+
+### Return type
+
+[**Receipt**](Receipt.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_receipt
+
+> Object delete_receipt(receipt_uuid)
+
+Delete receipt
+
+### 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::ReceiptsApi.new
+receipt_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the receipt.
+
+begin
+  # Delete receipt
+  result = api_instance.delete_receipt(receipt_uuid)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling ReceiptsApi->delete_receipt: #{e}"
+end
+```
+
+#### Using the delete_receipt_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> delete_receipt_with_http_info(receipt_uuid)
+
+```ruby
+begin
+  # Delete receipt
+  data, status_code, headers = api_instance.delete_receipt_with_http_info(receipt_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue PostBoost::ApiError => e
+  puts "Error when calling ReceiptsApi->delete_receipt_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **receipt_uuid** | **String** | UUID of the receipt. |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete_receipts_bulk
+
+> Object delete_receipts_bulk(delete_receipts_bulk_request)
+
+Delete receipts (bulk)
+
+### 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::ReceiptsApi.new
+delete_receipts_bulk_request = PostBoost::DeleteReceiptsBulkRequest.new({receipts: ['receipts_example']}) # DeleteReceiptsBulkRequest | 
+
+begin
+  # Delete receipts (bulk)
+  result = api_instance.delete_receipts_bulk(delete_receipts_bulk_request)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling ReceiptsApi->delete_receipts_bulk: #{e}"
+end
+```
+
+#### Using the delete_receipts_bulk_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> delete_receipts_bulk_with_http_info(delete_receipts_bulk_request)
+
+```ruby
+begin
+  # Delete receipts (bulk)
+  data, status_code, headers = api_instance.delete_receipts_bulk_with_http_info(delete_receipts_bulk_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue PostBoost::ApiError => e
+  puts "Error when calling ReceiptsApi->delete_receipts_bulk_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **delete_receipts_bulk_request** | [**DeleteReceiptsBulkRequest**](DeleteReceiptsBulkRequest.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_receipt
+
+> <Receipt> get_receipt(receipt_uuid)
+
+Get receipt
+
+### 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::ReceiptsApi.new
+receipt_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the receipt.
+
+begin
+  # Get receipt
+  result = api_instance.get_receipt(receipt_uuid)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling ReceiptsApi->get_receipt: #{e}"
+end
+```
+
+#### Using the get_receipt_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Receipt>, Integer, Hash)> get_receipt_with_http_info(receipt_uuid)
+
+```ruby
+begin
+  # Get receipt
+  data, status_code, headers = api_instance.get_receipt_with_http_info(receipt_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Receipt>
+rescue PostBoost::ApiError => e
+  puts "Error when calling ReceiptsApi->get_receipt_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **receipt_uuid** | **String** | UUID of the receipt. |  |
+
+### Return type
+
+[**Receipt**](Receipt.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_receipts
+
+> <ListReceipts200Response> list_receipts(opts)
+
+List receipts
+
+### 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::ReceiptsApi.new
+opts = {
+  workspace_uuid: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | 
+  invoice_number: 'invoice_number_example' # String | 
+}
+
+begin
+  # List receipts
+  result = api_instance.list_receipts(opts)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling ReceiptsApi->list_receipts: #{e}"
+end
+```
+
+#### Using the list_receipts_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListReceipts200Response>, Integer, Hash)> list_receipts_with_http_info(opts)
+
+```ruby
+begin
+  # List receipts
+  data, status_code, headers = api_instance.list_receipts_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListReceipts200Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling ReceiptsApi->list_receipts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** |  | [optional] |
+| **invoice_number** | **String** |  | [optional] |
+
+### Return type
+
+[**ListReceipts200Response**](ListReceipts200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_receipt
+
+> Object update_receipt(receipt_uuid, receipt_update_input)
+
+Update receipt
+
+### 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::ReceiptsApi.new
+receipt_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the receipt.
+receipt_update_input = PostBoost::ReceiptUpdateInput.new({transaction_id: 'transaction_id_example', invoice_number: 'invoice_number_example', amount: 3.56, currency: 'currency_example', paid_at: Date.today}) # ReceiptUpdateInput | 
+
+begin
+  # Update receipt
+  result = api_instance.update_receipt(receipt_uuid, receipt_update_input)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling ReceiptsApi->update_receipt: #{e}"
+end
+```
+
+#### Using the update_receipt_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> update_receipt_with_http_info(receipt_uuid, receipt_update_input)
+
+```ruby
+begin
+  # Update receipt
+  data, status_code, headers = api_instance.update_receipt_with_http_info(receipt_uuid, receipt_update_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue PostBoost::ApiError => e
+  puts "Error when calling ReceiptsApi->update_receipt_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **receipt_uuid** | **String** | UUID of the receipt. |  |
+| **receipt_update_input** | [**ReceiptUpdateInput**](ReceiptUpdateInput.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/RemoveUserFromWorkspaceRequest.md

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

data/docs/SchedulePostRequest.md

@@ -0,0 +1,18 @@
+# PostBoost::SchedulePostRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **post_now** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::SchedulePostRequest.new(
+  post_now: null
+)
+```
+

data/docs/ScheduleResult.md

@@ -0,0 +1,20 @@
+# PostBoost::ScheduleResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **scheduled_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::ScheduleResult.new(
+  success: null,
+  scheduled_at: 2025-06-01T10:00:00Z
+)
+```
+

data/docs/Subscription.md

@@ -0,0 +1,32 @@
+# PostBoost::Subscription
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **platform_subscription_id** | **String** |  | [optional] |
+| **platform_plan_id** | **String** |  | [optional] |
+| **status** | [**SubscriptionStatus**](SubscriptionStatus.md) |  | [optional] |
+| **recurring** | **Boolean** |  | [optional] |
+| **trial_ends_at** | **Time** |  | [optional] |
+| **paused_from** | **Time** |  | [optional] |
+| **ends_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::Subscription.new(
+  name: null,
+  platform_subscription_id: null,
+  platform_plan_id: null,
+  status: null,
+  recurring: null,
+  trial_ends_at: null,
+  paused_from: null,
+  ends_at: null
+)
+```
+

data/docs/SubscriptionInput.md

@@ -0,0 +1,24 @@
+# PostBoost::SubscriptionInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **platform_subscription_id** | **String** |  |  |
+| **platform_plan_id** | **String** |  |  |
+| **status** | [**SubscriptionStatus**](SubscriptionStatus.md) |  |  |
+| **trial_ends_at** | **Time** | Required when status is `trialing`. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::SubscriptionInput.new(
+  platform_subscription_id: null,
+  platform_plan_id: null,
+  status: null,
+  trial_ends_at: null
+)
+```
+

data/docs/SubscriptionStatus.md

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

data/docs/SubscriptionUpdateInput.md

@@ -0,0 +1,24 @@
+# PostBoost::SubscriptionUpdateInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **platform_plan_id** | **String** |  |  |
+| **status** | [**SubscriptionStatus**](SubscriptionStatus.md) |  |  |
+| **trial_ends_at** | **Time** | Required when status is `trialing`. | [optional] |
+| **paused_from** | **Time** | Required when status is `paused`. | [optional] |
+
+## Example
+
+```ruby
+require 'postboost'
+
+instance = PostBoost::SubscriptionUpdateInput.new(
+  platform_plan_id: null,
+  status: null,
+  trial_ends_at: null,
+  paused_from: null
+)
+```
+