pds-metronome 0.1.0

data/docs/ModifyApiKeyRequest.md

@@ -0,0 +1,20 @@
+# Metronome::ModifyApiKeyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional] |
+| **permissions** | [**Array<Permission>**](Permission.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'metronome'
+
+instance = Metronome::ModifyApiKeyRequest.new(
+  status: disabled,
+  permissions: null
+)
+```
+

data/docs/Permission.md

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

data/docs/PermissionDeniedResponse.md

@@ -0,0 +1,30 @@
+# Metronome::PermissionDeniedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_code** | **String** |  |  |
+| **customer_status** | **String** |  | [optional] |
+| **api_key_status** | **String** |  | [optional] |
+| **granted_permissions** | [**Array<Permission>**](Permission.md) |  | [optional] |
+| **required_permission** | [**Permission**](Permission.md) |  | [optional] |
+| **internal_contact** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'metronome'
+
+instance = Metronome::PermissionDeniedResponse.new(
+  error_code: null,
+  customer_status: null,
+  api_key_status: null,
+  granted_permissions: null,
+  required_permission: null,
+  internal_contact: data-protection-it-manager@yourdomain.com,
+  message: null
+)
+```
+

data/docs/PolicyData.md

@@ -0,0 +1,26 @@
+# Metronome::PolicyData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **policy_id** | **String** |  |  |
+| **create_date** | **Date** | Date in YYYYMMDD format. |  |
+| **aging_strategy** | [**AgingStrategy**](AgingStrategy.md) |  |  |
+| **aging_offset_amount** | **Integer** |  |  |
+| **aging_offset_unit** | [**AgingOffsetUnit**](AgingOffsetUnit.md) |  |  |
+
+## Example
+
+```ruby
+require 'metronome'
+
+instance = Metronome::PolicyData.new(
+  policy_id: account-login,
+  create_date: null,
+  aging_strategy: null,
+  aging_offset_amount: null,
+  aging_offset_unit: null
+)
+```
+

data/docs/PolicyDataListResponse.md

@@ -0,0 +1,28 @@
+# Metronome::PolicyDataListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response_type** | **String** | Always the value \"PolicyDataListResponse\" |  |
+| **count** | **Integer** | The number of policies with the given prefix.  Count of all policies if no prefix was given. |  |
+| **offset** | **Integer** | How many items were skipped, specified in the request. | [optional] |
+| **limit** | **Integer** | The maximum number of items to return, specified in the request. | [optional] |
+| **prefix** | **String** | The string prefix to limit policy names, specified in the request. | [optional] |
+| **result** | [**Array<PolicyData>**](PolicyData.md) |  |  |
+
+## Example
+
+```ruby
+require 'metronome'
+
+instance = Metronome::PolicyDataListResponse.new(
+  response_type: null,
+  count: null,
+  offset: null,
+  limit: null,
+  prefix: null,
+  result: null
+)
+```
+

data/docs/PolicyListResponse.md

@@ -0,0 +1,28 @@
+# Metronome::PolicyListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response_type** | **String** | Always the value \"PolicyListResponse\" |  |
+| **count** | **Integer** | The number of policies with the given prefix.  Count of all policies if no prefix was given. |  |
+| **offset** | **Integer** | How many items were skipped, specified in the request. | [optional] |
+| **limit** | **Integer** | The maximum number of items to return, specified in the request. | [optional] |
+| **prefix** | **String** | The string prefix to limit policy names, specified in the request. | [optional] |
+| **result** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'metronome'
+
+instance = Metronome::PolicyListResponse.new(
+  response_type: null,
+  count: null,
+  offset: null,
+  limit: null,
+  prefix: null,
+  result: ["account-login","sales-order-processing","marketing-email"]
+)
+```
+

data/docs/PolicyManagementApi.md

@@ -0,0 +1,379 @@
+# Metronome::PolicyManagementApi
+
+All URIs are relative to *https://YOUR-CUSTOMER-ID.api.eu-north-1.privatedataservices.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_many_policies**](PolicyManagementApi.md#get_many_policies) | **GET** /v1/metronome/policies |  |
+| [**get_policy**](PolicyManagementApi.md#get_policy) | **GET** /v1/metronome/policies/{policy-id} |  |
+| [**get_policy_log**](PolicyManagementApi.md#get_policy_log) | **GET** /v1/metronome/policies/{policy-id}/log |  |
+| [**get_policy_members**](PolicyManagementApi.md#get_policy_members) | **GET** /v1/metronome/policies/{policy-id}/members |  |
+| [**put_policy**](PolicyManagementApi.md#put_policy) | **PUT** /v1/metronome/policies/{policy-id} |  |
+
+
+## get_many_policies
+
+> <GetManyPolicies200Response> get_many_policies(opts)
+
+
+
+Read many policies alphanumerically sorted
+
+### Examples
+
+```ruby
+require 'time'
+require 'metronome'
+# setup authorization
+Metronome.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
+end
+
+api_instance = Metronome::PolicyManagementApi.new
+opts = {
+  prefix: 'marketing-', # String | 
+  offset: 56, # Integer | The number of policies to drop from the start
+  limit: 56, # Integer | The number of policies to include
+  include_data: true # Boolean | Whether to include aging-strategy, aging-offset-amount, aging-offset-unit etc.
+}
+
+begin
+  
+  result = api_instance.get_many_policies(opts)
+  p result
+rescue Metronome::ApiError => e
+  puts "Error when calling PolicyManagementApi->get_many_policies: #{e}"
+end
+```
+
+#### Using the get_many_policies_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetManyPolicies200Response>, Integer, Hash)> get_many_policies_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_many_policies_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetManyPolicies200Response>
+rescue Metronome::ApiError => e
+  puts "Error when calling PolicyManagementApi->get_many_policies_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prefix** | **String** |  | [optional] |
+| **offset** | **Integer** | The number of policies to drop from the start | [optional] |
+| **limit** | **Integer** | The number of policies to include | [optional] |
+| **include_data** | **Boolean** | Whether to include aging-strategy, aging-offset-amount, aging-offset-unit etc. | [optional] |
+
+### Return type
+
+[**GetManyPolicies200Response**](GetManyPolicies200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_policy
+
+> <PolicyData> get_policy(policy_id)
+
+
+
+Read a specific policy
+
+### Examples
+
+```ruby
+require 'time'
+require 'metronome'
+# setup authorization
+Metronome.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
+end
+
+api_instance = Metronome::PolicyManagementApi.new
+policy_id = 'policy_id_example' # String | 
+
+begin
+  
+  result = api_instance.get_policy(policy_id)
+  p result
+rescue Metronome::ApiError => e
+  puts "Error when calling PolicyManagementApi->get_policy: #{e}"
+end
+```
+
+#### Using the get_policy_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PolicyData>, Integer, Hash)> get_policy_with_http_info(policy_id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_policy_with_http_info(policy_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PolicyData>
+rescue Metronome::ApiError => e
+  puts "Error when calling PolicyManagementApi->get_policy_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **policy_id** | **String** |  |  |
+
+### Return type
+
+[**PolicyData**](PolicyData.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_policy_log
+
+> <PolicyData> get_policy_log(policy_id)
+
+
+
+Read a specific policy's access log
+
+### Examples
+
+```ruby
+require 'time'
+require 'metronome'
+# setup authorization
+Metronome.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
+end
+
+api_instance = Metronome::PolicyManagementApi.new
+policy_id = 'policy_id_example' # String | 
+
+begin
+  
+  result = api_instance.get_policy_log(policy_id)
+  p result
+rescue Metronome::ApiError => e
+  puts "Error when calling PolicyManagementApi->get_policy_log: #{e}"
+end
+```
+
+#### Using the get_policy_log_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PolicyData>, Integer, Hash)> get_policy_log_with_http_info(policy_id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_policy_log_with_http_info(policy_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PolicyData>
+rescue Metronome::ApiError => e
+  puts "Error when calling PolicyManagementApi->get_policy_log_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **policy_id** | **String** |  |  |
+
+### Return type
+
+[**PolicyData**](PolicyData.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_policy_members
+
+> <PolicyData> get_policy_members(policy_id)
+
+
+
+Read the items and sub-items that have been used for a specific policy
+
+### Examples
+
+```ruby
+require 'time'
+require 'metronome'
+# setup authorization
+Metronome.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
+end
+
+api_instance = Metronome::PolicyManagementApi.new
+policy_id = 'policy_id_example' # String | 
+
+begin
+  
+  result = api_instance.get_policy_members(policy_id)
+  p result
+rescue Metronome::ApiError => e
+  puts "Error when calling PolicyManagementApi->get_policy_members: #{e}"
+end
+```
+
+#### Using the get_policy_members_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PolicyData>, Integer, Hash)> get_policy_members_with_http_info(policy_id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_policy_members_with_http_info(policy_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PolicyData>
+rescue Metronome::ApiError => e
+  puts "Error when calling PolicyManagementApi->get_policy_members_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **policy_id** | **String** |  |  |
+
+### Return type
+
+[**PolicyData**](PolicyData.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## put_policy
+
+> <CreateOrModifyPolicyResponse> put_policy(policy_id, opts)
+
+
+
+Create or modify a policy
+
+### Examples
+
+```ruby
+require 'time'
+require 'metronome'
+# setup authorization
+Metronome.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['ApiKeyAuth'] = '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['ApiKeyAuth'] = 'Bearer'
+end
+
+api_instance = Metronome::PolicyManagementApi.new
+policy_id = 'policy_id_example' # String | The name of the policy to be created
+opts = {
+  create_or_modify_policy_request: Metronome::CreateOrModifyPolicyRequest.new({aging_strategy: Metronome::AgingStrategy::FIRST_READ_OR_WRITE, aging_offset_amount: 37, aging_offset_unit: Metronome::AgingOffsetUnit::YEAR}) # CreateOrModifyPolicyRequest | 
+}
+
+begin
+  
+  result = api_instance.put_policy(policy_id, opts)
+  p result
+rescue Metronome::ApiError => e
+  puts "Error when calling PolicyManagementApi->put_policy: #{e}"
+end
+```
+
+#### Using the put_policy_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateOrModifyPolicyResponse>, Integer, Hash)> put_policy_with_http_info(policy_id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.put_policy_with_http_info(policy_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateOrModifyPolicyResponse>
+rescue Metronome::ApiError => e
+  puts "Error when calling PolicyManagementApi->put_policy_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **policy_id** | **String** | The name of the policy to be created |  |
+| **create_or_modify_policy_request** | [**CreateOrModifyPolicyRequest**](CreateOrModifyPolicyRequest.md) |  | [optional] |
+
+### Return type
+
+[**CreateOrModifyPolicyResponse**](CreateOrModifyPolicyResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PutApiKeyRequest.md

@@ -0,0 +1,49 @@
+# Metronome::PutApiKeyRequest
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'metronome'
+
+Metronome::PutApiKeyRequest.openapi_one_of
+# =>
+# [
+#   :'CreateApiKeyRequest',
+#   :'ModifyApiKeyRequest'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'metronome'
+
+Metronome::PutApiKeyRequest.build(data)
+# => #<CreateApiKeyRequest:0x00007fdd4aab02a0>
+
+Metronome::PutApiKeyRequest.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `CreateApiKeyRequest`
+- `ModifyApiKeyRequest`
+- `nil` (if no type matches)
+

data/docs/SignupRequest.md

@@ -0,0 +1,18 @@
+# Metronome::SignupRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **internal_contact** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'metronome'
+
+instance = Metronome::SignupRequest.new(
+  internal_contact: data-protection-it-manager@yourdomain.com
+)
+```
+

data/docs/SignupResponse.md

@@ -0,0 +1,24 @@
+# Metronome::SignupResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dev_api_url** | **String** |  |  |
+| **dev_master_api_key** | **String** |  |  |
+| **production_api_url** | **String** |  |  |
+| **production_master_api_key** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'metronome'
+
+instance = Metronome::SignupResponse.new(
+  dev_api_url: https://your-customer-id.dev-api.eu-north-1.tantalus.privatedataservices.com,
+  dev_master_api_key: abcdefgh1234567,
+  production_api_url: https://your-customer-id.api.eu-north-1.tantalus.privatedataservices.com,
+  production_master_api_key: abcdefgh1234567
+)
+```
+

data/docs/SubItemMetadataResponse.md

@@ -0,0 +1,22 @@
+# Metronome::SubItemMetadataResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expired** | **Boolean** | Present and true only when the item has expired | [optional] |
+| **policy_id** | **String** | The policy which currently governs how long this item will be retained |  |
+| **expiry_date** | **Date** | The date at which this item will expire if it is not used again | [optional] |
+
+## Example
+
+```ruby
+require 'metronome'
+
+instance = Metronome::SubItemMetadataResponse.new(
+  expired: null,
+  policy_id: null,
+  expiry_date: null
+)
+```
+

data/docs/SubItemsExpiry.md

@@ -0,0 +1,22 @@
+# Metronome::SubItemsExpiry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expiry_type** | **String** | Always the value \"SubItemsExpiry\" |  |
+| **parent_item_id** | **String** |  |  |
+| **sub_items** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'metronome'
+
+instance = Metronome::SubItemsExpiry.new(
+  expiry_type: null,
+  parent_item_id: customer-123,
+  sub_items: ["email","mobile-phone"]
+)
+```
+