cmv4-openapi-client 1.0.3

data/docs/RelationshipMembershipsApi.md

@@ -0,0 +1,458 @@
+# CMV4APIClient::RelationshipMembershipsApi
+
+All URIs are relative to *https://nfplayground.api.cmv4-stable.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**memberships_create**](RelationshipMembershipsApi.md#memberships_create) | **POST** /relationships/membership | Create a new membership relationship
+[**memberships_delete**](RelationshipMembershipsApi.md#memberships_delete) | **DELETE** /relationships/membership/{id} | Delete a membership
+[**memberships_delete_using_post**](RelationshipMembershipsApi.md#memberships_delete_using_post) | **POST** /relationships/membership/{id}/delete | Delete a membership
+[**memberships_get_all**](RelationshipMembershipsApi.md#memberships_get_all) | **GET** /relationships/membership?{page}&{pageSize} | Gets All Memberships Data
+[**memberships_get_by_id**](RelationshipMembershipsApi.md#memberships_get_by_id) | **GET** /relationships/membership/{id} | Get membership By Id
+[**memberships_get_count**](RelationshipMembershipsApi.md#memberships_get_count) | **GET** /relationships/membership/count | Get Memberships Count
+[**memberships_modify**](RelationshipMembershipsApi.md#memberships_modify) | **PATCH** /relationships/membership/{id} | Modify a membership
+[**memberships_restore**](RelationshipMembershipsApi.md#memberships_restore) | **POST** /relationships/membership/{id}/restore | Restore a membership
+
+
+
+## memberships_create
+
+> Membership memberships_create(ensure_relationship_instance_command_data)
+
+Create a new membership relationship
+
+Creates a new membership relationship
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+# setup authorization
+CMV4APIClient.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: Username / E-mail and Password
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CMV4APIClient::RelationshipMembershipsApi.new
+ensure_relationship_instance_command_data = {"DataVersion":0,"Values":{"stereotypeId":"9b8eb07e-5c8c-4903-a774-cb423cea7b53","LeftHandId":0,"RightHandId":0}} # EnsureRelationshipInstanceCommandData |
+
+begin
+  #Create a new membership relationship
+  result = api_instance.memberships_create(ensure_relationship_instance_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipMembershipsApi->memberships_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ensure_relationship_instance_command_data** | [**EnsureRelationshipInstanceCommandData**](EnsureRelationshipInstanceCommandData.md)|  |
+
+### Return type
+
+[**Membership**](Membership.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer), [Username / E-mail and Password](../README.md#Username / E-mail and Password)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## memberships_delete
+
+> Object memberships_delete(id)
+
+Delete a membership
+
+Deletes an existing membership.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+# setup authorization
+CMV4APIClient.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: Username / E-mail and Password
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CMV4APIClient::RelationshipMembershipsApi.new
+id = 56 # Integer |
+
+begin
+  #Delete a membership
+  result = api_instance.memberships_delete(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipMembershipsApi->memberships_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Bearer](../README.md#Bearer), [Username / E-mail and Password](../README.md#Username / E-mail and Password)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## memberships_delete_using_post
+
+> Object memberships_delete_using_post(id)
+
+Delete a membership
+
+Deletes an existing membership.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+# setup authorization
+CMV4APIClient.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: Username / E-mail and Password
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CMV4APIClient::RelationshipMembershipsApi.new
+id = 56 # Integer |
+
+begin
+  #Delete a membership
+  result = api_instance.memberships_delete_using_post(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipMembershipsApi->memberships_delete_using_post: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Bearer](../README.md#Bearer), [Username / E-mail and Password](../README.md#Username / E-mail and Password)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## memberships_get_all
+
+> Membership memberships_get_all(opts)
+
+Gets All Memberships Data
+
+Gets all the data for the memberships relationship
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+# setup authorization
+CMV4APIClient.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: Username / E-mail and Password
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CMV4APIClient::RelationshipMembershipsApi.new
+opts = {
+  page: 56, # Integer |
+  page_size: 56 # Integer |
+}
+
+begin
+  #Gets All Memberships Data
+  result = api_instance.memberships_get_all(opts)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipMembershipsApi->memberships_get_all: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**|  | [optional]
+ **page_size** | **Integer**|  | [optional]
+
+### Return type
+
+[**Membership**](Membership.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer), [Username / E-mail and Password](../README.md#Username / E-mail and Password)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## memberships_get_by_id
+
+> Membership memberships_get_by_id(id)
+
+Get membership By Id
+
+Gets a single membership by its Id
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+# setup authorization
+CMV4APIClient.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: Username / E-mail and Password
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CMV4APIClient::RelationshipMembershipsApi.new
+id = 56 # Integer |
+
+begin
+  #Get membership By Id
+  result = api_instance.memberships_get_by_id(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipMembershipsApi->memberships_get_by_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+
+### Return type
+
+[**Membership**](Membership.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer), [Username / E-mail and Password](../README.md#Username / E-mail and Password)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## memberships_get_count
+
+> Integer memberships_get_count
+
+Get Memberships Count
+
+Gets the count of all Memberships
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+# setup authorization
+CMV4APIClient.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: Username / E-mail and Password
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CMV4APIClient::RelationshipMembershipsApi.new
+
+begin
+  #Get Memberships Count
+  result = api_instance.memberships_get_count
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipMembershipsApi->memberships_get_count: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Integer**
+
+### Authorization
+
+[Bearer](../README.md#Bearer), [Username / E-mail and Password](../README.md#Username / E-mail and Password)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## memberships_modify
+
+> Membership memberships_modify(id, ensure_relationship_instance_command_data)
+
+Modify a membership
+
+Modify an existing membership.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+# setup authorization
+CMV4APIClient.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: Username / E-mail and Password
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CMV4APIClient::RelationshipMembershipsApi.new
+id = 56 # Integer |
+ensure_relationship_instance_command_data = {"DataVersion":0,"Values":{"stereotypeId":"d2f9685e-8d99-4c16-80a1-7ed0454e627b","LeftHandId":0,"RightHandId":0}} # EnsureRelationshipInstanceCommandData |
+
+begin
+  #Modify a membership
+  result = api_instance.memberships_modify(id, ensure_relationship_instance_command_data)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipMembershipsApi->memberships_modify: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+ **ensure_relationship_instance_command_data** | [**EnsureRelationshipInstanceCommandData**](EnsureRelationshipInstanceCommandData.md)|  |
+
+### Return type
+
+[**Membership**](Membership.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer), [Username / E-mail and Password](../README.md#Username / E-mail and Password)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## memberships_restore
+
+> Object memberships_restore(id)
+
+Restore a membership
+
+Restores a membership.
+
+### Example
+
+```ruby
+# load the gem
+require 'cmv4-openapi-client'
+# setup authorization
+CMV4APIClient.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: Username / E-mail and Password
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CMV4APIClient::RelationshipMembershipsApi.new
+id = 56 # Integer |
+
+begin
+  #Restore a membership
+  result = api_instance.memberships_restore(id)
+  p result
+rescue CMV4APIClient::ApiError => e
+  puts "Exception when calling RelationshipMembershipsApi->memberships_restore: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Bearer](../README.md#Bearer), [Username / E-mail and Password](../README.md#Username / E-mail and Password)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+