MHPY-10 Add other resources docs

Author: lennertvandevelde

README.md

@@ -9,4 +9,6 @@ A full list of `Mediahaven-python` project modules.
     - [Oauth2](docs/mediahaven/oauth2.md#oauth2)
     - [Resources](docs/mediahaven/resources/index.md#resources)
         - [BaseResource](docs/mediahaven/resources/base_resource.md#baseresource)
+        - [FieldDefinitions](docs/mediahaven/resources/field_definitions.md#fielddefinitions)
+        - [Organisations](docs/mediahaven/resources/organisations.md#organisations)
         - [Records](docs/mediahaven/resources/records.md#records)

docs/mediahaven/index.md

@@ -11,7 +11,7 @@ MediaHaven
 
 ## MediaHaven
 
-[Show source in __init__.py:10](../../mediahaven/__init__.py#L10)
+[Show source in __init__.py:12](../../mediahaven/__init__.py#L12)
 
 #### Signature
 

docs/mediahaven/mediahaven.md

@@ -13,7 +13,7 @@ Mediahaven
 
 ## AcceptFormat
 
-[Show source in mediahaven.py:32](../../mediahaven/mediahaven.py#L32)
+[Show source in mediahaven.py:31](../../mediahaven/mediahaven.py#L31)
 
 #### Signature
 
@@ -26,7 +26,7 @@ class AcceptFormat(Enum):
 
 ## MediaHavenClient
 
-[Show source in mediahaven.py:43](../../mediahaven/mediahaven.py#L43)
+[Show source in mediahaven.py:42](../../mediahaven/mediahaven.py#L42)
 
 The MediaHaven client class to communicate with MediaHaven.
 
@@ -46,7 +46,7 @@ class MediaHavenClient:
 
 ## MediaHavenException
 
-[Show source in mediahaven.py:26](../../mediahaven/mediahaven.py#L26)
+[Show source in mediahaven.py:25](../../mediahaven/mediahaven.py#L25)
 
 #### Signature
 

docs/mediahaven/resources/field_definitions.md

@@ -0,0 +1,95 @@
+# FieldDefinitions
+
+[Mediahaven-python Index](../../../README.md#mediahaven-python-index) /
+[MediaHaven](../index.md#mediahaven) /
+[Resources](./index.md#resources) /
+FieldDefinitions
+
+> Auto-generated documentation for [mediahaven.resources.field_definitions](../../../mediahaven/resources/field_definitions.py) module.
+
+- [FieldDefinitions](#fielddefinitions)
+  - [FieldDefinitions](#fielddefinitions-1)
+    - [FieldDefinitions().get](#fielddefinitions()get)
+    - [FieldDefinitions().search](#fielddefinitions()search)
+
+## FieldDefinitions
+
+[Show source in field_definitions.py:15](../../../mediahaven/resources/field_definitions.py#L15)
+
+Public API endpoint of MediaHaven field definitions.
+
+#### Signature
+
+```python
+class FieldDefinitions(BaseResource):
+    def __init__(self, *args, **kwargs):
+        ...
+```
+
+#### See also
+
+- [BaseResource](./base_resource.md#baseresource)
+
+### FieldDefinitions().get
+
+[Show source in field_definitions.py:22](../../../mediahaven/resources/field_definitions.py#L22)
+
+Get a single field definition.
+
+#### Arguments
+
+- `field` - The id or FlatKey of a metadata field definition.
+- `accept_format` - The "Accept" request header.
+
+#### Returns
+
+A single metadata field definition.
+
+#### Signature
+
+```python
+def get(
+    self, field: str = None, accept_format=DEFAULT_ACCEPT_FORMAT
+) -> MediaHavenSingleObject:
+    ...
+```
+
+#### See also
+
+- [DEFAULT_ACCEPT_FORMAT](../mediahaven.md#default_accept_format)
+- [MediaHavenSingleObject](./base_resource.md#mediahavensingleobject)
+
+### FieldDefinitions().search
+
+[Show source in field_definitions.py:41](../../../mediahaven/resources/field_definitions.py#L41)
+
+Search all field definitions.
+
+#### Arguments
+
+- `accept_format` - The "Accept" request header.
+- `**query_params` - The optional query paramaters:
+    - `query_params["startIndex"]` - Used for pagination of search results,
+        search results will be returned starting from this index.
+    - `query_params["nrOfResults"]` - the number of results that will be returned.
+    - `query_params["nested"]` - If true include children and parents in the response,
+        default is false.
+    - `query_params["sort"]` - Determine how to sort the field definitions. (FieldDefinitionId or LongTranslation).
+
+#### Returns
+
+A paged result with the metadata field definitions.
+
+#### Signature
+
+```python
+def search(
+    self, accept_format: str = DEFAULT_ACCEPT_FORMAT, **query_params
+) -> MediaHavenPageObject:
+    ...
+```
+
+#### See also
+
+- [DEFAULT_ACCEPT_FORMAT](../mediahaven.md#default_accept_format)
+- [MediaHavenPageObject](./base_resource.md#mediahavenpageobject)

docs/mediahaven/resources/index.md

@@ -12,4 +12,6 @@ Resources
 ## Modules
 
 - [BaseResource](./base_resource.md)
+- [FieldDefinitions](./field_definitions.md)
+- [Organisations](./organisations.md)
 - [Records](./records.md)

docs/mediahaven/resources/organisations.md

@@ -0,0 +1,93 @@
+# Organisations
+
+[Mediahaven-python Index](../../../README.md#mediahaven-python-index) /
+[MediaHaven](../index.md#mediahaven) /
+[Resources](./index.md#resources) /
+Organisations
+
+> Auto-generated documentation for [mediahaven.resources.organisations](../../../mediahaven/resources/organisations.py) module.
+
+- [Organisations](#organisations)
+  - [Organisations](#organisations-1)
+    - [Organisations().get](#organisations()get)
+    - [Organisations().search](#organisations()search)
+
+## Organisations
+
+[Show source in organisations.py:15](../../../mediahaven/resources/organisations.py#L15)
+
+Public API endpoint of MediaHaven tenants.
+
+#### Signature
+
+```python
+class Organisations(BaseResource):
+    def __init__(self, *args, **kwargs):
+        ...
+```
+
+#### See also
+
+- [BaseResource](./base_resource.md#baseresource)
+
+### Organisations().get
+
+[Show source in organisations.py:22](../../../mediahaven/resources/organisations.py#L22)
+
+Get a single organisation.
+
+#### Arguments
+
+- `organisation_id` - The id of an organisation.
+- `accept_format` - The "Accept" request header.
+
+#### Returns
+
+A single organisation.
+
+#### Signature
+
+```python
+def get(
+    self, organisation_id: str, accept_format=DEFAULT_ACCEPT_FORMAT
+) -> MediaHavenSingleObject:
+    ...
+```
+
+#### See also
+
+- [DEFAULT_ACCEPT_FORMAT](../mediahaven.md#default_accept_format)
+- [MediaHavenSingleObject](./base_resource.md#mediahavensingleobject)
+
+### Organisations().search
+
+[Show source in organisations.py:40](../../../mediahaven/resources/organisations.py#L40)
+
+Search all organisations.
+
+#### Arguments
+
+- `query` - The search query.
+- `accept_format` - The "Accept" request header.
+- `**query_params` - The optional query parameters:
+    - `query_params["startIndex"]` - Used for pagination of search results,
+        search results will be returned starting from this index.
+    - `query_params["nrOfResults"]` - The number of results that will be returned.
+
+#### Returns
+
+A paged result with the organisations.
+
+#### Signature
+
+```python
+def search(
+    self, accept_format: str = DEFAULT_ACCEPT_FORMAT, **query_params
+) -> MediaHavenPageObject:
+    ...
+```
+
+#### See also
+
+- [DEFAULT_ACCEPT_FORMAT](../mediahaven.md#default_accept_format)
+- [MediaHavenPageObject](./base_resource.md#mediahavenpageobject)

docs/mediahaven/resources/records.md

@@ -12,12 +12,13 @@ Records
     - [Records().count](#records()count)
     - [Records().delete](#records()delete)
     - [Records().get](#records()get)
+    - [Records().publish](#records()publish)
     - [Records().search](#records()search)
     - [Records().update](#records()update)
 
 ## Records
 
-[Show source in records.py:14](../../../mediahaven/resources/records.py#L14)
+[Show source in records.py:15](../../../mediahaven/resources/records.py#L15)
 
 Public API endpoint of a MediaHaven record.
 
@@ -35,7 +36,7 @@ class Records(BaseResource):
 
 ### Records().count
 
-[Show source in records.py:21](../../../mediahaven/resources/records.py#L21)
+[Show source in records.py:22](../../../mediahaven/resources/records.py#L22)
 
 Counts the amount the records given a query string.
 
@@ -56,7 +57,7 @@ def count(self, query: str) -> int:
 
 ### Records().delete
 
-[Show source in records.py:80](../../../mediahaven/resources/records.py#L80)
+[Show source in records.py:81](../../../mediahaven/resources/records.py#L81)
 
 Delete a record.
 
@@ -76,14 +77,14 @@ def delete(self, record_id: str, reason: str = None, event_type: str = None):
 
 ### Records().get
 
-[Show source in records.py:35](../../../mediahaven/resources/records.py#L35)
+[Show source in records.py:36](../../../mediahaven/resources/records.py#L36)
 
 Get a single record.
 
 #### Arguments
 
 - `record_id` - It can either be a MediaObjectId, FragmentId or RecordId.
-- `accept_format` - The "Accept" request header
+- `accept_format` - The "Accept" request header.
 
 #### Returns
 
@@ -103,9 +104,28 @@ def get(
 - [DEFAULT_ACCEPT_FORMAT](../mediahaven.md#default_accept_format)
 - [MediaHavenSingleObject](./base_resource.md#mediahavensingleobject)
 
+### Records().publish
+
+[Show source in records.py:121](../../../mediahaven/resources/records.py#L121)
+
+Publishes a record.
+
+#### Arguments
+
+- `record_id` - The ID of the record to publish.
+    It can be either a MediaObjectId, FragmentId or RecordId.
+- `reason` - The reason to publish the record.
+
+#### Signature
+
+```python
+def publish(self, record_id: str, reason: str = None):
+    ...
+```
+
 ### Records().search
 
-[Show source in records.py:53](../../../mediahaven/resources/records.py#L53)
+[Show source in records.py:54](../../../mediahaven/resources/records.py#L54)
 
 Search for multiple records.
 
@@ -116,8 +136,8 @@ Search for multiple records.
     - `query_params["q"]` - Free text search string.
     - `query_params["startIndex"]` - Used for pagination of search results,
         search results will be returned starting from this index.
-    - `query_params["nrOfResults"]` - the number of results that will be returned
-    - `query_params["publicOnly"]` - if true exclude from the output dynamic
+    - `query_params["nrOfResults"]` - The number of results that will be returned.
+    - `query_params["publicOnly"]` - If true exclude from the output dynamic
         metadata fields which were marked as non public in the Profiles
         linked with the record.
 
@@ -141,7 +161,7 @@ def search(
 
 ### Records().update
 
-[Show source in records.py:102](../../../mediahaven/resources/records.py#L102)
+[Show source in records.py:103](../../../mediahaven/resources/records.py#L103)
 
 Update a record.