osuny_api 0.2.6 → 1.0.0

data/docs/CommunicationWebsiteAgendaEventLocalization.md

@@ -0,0 +1,25 @@
+# OsunyApi::CommunicationWebsiteAgendaEventLocalization
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**migration_identifier** | **String** |  | [optional] 
+**title** | **String** |  | [optional] 
+**featured_image** | [**CommunicationWebsiteAgendaCategoryLocalizationFeaturedImage**](CommunicationWebsiteAgendaCategoryLocalizationFeaturedImage.md) |  | [optional] 
+**meta_description** | **String** |  | [optional] 
+**published** | **BOOLEAN** |  | [optional] 
+**published_at** | **DateTime** |  | [optional] 
+**slug** | **String** |  | [optional] 
+**subtitle** | **String** |  | [optional] 
+**summary** | **String** |  | [optional] 
+**text** | **String** |  | [optional] 
+**notes** | **String** |  | [optional] 
+**header_cta** | **BOOLEAN** |  | [optional] 
+**header_cta_label** | **String** |  | [optional] 
+**header_cta_url** | **String** |  | [optional] 
+**add_to_calendar_urls** | [**CommunicationWebsiteAgendaEventLocalizationAddToCalendarUrls**](CommunicationWebsiteAgendaEventLocalizationAddToCalendarUrls.md) |  | [optional] 
+**blocks** | [**Array<OneOfcommunicationWebsiteAgendaEventLocalizationBlocksItems>**](.md) |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+

data/docs/CommunicationWebsiteAgendaEventLocalizationAddToCalendarUrls.md

@@ -0,0 +1,11 @@
+# OsunyApi::CommunicationWebsiteAgendaEventLocalizationAddToCalendarUrls
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**google** | **String** |  | [optional] 
+**yahoo** | **String** |  | [optional] 
+**office** | **String** |  | [optional] 
+**outlook** | **String** |  | [optional] 
+**ical** | **String** |  | [optional] 
+

data/docs/CommunicationWebsiteAgendaEventTimeSlot.md

@@ -0,0 +1,13 @@
+# OsunyApi::CommunicationWebsiteAgendaEventTimeSlot
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**migration_identifier** | **String** |  | [optional] 
+**datetime** | **DateTime** |  | [optional] 
+**duration** | **Integer** | Duration of the time slot (in seconds). | [optional] 
+**localizations** | [**Hash<String, CommunicationWebsiteAgendaEventTimeSlotLocalization>**](CommunicationWebsiteAgendaEventTimeSlotLocalization.md) | Localizations of the time slot. The key is the language's ISO 639-1 code. | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+

data/docs/CommunicationWebsiteAgendaEventTimeSlotLocalization.md

@@ -0,0 +1,13 @@
+# OsunyApi::CommunicationWebsiteAgendaEventTimeSlotLocalization
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**migration_identifier** | **String** |  | [optional] 
+**place** | **String** |  | [optional] 
+**slug** | **String** | Read-only, slug is force-generated. | [optional] 
+**add_to_calendar_urls** | [**CommunicationWebsiteAgendaEventLocalizationAddToCalendarUrls**](CommunicationWebsiteAgendaEventLocalizationAddToCalendarUrls.md) |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+

data/docs/CommunicationWebsiteApi.md

