osuny_api 1.0.0 → 1.1.0

data/docs/CommunicationWebsitePageApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 [**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)
+> Array<CommunicationWebsitePage> communication_websites_website_id_pages_get(website_id, opts)
 
 Lists a website's pages
 
@@ -30,11 +30,14 @@ end
 
 api_instance = OsunyApi::CommunicationWebsitePageApi.new
 website_id = 'website_id_example' # String | Website identifier
-
+opts = { 
+  page_num: 1, # Integer | Page number
+  per_page: 10000 # Integer | Number of items per page
+}
 
 begin
   #Lists a website's pages
-  result = api_instance.communication_websites_website_id_pages_get(website_id)
+  result = api_instance.communication_websites_website_id_pages_get(website_id, opts)
   p result
 rescue OsunyApi::ApiError => e
   puts "Exception when calling CommunicationWebsitePageApi->communication_websites_website_id_pages_get: #{e}"
@@ -46,6 +49,8 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **website_id** | **String**| Website identifier | 
+ **page_num** | **Integer**| Page number | [optional] [default to 1]
+ **per_page** | **Integer**| Number of items per page | [optional] [default to 10000]
 
 ### Return type
 

data/docs/CommunicationWebsitePageCategoryApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 [**communication_websites_website_id_pages_categories_upsert_post**](CommunicationWebsitePageCategoryApi.md#communication_websites_website_id_pages_categories_upsert_post) | **POST** /communication/websites/{website_id}/pages/categories/upsert | Upsert page categories
 
 # **communication_websites_website_id_pages_categories_get**
-> Array<CommunicationWebsitePageCategory> communication_websites_website_id_pages_categories_get(website_id)
+> Array<CommunicationWebsitePageCategory> communication_websites_website_id_pages_categories_get(website_id, opts)
 
 Lists a website's page categories
 
@@ -30,11 +30,14 @@ end
 
 api_instance = OsunyApi::CommunicationWebsitePageCategoryApi.new
 website_id = 'website_id_example' # String | Website identifier
-
+opts = { 
+  page_num: 1, # Integer | Page number
+  per_page: 10000 # Integer | Number of items per page
+}
 
 begin
   #Lists a website's page categories
-  result = api_instance.communication_websites_website_id_pages_categories_get(website_id)
+  result = api_instance.communication_websites_website_id_pages_categories_get(website_id, opts)
   p result
 rescue OsunyApi::ApiError => e
   puts "Exception when calling CommunicationWebsitePageCategoryApi->communication_websites_website_id_pages_categories_get: #{e}"
@@ -46,6 +49,8 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **website_id** | **String**| Website identifier | 
+ **page_num** | **Integer**| Page number | [optional] [default to 1]
+ **per_page** | **Integer**| Number of items per page | [optional] [default to 10000]
 
 ### Return type
 

data/docs/CommunicationWebsitePageCategoryLocalization.md

@@ -6,10 +6,16 @@ Name | Type | Description | Notes
 **id** | **String** |  | [optional] 
 **migration_identifier** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
+**breadcrumb_title** | **String** |  | [optional] 
 **featured_image** | [**CommunicationWebsiteAgendaCategoryLocalizationFeaturedImage**](CommunicationWebsiteAgendaCategoryLocalizationFeaturedImage.md) |  | [optional] 
+**header_cta** | **BOOLEAN** |  | [optional] 
+**header_cta_label** | **String** |  | [optional] 
+**header_cta_url** | **String** |  | [optional] 
+**header_text** | **String** |  | [optional] 
 **meta_description** | **String** |  | [optional] 
 **path** | **String** |  | [optional] 
 **slug** | **String** |  | [optional] 
+**subtitle** | **String** |  | [optional] 
 **summary** | **String** |  | [optional] 
 **blocks** | [**Array<OneOfcommunicationWebsitePageCategoryLocalizationBlocksItems>**](.md) |  | [optional] 
 **created_at** | **DateTime** |  | [optional] 

data/docs/CommunicationWebsitePageLocalization.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **migration_identifier** | **String** |  | [optional] 
 **title** | **String** |  | [optional] 
 **breadcrumb_title** | **String** |  | [optional] 
+**subtitle** | **String** |  | [optional] 
 **featured_image** | [**CommunicationWebsiteAgendaCategoryLocalizationFeaturedImage**](CommunicationWebsiteAgendaCategoryLocalizationFeaturedImage.md) |  | [optional] 
 **meta_description** | **String** |  | [optional] 
 **published** | **BOOLEAN** |  | [optional] 
@@ -18,6 +19,7 @@ Name | Type | Description | Notes
 **header_cta** | **BOOLEAN** |  | [optional] 
 **header_cta_label** | **String** |  | [optional] 
 **header_cta_url** | **String** |  | [optional] 
+**aliases** | [**Array<CommunicationWebsitePermalink>**](CommunicationWebsitePermalink.md) |  | [optional] 
 **blocks** | [**Array<OneOfcommunicationWebsitePageLocalizationBlocksItems>**](.md) |  | [optional] 
 **created_at** | **DateTime** |  | [optional] 
 **updated_at** | **DateTime** |  | [optional] 

data/docs/CommunicationWebsitePermalink.md

@@ -0,0 +1,8 @@
+# OsunyApi::CommunicationWebsitePermalink
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**path** | **String** |  | [optional] 
+

data/docs/CommunicationWebsitePortfolioCategory.md

@@ -0,0 +1,15 @@
+# OsunyApi::CommunicationWebsitePortfolioCategory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**migration_identifier** | **String** |  | [optional] 
+**parent_id** | **String** |  | [optional] 
+**position** | **Integer** |  | [optional] 
+**is_taxonomy** | **BOOLEAN** |  | [optional] 
+**bodyclass** | **String** |  | [optional] 
+**localizations** | [**Hash<String, CommunicationWebsitePortfolioCategoryLocalization>**](CommunicationWebsitePortfolioCategoryLocalization.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/CommunicationWebsitePortfolioCategoryApi.md

@@ -0,0 +1,334 @@
+# OsunyApi::CommunicationWebsitePortfolioCategoryApi
+
+All URIs are relative to *https://demo.osuny.org/api/osuny/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**communication_websites_website_id_portfolio_categories_get**](CommunicationWebsitePortfolioCategoryApi.md#communication_websites_website_id_portfolio_categories_get) | **GET** /communication/websites/{website_id}/portfolio/categories | Lists a website's portfolio categories
+[**communication_websites_website_id_portfolio_categories_id_delete**](CommunicationWebsitePortfolioCategoryApi.md#communication_websites_website_id_portfolio_categories_id_delete) | **DELETE** /communication/websites/{website_id}/portfolio/categories/{id} | Deletes a portfolio category
+[**communication_websites_website_id_portfolio_categories_id_get**](CommunicationWebsitePortfolioCategoryApi.md#communication_websites_website_id_portfolio_categories_id_get) | **GET** /communication/websites/{website_id}/portfolio/categories/{id} | Shows a portfolio category
+[**communication_websites_website_id_portfolio_categories_id_patch**](CommunicationWebsitePortfolioCategoryApi.md#communication_websites_website_id_portfolio_categories_id_patch) | **PATCH** /communication/websites/{website_id}/portfolio/categories/{id} | Updates a portfolio category
+[**communication_websites_website_id_portfolio_categories_post**](CommunicationWebsitePortfolioCategoryApi.md#communication_websites_website_id_portfolio_categories_post) | **POST** /communication/websites/{website_id}/portfolio/categories | Creates a portfolio category
+[**communication_websites_website_id_portfolio_categories_upsert_post**](CommunicationWebsitePortfolioCategoryApi.md#communication_websites_website_id_portfolio_categories_upsert_post) | **POST** /communication/websites/{website_id}/portfolio/categories/upsert | Upsert portfolio categories
+
+# **communication_websites_website_id_portfolio_categories_get**
+> Array<CommunicationWebsitePortfolioCategory> communication_websites_website_id_portfolio_categories_get(website_id, opts)
+
+Lists a website's portfolio 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::CommunicationWebsitePortfolioCategoryApi.new
+website_id = 'website_id_example' # String | Website identifier
+opts = { 
+  page_num: 1, # Integer | Page number
+  per_page: 10000 # Integer | Number of items per page
+}
+
+begin
+  #Lists a website's portfolio categories
+  result = api_instance.communication_websites_website_id_portfolio_categories_get(website_id, opts)
+  p result
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling CommunicationWebsitePortfolioCategoryApi->communication_websites_website_id_portfolio_categories_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **website_id** | **String**| Website identifier | 
+ **page_num** | **Integer**| Page number | [optional] [default to 1]
+ **per_page** | **Integer**| Number of items per page | [optional] [default to 10000]
+
+### Return type
+
+[**Array<CommunicationWebsitePortfolioCategory>**](CommunicationWebsitePortfolioCategory.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **communication_websites_website_id_portfolio_categories_id_delete**
+> communication_websites_website_id_portfolio_categories_id_delete(website_id, id)
+
+Deletes a portfolio 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::CommunicationWebsitePortfolioCategoryApi.new
+website_id = 'website_id_example' # String | Website identifier
+id = 'id_example' # String | Category identifier
+
+
+begin
+  #Deletes a portfolio category
+  api_instance.communication_websites_website_id_portfolio_categories_id_delete(website_id, id)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling CommunicationWebsitePortfolioCategoryApi->communication_websites_website_id_portfolio_categories_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **website_id** | **String**| Website identifier | 
+ **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
+
+
+
+# **communication_websites_website_id_portfolio_categories_id_get**
+> communication_websites_website_id_portfolio_categories_id_get(website_id, id)
+
+Shows a portfolio 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::CommunicationWebsitePortfolioCategoryApi.new
+website_id = 'website_id_example' # String | Website identifier
+id = 'id_example' # String | Category identifier
+
+
+begin
+  #Shows a portfolio category
+  api_instance.communication_websites_website_id_portfolio_categories_id_get(website_id, id)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling CommunicationWebsitePortfolioCategoryApi->communication_websites_website_id_portfolio_categories_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **website_id** | **String**| Website identifier | 
+ **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
+
+
+
+# **communication_websites_website_id_portfolio_categories_id_patch**
+> communication_websites_website_id_portfolio_categories_id_patch(website_idid, opts)
+
+Updates a portfolio 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::CommunicationWebsitePortfolioCategoryApi.new
+website_id = 'website_id_example' # String | Website identifier
+id = 'id_example' # String | Category identifier
+opts = { 
+  body: OsunyApi::CategoriesIdBody2.new # CategoriesIdBody2 | 
+}
+
+begin
+  #Updates a portfolio category
+  api_instance.communication_websites_website_id_portfolio_categories_id_patch(website_idid, opts)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling CommunicationWebsitePortfolioCategoryApi->communication_websites_website_id_portfolio_categories_id_patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **website_id** | **String**| Website identifier | 
+ **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
+
+
+
+# **communication_websites_website_id_portfolio_categories_post**
+> communication_websites_website_id_portfolio_categories_post(website_id, opts)
+
+Creates a portfolio 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::CommunicationWebsitePortfolioCategoryApi.new
+website_id = 'website_id_example' # String | Website identifier
+opts = { 
+  body: OsunyApi::PortfolioCategoriesBody.new # PortfolioCategoriesBody | 
+}
+
+begin
+  #Creates a portfolio category
+  api_instance.communication_websites_website_id_portfolio_categories_post(website_id, opts)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling CommunicationWebsitePortfolioCategoryApi->communication_websites_website_id_portfolio_categories_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **website_id** | **String**| Website identifier | 
+ **body** | [**PortfolioCategoriesBody**](PortfolioCategoriesBody.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_portfolio_categories_upsert_post**
+> communication_websites_website_id_portfolio_categories_upsert_post(website_id, opts)
+
+Upsert portfolio 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::CommunicationWebsitePortfolioCategoryApi.new
+website_id = 'website_id_example' # String | Website identifier
+opts = { 
+  body: OsunyApi::CategoriesUpsertBody2.new # CategoriesUpsertBody2 | 
+}
+
+begin
+  #Upsert portfolio categories
+  api_instance.communication_websites_website_id_portfolio_categories_upsert_post(website_id, opts)
+rescue OsunyApi::ApiError => e
+  puts "Exception when calling CommunicationWebsitePortfolioCategoryApi->communication_websites_website_id_portfolio_categories_upsert_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **website_id** | **String**| Website identifier | 
+ **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/CommunicationWebsitePortfolioCategoryLocalization.md

@@ -0,0 +1,23 @@
+# OsunyApi::CommunicationWebsitePortfolioCategoryLocalization
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**migration_identifier** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**breadcrumb_title** | **String** |  | [optional] 
+**featured_image** | [**CommunicationWebsiteAgendaCategoryLocalizationFeaturedImage**](CommunicationWebsiteAgendaCategoryLocalizationFeaturedImage.md) |  | [optional] 
+**header_cta** | **BOOLEAN** |  | [optional] 
+**header_cta_label** | **String** |  | [optional] 
+**header_cta_url** | **String** |  | [optional] 
+**header_text** | **String** |  | [optional] 
+**meta_description** | **String** |  | [optional] 
+**path** | **String** |  | [optional] 
+**slug** | **String** |  | [optional] 
+**subtitle** | **String** |  | [optional] 
+**summary** | **String** |  | [optional] 
+**blocks** | [**Array<OneOfcommunicationWebsitePortfolioCategoryLocalizationBlocksItems>**](.md) |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+

data/docs/CommunicationWebsitePortfolioProject.md

@@ -0,0 +1,15 @@
+# OsunyApi::CommunicationWebsitePortfolioProject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**migration_identifier** | **String** |  | [optional] 
+**full_width** | **BOOLEAN** |  | [optional] 
+**bodyclass** | **String** |  | [optional] 
+**year** | **Integer** |  | [optional] 
+**localizations** | [**Hash<String, CommunicationWebsitePortfolioProjectLocalization>**](CommunicationWebsitePortfolioProjectLocalization.md) | Localizations of the project. The key is the language's ISO 639-1 code. | [optional] 
+**category_ids** | **Array<String>** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+