osuny_api 0.2.6 → 1.0.0

data/docs/UniversityOrganizationApi.md

@@ -0,0 +1,314 @@
+# OsunyApi::UniversityOrganizationApi
+
+All URIs are relative to *https://demo.osuny.org/api/osuny/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**university_organizations_get**](UniversityOrganizationApi.md#university_organizations_get) | **GET** /university/organizations | Lists organizations
+[**university_organizations_id_delete**](UniversityOrganizationApi.md#university_organizations_id_delete) | **DELETE** /university/organizations/{id} | Deletes an organization
+[**university_organizations_id_get**](UniversityOrganizationApi.md#university_organizations_id_get) | **GET** /university/organizations/{id} | Shows an organization
+[**university_organizations_id_patch**](UniversityOrganizationApi.md#university_organizations_id_patch) | **PATCH** /university/organizations/{id} | Updates an organization
+[**university_organizations_post**](UniversityOrganizationApi.md#university_organizations_post) | **POST** /university/organizations | Creates a organization
+[**university_organizations_upsert_post**](UniversityOrganizationApi.md#university_organizations_upsert_post) | **POST** /university/organizations/upsert | Upsert organizations
+
+# **university_organizations_get**
+> Array<UniversityOrganization> university_organizations_get
+
+Lists organizations
+
+### 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::UniversityOrganizationApi.new
+
+begin
+  #Lists organizations
+  result = api_instance.university_organizations_get
+  p result
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling UniversityOrganizationApi->university_organizations_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<UniversityOrganization>**](UniversityOrganization.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **university_organizations_id_delete**
+> university_organizations_id_delete(id)
+
+Deletes an organization
+
+### 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::UniversityOrganizationApi.new
+id = 'id_example' # String | Organization identifier
+
+
+begin
+  #Deletes an organization
+  api_instance.university_organizations_id_delete(id)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling UniversityOrganizationApi->university_organizations_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Organization identifier | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **university_organizations_id_get**
+> university_organizations_id_get(id)
+
+Shows an organization
+
+### 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::UniversityOrganizationApi.new
+id = 'id_example' # String | Organization identifier
+
+
+begin
+  #Shows an organization
+  api_instance.university_organizations_id_get(id)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling UniversityOrganizationApi->university_organizations_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Organization identifier | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **university_organizations_id_patch**
+> university_organizations_id_patch(id, opts)
+
+Updates an organization
+
+### 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::UniversityOrganizationApi.new
+id = 'id_example' # String | Organization identifier
+opts = { 
+  body: OsunyApi::OrganizationsIdBody.new # OrganizationsIdBody | 
+}
+
+begin
+  #Updates an organization
+  api_instance.university_organizations_id_patch(id, opts)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling UniversityOrganizationApi->university_organizations_id_patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Organization identifier | 
+ **body** | [**OrganizationsIdBody**](OrganizationsIdBody.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
+
+
+
+# **university_organizations_post**
+> university_organizations_post(opts)
+
+Creates a organization
+
+### 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::UniversityOrganizationApi.new
+opts = { 
+  body: OsunyApi::UniversityOrganizationsBody.new # UniversityOrganizationsBody | 
+}
+
+begin
+  #Creates a organization
+  api_instance.university_organizations_post(opts)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling UniversityOrganizationApi->university_organizations_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UniversityOrganizationsBody**](UniversityOrganizationsBody.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
+
+
+
+# **university_organizations_upsert_post**
+> university_organizations_upsert_post(opts)
+
+Upsert organizations
+
+### 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::UniversityOrganizationApi.new
+opts = { 
+  body: OsunyApi::OrganizationsUpsertBody.new # OrganizationsUpsertBody | 
+}
+
+begin
+  #Upsert organizations
+  api_instance.university_organizations_upsert_post(opts)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling UniversityOrganizationApi->university_organizations_upsert_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**OrganizationsUpsertBody**](OrganizationsUpsertBody.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/UniversityOrganizationCategory.md

@@ -0,0 +1,14 @@
+# OsunyApi::UniversityOrganizationCategory
+
+## 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, UniversityOrganizationCategoryLocalization>**](UniversityOrganizationCategoryLocalization.md) | Localizations of the category. The key is the language's ISO 639-1 code. | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+

data/docs/UniversityOrganizationCategoryApi.md

@@ -0,0 +1,314 @@
+# OsunyApi::UniversityOrganizationCategoryApi
+
+All URIs are relative to *https://demo.osuny.org/api/osuny/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**university_organizations_categories_get**](UniversityOrganizationCategoryApi.md#university_organizations_categories_get) | **GET** /university/organizations/categories | Lists organization categories
+[**university_organizations_categories_id_delete**](UniversityOrganizationCategoryApi.md#university_organizations_categories_id_delete) | **DELETE** /university/organizations/categories/{id} | Deletes a organization category
+[**university_organizations_categories_id_get**](UniversityOrganizationCategoryApi.md#university_organizations_categories_id_get) | **GET** /university/organizations/categories/{id} | Shows a organization category
+[**university_organizations_categories_id_patch**](UniversityOrganizationCategoryApi.md#university_organizations_categories_id_patch) | **PATCH** /university/organizations/categories/{id} | Updates a organization category
+[**university_organizations_categories_post**](UniversityOrganizationCategoryApi.md#university_organizations_categories_post) | **POST** /university/organizations/categories | Creates a organization category
+[**university_organizations_categories_upsert_post**](UniversityOrganizationCategoryApi.md#university_organizations_categories_upsert_post) | **POST** /university/organizations/categories/upsert | Upsert organization categories
+
+# **university_organizations_categories_get**
+> Array<UniversityOrganizationCategory> university_organizations_categories_get
+
+Lists organization categories
+
+### 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::UniversityOrganizationCategoryApi.new
+
+begin
+  #Lists organization categories
+  result = api_instance.university_organizations_categories_get
+  p result
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling UniversityOrganizationCategoryApi->university_organizations_categories_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<UniversityOrganizationCategory>**](UniversityOrganizationCategory.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **university_organizations_categories_id_delete**
+> university_organizations_categories_id_delete(id)
+
+Deletes a organization category
+
+### 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::UniversityOrganizationCategoryApi.new
+id = 'id_example' # String | Category identifier
+
+
+begin
+  #Deletes a organization category
+  api_instance.university_organizations_categories_id_delete(id)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling UniversityOrganizationCategoryApi->university_organizations_categories_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Category identifier | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **university_organizations_categories_id_get**
+> university_organizations_categories_id_get(id)
+
+Shows a organization category
+
+### 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::UniversityOrganizationCategoryApi.new
+id = 'id_example' # String | Category identifier
+
+
+begin
+  #Shows a organization category
+  api_instance.university_organizations_categories_id_get(id)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling UniversityOrganizationCategoryApi->university_organizations_categories_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Category identifier | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **university_organizations_categories_id_patch**
+> university_organizations_categories_id_patch(id, opts)
+
+Updates a organization category
+
+### 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::UniversityOrganizationCategoryApi.new
+id = 'id_example' # String | Category identifier
+opts = { 
+  body: OsunyApi::CategoriesIdBody2.new # CategoriesIdBody2 | 
+}
+
+begin
+  #Updates a organization category
+  api_instance.university_organizations_categories_id_patch(id, opts)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling UniversityOrganizationCategoryApi->university_organizations_categories_id_patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Category identifier | 
+ **body** | [**CategoriesIdBody2**](CategoriesIdBody2.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
+
+
+
+# **university_organizations_categories_post**
+> university_organizations_categories_post(opts)
+
+Creates a organization category
+
+### 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::UniversityOrganizationCategoryApi.new
+opts = { 
+  body: OsunyApi::OrganizationsCategoriesBody.new # OrganizationsCategoriesBody | 
+}
+
+begin
+  #Creates a organization category
+  api_instance.university_organizations_categories_post(opts)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling UniversityOrganizationCategoryApi->university_organizations_categories_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**OrganizationsCategoriesBody**](OrganizationsCategoriesBody.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
+
+
+
+# **university_organizations_categories_upsert_post**
+> university_organizations_categories_upsert_post(opts)
+
+Upsert organization categories
+
+### 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::UniversityOrganizationCategoryApi.new
+opts = { 
+  body: OsunyApi::CategoriesUpsertBody2.new # CategoriesUpsertBody2 | 
+}
+
+begin
+  #Upsert organization categories
+  api_instance.university_organizations_categories_upsert_post(opts)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling UniversityOrganizationCategoryApi->university_organizations_categories_upsert_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CategoriesUpsertBody2**](CategoriesUpsertBody2.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/UniversityOrganizationCategoryLocalization.md

@@ -0,0 +1,16 @@
+# OsunyApi::UniversityOrganizationCategoryLocalization
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**migration_identifier** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**featured_image** | [**CommunicationWebsiteAgendaCategoryLocalizationFeaturedImage**](CommunicationWebsiteAgendaCategoryLocalizationFeaturedImage.md) |  | [optional] 
+**meta_description** | **String** |  | [optional] 
+**slug** | **String** |  | [optional] 
+**summary** | **String** |  | [optional] 
+**blocks** | [**Array<OneOfuniversityOrganizationCategoryLocalizationBlocksItems>**](.md) |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+

data/docs/UniversityOrganizationLocalization.md

@@ -0,0 +1,24 @@
+# OsunyApi::UniversityOrganizationLocalization
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**migration_identifier** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**long_name** | **String** |  | [optional] 
+**featured_image** | [**CommunicationWebsiteAgendaCategoryLocalizationFeaturedImage**](CommunicationWebsiteAgendaCategoryLocalizationFeaturedImage.md) |  | [optional] 
+**meta_description** | **String** |  | [optional] 
+**address_name** | **String** |  | [optional] 
+**address_additional** | **String** |  | [optional] 
+**linkedin** | **String** |  | [optional] 
+**mastodon** | **String** |  | [optional] 
+**twitter** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+**slug** | **String** |  | [optional] 
+**summary** | **String** |  | [optional] 
+**text** | **String** |  | [optional] 
+**blocks** | [**Array<OneOfuniversityOrganizationLocalizationBlocksItems>**](.md) |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+

data/docs/UniversityOrganizationsBody.md

@@ -0,0 +1,7 @@
+# OsunyApi::UniversityOrganizationsBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**organization** | [**UniversityOrganization**](UniversityOrganization.md) |  | 
+

data/docs/WebsiteIdPagesBody.md

@@ -0,0 +1,7 @@
+# OsunyApi::WebsiteIdPagesBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | [**CommunicationWebsitePage**](CommunicationWebsitePage.md) |  | 
+

data/docs/WebsiteIdPostsBody.md

@@ -0,0 +1,7 @@
+# OsunyApi::WebsiteIdPostsBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**post** | [**CommunicationWebsitePost**](CommunicationWebsitePost.md) |  | 
+