@@ -0,0 +1,106 @@
+# OsunyApi::CommunicationWebsiteApi
+
+All URIs are relative to *https://demo.osuny.org/api/osuny/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**communication_websites_get**](CommunicationWebsiteApi.md#communication_websites_get) | **GET** /communication/websites | Lists the websites
+[**communication_websites_id_get**](CommunicationWebsiteApi.md#communication_websites_id_get) | **GET** /communication/websites/{id} | Shows a website
+
+# **communication_websites_get**
+> Array<CommunicationWebsite> communication_websites_get
+
+Lists the websites
+
+### Example
+```ruby
+# load the gem
+require 'osuny_api'
+# setup authorization
+OsunyApi.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Osuny-Token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Osuny-Token'] = 'Bearer'
+end
+
+api_instance = OsunyApi::CommunicationWebsiteApi.new
+
+begin
+  #Lists the websites
+  result = api_instance.communication_websites_get
+  p result
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling CommunicationWebsiteApi->communication_websites_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<CommunicationWebsite>**](CommunicationWebsite.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **communication_websites_id_get**
+> CommunicationWebsite communication_websites_id_get(id)
+
+Shows a website
+
+### Example
+```ruby
+# load the gem
+require 'osuny_api'
+# setup authorization
+OsunyApi.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Osuny-Token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Osuny-Token'] = 'Bearer'
+end
+
+api_instance = OsunyApi::CommunicationWebsiteApi.new
+id = 'id_example' # String | Website identifier
+
+
+begin
+  #Shows a website
+  result = api_instance.communication_websites_id_get(id)
+  p result
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling CommunicationWebsiteApi->communication_websites_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Website identifier | 
+
+### Return type
+
+[**CommunicationWebsite**](CommunicationWebsite.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/CommunicationWebsiteDeuxfleurs.md

@@ -0,0 +1,8 @@
+# OsunyApi::CommunicationWebsiteDeuxfleurs
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hosting** | **BOOLEAN** |  | [optional] 
+**identifier** | **String** |  | [optional] 
+

data/docs/CommunicationWebsiteFeatures.md

@@ -0,0 +1,9 @@
+# OsunyApi::CommunicationWebsiteFeatures
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agenda** | **BOOLEAN** |  | [optional] 
+**portfolio** | **BOOLEAN** |  | [optional] 
+**posts** | **BOOLEAN** |  | [optional] 
+

data/docs/CommunicationWebsiteGit.md

@@ -0,0 +1,10 @@
+# OsunyApi::CommunicationWebsiteGit
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** |  | [optional] 
+**endpoint** | **String** |  | [optional] 
+**provider** | **String** |  | [optional] 
+**repository** | **String** |  | [optional] 
+

data/docs/CommunicationWebsiteLocalization.md

@@ -0,0 +1,23 @@
+# OsunyApi::CommunicationWebsiteLocalization
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**published** | **BOOLEAN** |  | [optional] 
+**published_at** | **DateTime** |  | [optional] 
+**social_email** | **String** |  | [optional] 
+**social_facebook** | **String** |  | [optional] 
+**social_github** | **String** |  | [optional] 
+**social_instagram** | **String** |  | [optional] 
+**social_linkedin** | **String** |  | [optional] 
+**social_mastodon** | **String** |  | [optional] 
+**social_peertube** | **String** |  | [optional] 
+**social_tiktok** | **String** |  | [optional] 
+**social_vimeo** | **String** |  | [optional] 
+**social_x** | **String** |  | [optional] 
+**social_youtube** | **String** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+

data/docs/CommunicationWebsitePage.md

@@ -0,0 +1,17 @@
+# OsunyApi::CommunicationWebsitePage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**migration_identifier** | **String** |  | [optional] 
+**type** | **String** | Read-only. It is set when it's a special page. | [optional] 
+**parent_id** | **String** |  | [optional] 
+**position** | **Integer** |  | [optional] 
+**bodyclass** | **String** |  | [optional] 
+**full_width** | **BOOLEAN** |  | [optional] 
+**localizations** | [**Hash<String, CommunicationWebsitePageLocalization>**](CommunicationWebsitePageLocalization.md) | Localizations of the page. The key is the language's ISO 639-1 code. | [optional] 
+**category_ids** | **Array<String>** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+

data/docs/CommunicationWebsitePageApi.md

@@ -0,0 +1,329 @@
+# OsunyApi::CommunicationWebsitePageApi
+
+All URIs are relative to *https://demo.osuny.org/api/osuny/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**communication_websites_website_id_pages_get**](CommunicationWebsitePageApi.md#communication_websites_website_id_pages_get) | **GET** /communication/websites/{website_id}/pages | Lists a website's pages
+[**communication_websites_website_id_pages_id_delete**](CommunicationWebsitePageApi.md#communication_websites_website_id_pages_id_delete) | **DELETE** /communication/websites/{website_id}/pages/{id} | Deletes a page
+[**communication_websites_website_id_pages_id_get**](CommunicationWebsitePageApi.md#communication_websites_website_id_pages_id_get) | **GET** /communication/websites/{website_id}/pages/{id} | Shows a page
+[**communication_websites_website_id_pages_id_patch**](CommunicationWebsitePageApi.md#communication_websites_website_id_pages_id_patch) | **PATCH** /communication/websites/{website_id}/pages/{id} | Updates a page
+[**communication_websites_website_id_pages_post**](CommunicationWebsitePageApi.md#communication_websites_website_id_pages_post) | **POST** /communication/websites/{website_id}/pages | Creates a page
+[**communication_websites_website_id_pages_upsert_post**](CommunicationWebsitePageApi.md#communication_websites_website_id_pages_upsert_post) | **POST** /communication/websites/{website_id}/pages/upsert | Upsert pages
+
+# **communication_websites_website_id_pages_get**
+> Array<CommunicationWebsitePage> communication_websites_website_id_pages_get(website_id)
+
+Lists a website's pages
+
+### Example
+```ruby
+# load the gem
+require 'osuny_api'
+# setup authorization
+OsunyApi.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Osuny-Token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Osuny-Token'] = 'Bearer'
+end
+
+api_instance = OsunyApi::CommunicationWebsitePageApi.new
+website_id = 'website_id_example' # String | Website identifier
+
+
+begin
+  #Lists a website's pages
+  result = api_instance.communication_websites_website_id_pages_get(website_id)
+  p result
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling CommunicationWebsitePageApi->communication_websites_website_id_pages_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **website_id** | **String**| Website identifier | 
+
+### Return type
+
+[**Array<CommunicationWebsitePage>**](CommunicationWebsitePage.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **communication_websites_website_id_pages_id_delete**
+> communication_websites_website_id_pages_id_delete(website_id, id)
+
+Deletes a page
+
+### Example
+```ruby
+# load the gem
+require 'osuny_api'
+# setup authorization
+OsunyApi.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Osuny-Token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Osuny-Token'] = 'Bearer'
+end
+
+api_instance = OsunyApi::CommunicationWebsitePageApi.new
+website_id = 'website_id_example' # String | Website identifier
+id = 'id_example' # String | Page identifier
+
+
+begin
+  #Deletes a page
+  api_instance.communication_websites_website_id_pages_id_delete(website_id, id)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling CommunicationWebsitePageApi->communication_websites_website_id_pages_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **website_id** | **String**| Website identifier | 
+ **id** | **String**| Page identifier | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **communication_websites_website_id_pages_id_get**
+> communication_websites_website_id_pages_id_get(website_id, id)
+
+Shows a page
+
+### Example
+```ruby
+# load the gem
+require 'osuny_api'
+# setup authorization
+OsunyApi.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Osuny-Token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Osuny-Token'] = 'Bearer'
+end
+
+api_instance = OsunyApi::CommunicationWebsitePageApi.new
+website_id = 'website_id_example' # String | Website identifier
+id = 'id_example' # String | Page identifier
+
+
+begin
+  #Shows a page
+  api_instance.communication_websites_website_id_pages_id_get(website_id, id)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling CommunicationWebsitePageApi->communication_websites_website_id_pages_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **website_id** | **String**| Website identifier | 
+ **id** | **String**| Page identifier | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **communication_websites_website_id_pages_id_patch**
+> communication_websites_website_id_pages_id_patch(website_idid, opts)
+
+Updates a page
+
+### Example
+```ruby
+# load the gem
+require 'osuny_api'
+# setup authorization
+OsunyApi.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Osuny-Token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Osuny-Token'] = 'Bearer'
+end
+
+api_instance = OsunyApi::CommunicationWebsitePageApi.new
+website_id = 'website_id_example' # String | Website identifier
+id = 'id_example' # String | Page identifier
+opts = { 
+  body: OsunyApi::PagesIdBody.new # PagesIdBody | 
+}
+
+begin
+  #Updates a page
+  api_instance.communication_websites_website_id_pages_id_patch(website_idid, opts)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling CommunicationWebsitePageApi->communication_websites_website_id_pages_id_patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **website_id** | **String**| Website identifier | 
+ **id** | **String**| Page identifier | 
+ **body** | [**PagesIdBody**](PagesIdBody.md)|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **communication_websites_website_id_pages_post**
+> communication_websites_website_id_pages_post(website_id, opts)
+
+Creates a page
+
+### Example
+```ruby
+# load the gem
+require 'osuny_api'
+# setup authorization
+OsunyApi.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Osuny-Token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Osuny-Token'] = 'Bearer'
+end
+
+api_instance = OsunyApi::CommunicationWebsitePageApi.new
+website_id = 'website_id_example' # String | Website identifier
+opts = { 
+  body: OsunyApi::WebsiteIdPagesBody.new # WebsiteIdPagesBody | 
+}
+
+begin
+  #Creates a page
+  api_instance.communication_websites_website_id_pages_post(website_id, opts)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling CommunicationWebsitePageApi->communication_websites_website_id_pages_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **website_id** | **String**| Website identifier | 
+ **body** | [**WebsiteIdPagesBody**](WebsiteIdPagesBody.md)|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **communication_websites_website_id_pages_upsert_post**
+> communication_websites_website_id_pages_upsert_post(website_id, opts)
+
+Upsert pages
+
+### Example
+```ruby
+# load the gem
+require 'osuny_api'
+# setup authorization
+OsunyApi.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Osuny-Token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Osuny-Token'] = 'Bearer'
+end
+
+api_instance = OsunyApi::CommunicationWebsitePageApi.new
+website_id = 'website_id_example' # String | Website identifier
+opts = { 
+  body: OsunyApi::PagesUpsertBody.new # PagesUpsertBody | 
+}
+
+begin
+  #Upsert pages
+  api_instance.communication_websites_website_id_pages_upsert_post(website_id, opts)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling CommunicationWebsitePageApi->communication_websites_website_id_pages_upsert_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **website_id** | **String**| Website identifier | 
+ **body** | [**PagesUpsertBody**](PagesUpsertBody.md)|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/CommunicationWebsitePageCategory.md

@@ -0,0 +1,14 @@
+# OsunyApi::CommunicationWebsitePageCategory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**migration_identifier** | **String** |  | [optional] 
+**parent_id** | **String** |  | [optional] 
+**position** | **Integer** |  | [optional] 
+**is_taxonomy** | **BOOLEAN** |  | [optional] 
+**localizations** | [**Hash<String, CommunicationWebsitePageCategoryLocalization>**](CommunicationWebsitePageCategoryLocalization.md) | Localizations of the category. The key is the language's ISO 639-1 code. | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+