pds-metronome 0.1.0

data/docs/CreateOrModifyPolicyResponse.md

@@ -0,0 +1,20 @@
+# Metronome::CreateOrModifyPolicyResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **policy_id** | **String** |  |  |
+| **fields_updated** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'metronome'
+
+instance = Metronome::CreateOrModifyPolicyResponse.new(
+  policy_id: account-login,
+  fields_updated: ["aging-offset-amount","aging-offset-unit"]
+)
+```
+

data/docs/DataExpiryApi.md

@@ -0,0 +1,79 @@
+# Metronome::DataExpiryApi
+
+All URIs are relative to *https://YOUR-CUSTOMER-ID.api.eu-north-1.privatedataservices.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_expiry_notices**](DataExpiryApi.md#get_expiry_notices) | **GET** /v1/metronome/expiry-notices/{date} |  |
+
+
+## get_expiry_notices
+
+> <ExpiryResponse> get_expiry_notices(date)
+
+
+
+Read items and sub-items that will or have already been expired on the given date
+
+### 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::DataExpiryApi.new
+date = Date.parse('2013-10-20') # Date | The date to query
+
+begin
+  
+  result = api_instance.get_expiry_notices(date)
+  p result
+rescue Metronome::ApiError => e
+  puts "Error when calling DataExpiryApi->get_expiry_notices: #{e}"
+end
+```
+
+#### Using the get_expiry_notices_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExpiryResponse>, Integer, Hash)> get_expiry_notices_with_http_info(date)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_expiry_notices_with_http_info(date)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExpiryResponse>
+rescue Metronome::ApiError => e
+  puts "Error when calling DataExpiryApi->get_expiry_notices_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** | The date to query |  |
+
+### Return type
+
+[**ExpiryResponse**](ExpiryResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ExpireItemResponse.md

@@ -0,0 +1,20 @@
+# Metronome::ExpireItemResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item_id** | **String** |  |  |
+| **sub_items_expired** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'metronome'
+
+instance = Metronome::ExpireItemResponse.new(
+  item_id: customer-123,
+  sub_items_expired: ["email","mobile-phone"]
+)
+```
+

data/docs/ExpireSubItemResponse.md

@@ -0,0 +1,22 @@
+# Metronome::ExpireSubItemResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item_id** | **String** |  |  |
+| **sub_item_id** | **String** |  |  |
+| **fields_updated** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'metronome'
+
+instance = Metronome::ExpireSubItemResponse.new(
+  item_id: customer-123,
+  sub_item_id: email,
+  fields_updated: ["policies","expired"]
+)
+```
+

data/docs/ExpiryResponse.md

@@ -0,0 +1,22 @@
+# Metronome::ExpiryResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expiry_date** | **Date** | Date in YYYYMMDD format. |  |
+| **pending** | [**Array<ExpiryResponsePendingInner>**](ExpiryResponsePendingInner.md) |  |  |
+| **complete** | [**Array<ExpiryResponsePendingInner>**](ExpiryResponsePendingInner.md) |  |  |
+
+## Example
+
+```ruby
+require 'metronome'
+
+instance = Metronome::ExpiryResponse.new(
+  expiry_date: null,
+  pending: null,
+  complete: null
+)
+```
+

data/docs/ExpiryResponsePendingInner.md

@@ -0,0 +1,79 @@
+# Metronome::ExpiryResponsePendingInner
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'metronome'
+
+Metronome::ExpiryResponsePendingInner.openapi_one_of
+# =>
+# [
+#   :'ItemExpiry',
+#   :'SubItemsExpiry'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'metronome'
+
+Metronome::ExpiryResponsePendingInner.openapi_discriminator_name
+# => :'expiry_type'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'metronome'
+
+Metronome::ExpiryResponsePendingInner.openapi_discriminator_mapping
+# =>
+# {
+#   :'ItemExpiry' => :'ItemExpiry',
+#   :'SubItemsExpiry' => :'SubItemsExpiry'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'metronome'
+
+Metronome::ExpiryResponsePendingInner.build(data)
+# => #<ItemExpiry:0x00007fdd4aab02a0>
+
+Metronome::ExpiryResponsePendingInner.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ItemExpiry`
+- `SubItemsExpiry`
+- `nil` (if no type matches)
+

data/docs/GetManyApiKeys200Response.md

@@ -0,0 +1,79 @@
+# Metronome::GetManyApiKeys200Response
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'metronome'
+
+Metronome::GetManyApiKeys200Response.openapi_one_of
+# =>
+# [
+#   :'ApiKeyDataListResponse',
+#   :'ApiKeyListResponse'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'metronome'
+
+Metronome::GetManyApiKeys200Response.openapi_discriminator_name
+# => :'response_type'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'metronome'
+
+Metronome::GetManyApiKeys200Response.openapi_discriminator_mapping
+# =>
+# {
+#   :'ApiKeyDataListResponse' => :'ApiKeyDataListResponse',
+#   :'ApiKeyListResponse' => :'ApiKeyListResponse'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'metronome'
+
+Metronome::GetManyApiKeys200Response.build(data)
+# => #<ApiKeyDataListResponse:0x00007fdd4aab02a0>
+
+Metronome::GetManyApiKeys200Response.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ApiKeyDataListResponse`
+- `ApiKeyListResponse`
+- `nil` (if no type matches)
+

data/docs/GetManyPolicies200Response.md

@@ -0,0 +1,79 @@
+# Metronome::GetManyPolicies200Response
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'metronome'
+
+Metronome::GetManyPolicies200Response.openapi_one_of
+# =>
+# [
+#   :'PolicyDataListResponse',
+#   :'PolicyListResponse'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'metronome'
+
+Metronome::GetManyPolicies200Response.openapi_discriminator_name
+# => :'response_type'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'metronome'
+
+Metronome::GetManyPolicies200Response.openapi_discriminator_mapping
+# =>
+# {
+#   :'PolicyDataListResponse' => :'PolicyDataListResponse',
+#   :'PolicyListResponse' => :'PolicyListResponse'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'metronome'
+
+Metronome::GetManyPolicies200Response.build(data)
+# => #<PolicyDataListResponse:0x00007fdd4aab02a0>
+
+Metronome::GetManyPolicies200Response.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `PolicyDataListResponse`
+- `PolicyListResponse`
+- `nil` (if no type matches)
+