order_cloud 1.0.45.pre.staging → 1.0.57

data/docs/TokenPasswordReset.md

@@ -0,0 +1,8 @@
+# OrderCloud::TokenPasswordReset
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**new_password** | **String** |  | [optional] 
+
+

data/docs/User.md

@@ -0,0 +1,18 @@
+# OrderCloud::User
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**username** | **String** |  | [optional] 
+**password** | **String** |  | [optional] 
+**first_name** | **String** |  | [optional] 
+**last_name** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**phone** | **String** |  | [optional] 
+**terms_accepted** | **String** |  | [optional] 
+**active** | **BOOLEAN** |  | [optional] 
+**xp** | **Object** |  | [optional] 
+**available_roles** | **Array<String>** |  | [optional] 
+
+

data/docs/UserApi.md

@@ -0,0 +1,400 @@
+# OrderCloud::UserApi
+
+All URIs are relative to *https://api.ordercloud.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](UserApi.md#create) | **POST** /buyers/{buyerID}/users | 
+[**delete**](UserApi.md#delete) | **DELETE** /buyers/{buyerID}/users/{userID} | 
+[**get**](UserApi.md#get) | **GET** /buyers/{buyerID}/users/{userID} | 
+[**get_access_token**](UserApi.md#get_access_token) | **POST** /buyers/{buyerID}/users/{userID}/accesstoken | 
+[**list**](UserApi.md#list) | **GET** /buyers/{buyerID}/users | 
+[**patch**](UserApi.md#patch) | **PATCH** /buyers/{buyerID}/users/{userID} | 
+[**update**](UserApi.md#update) | **PUT** /buyers/{buyerID}/users/{userID} | 
+
+
+# **create**
+> User create(buyer_id, user)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::UserApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+user = OrderCloud::User.new # User | 
+
+
+begin
+  result = api_instance.create(buyer_id, user)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling UserApi->create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **user** | [**User**](User.md)|  | 
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **delete**
+> delete(buyer_id, user_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::UserApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+user_id = "user_id_example" # String | ID of the user.
+
+
+begin
+  api_instance.delete(buyer_id, user_id)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling UserApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **user_id** | **String**| ID of the user. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **get**
+> User get(buyer_id, user_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::UserApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+user_id = "user_id_example" # String | ID of the user.
+
+
+begin
+  result = api_instance.get(buyer_id, user_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling UserApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **user_id** | **String**| ID of the user. | 
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **get_access_token**
+> AccessToken get_access_token(buyer_id, user_id, token_request)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::UserApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+user_id = "user_id_example" # String | ID of the user.
+
+token_request = OrderCloud::ImpersonateTokenRequest.new # ImpersonateTokenRequest | 
+
+
+begin
+  result = api_instance.get_access_token(buyer_id, user_id, token_request)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling UserApi->get_access_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **user_id** | **String**| ID of the user. | 
+ **token_request** | [**ImpersonateTokenRequest**](ImpersonateTokenRequest.md)|  | 
+
+### Return type
+
+[**AccessToken**](AccessToken.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list**
+> ListUser list(buyer_id, opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::UserApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+opts = { 
+  user_group_id: "user_group_id_example", # String | ID of the user group.
+  search: "search_example", # String | Search of the user.
+  search_on: ["search_on_example"], # Array<String> | Search on of the user.
+  sort_by: ["sort_by_example"], # Array<String> | Sort by of the user.
+  page: 56, # Integer | Page of the user.
+  page_size: 56, # Integer | Page size of the user.
+  filters: {'key' => "filters_example"} # Hash<String, String> | Filters of the user.
+}
+
+begin
+  result = api_instance.list(buyer_id, opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling UserApi->list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **user_group_id** | **String**| ID of the user group. | [optional] 
+ **search** | **String**| Search of the user. | [optional] 
+ **search_on** | [**Array&lt;String&gt;**](String.md)| Search on of the user. | [optional] 
+ **sort_by** | [**Array&lt;String&gt;**](String.md)| Sort by of the user. | [optional] 
+ **page** | **Integer**| Page of the user. | [optional] 
+ **page_size** | **Integer**| Page size of the user. | [optional] 
+ **filters** | [**Hash&lt;String, String&gt;**](String.md)| Filters of the user. | [optional] 
+
+### Return type
+
+[**ListUser**](ListUser.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **patch**
+> User patch(buyer_id, user_id, user)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::UserApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+user_id = "user_id_example" # String | ID of the user.
+
+user = OrderCloud::User.new # User | 
+
+
+begin
+  result = api_instance.patch(buyer_id, user_id, user)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling UserApi->patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **user_id** | **String**| ID of the user. | 
+ **user** | [**User**](User.md)|  | 
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **update**
+> User update(buyer_id, user_id, user)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::UserApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+user_id = "user_id_example" # String | ID of the user.
+
+user = OrderCloud::User.new # User | 
+
+
+begin
+  result = api_instance.update(buyer_id, user_id, user)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling UserApi->update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **user_id** | **String**| ID of the user. | 
+ **user** | [**User**](User.md)|  | 
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+

data/docs/UserGroup.md

@@ -0,0 +1,11 @@
+# OrderCloud::UserGroup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**xp** | **Object** |  | [optional] 
+
+

data/docs/UserGroupApi.md

@@ -0,0 +1,509 @@
+# OrderCloud::UserGroupApi
+
+All URIs are relative to *https://api.ordercloud.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](UserGroupApi.md#create) | **POST** /buyers/{buyerID}/usergroups | 
+[**delete**](UserGroupApi.md#delete) | **DELETE** /buyers/{buyerID}/usergroups/{userGroupID} | 
+[**delete_user_assignment**](UserGroupApi.md#delete_user_assignment) | **DELETE** /buyers/{buyerID}/usergroups/{userGroupID}/assignments/{userID} | 
+[**get**](UserGroupApi.md#get) | **GET** /buyers/{buyerID}/usergroups/{userGroupID} | 
+[**list**](UserGroupApi.md#list) | **GET** /buyers/{buyerID}/usergroups | 
+[**list_user_assignments**](UserGroupApi.md#list_user_assignments) | **GET** /buyers/{buyerID}/usergroups/assignments | 
+[**patch**](UserGroupApi.md#patch) | **PATCH** /buyers/{buyerID}/usergroups/{userGroupID} | 
+[**save_user_assignment**](UserGroupApi.md#save_user_assignment) | **POST** /buyers/{buyerID}/usergroups/assignments | 
+[**update**](UserGroupApi.md#update) | **PUT** /buyers/{buyerID}/usergroups/{userGroupID} | 
+
+
+# **create**
+> UserGroup create(buyer_id, group)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::UserGroupApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+group = OrderCloud::UserGroup.new # UserGroup | 
+
+
+begin
+  result = api_instance.create(buyer_id, group)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling UserGroupApi->create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **group** | [**UserGroup**](UserGroup.md)|  | 
+
+### Return type
+
+[**UserGroup**](UserGroup.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **delete**
+> delete(buyer_id, user_group_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::UserGroupApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+user_group_id = "user_group_id_example" # String | ID of the user group.
+
+
+begin
+  api_instance.delete(buyer_id, user_group_id)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling UserGroupApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **user_group_id** | **String**| ID of the user group. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **delete_user_assignment**
+> delete_user_assignment(buyer_id, user_group_id, user_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::UserGroupApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+user_group_id = "user_group_id_example" # String | ID of the user group.
+
+user_id = "user_id_example" # String | ID of the user.
+
+
+begin
+  api_instance.delete_user_assignment(buyer_id, user_group_id, user_id)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling UserGroupApi->delete_user_assignment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **user_group_id** | **String**| ID of the user group. | 
+ **user_id** | **String**| ID of the user. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **get**
+> UserGroup get(buyer_id, user_group_id)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::UserGroupApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+user_group_id = "user_group_id_example" # String | ID of the user group.
+
+
+begin
+  result = api_instance.get(buyer_id, user_group_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling UserGroupApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **user_group_id** | **String**| ID of the user group. | 
+
+### Return type
+
+[**UserGroup**](UserGroup.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list**
+> ListUserGroup list(buyer_id, opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::UserGroupApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+opts = { 
+  search: "search_example", # String | Search of the user group.
+  search_on: ["search_on_example"], # Array<String> | Search on of the user group.
+  sort_by: ["sort_by_example"], # Array<String> | Sort by of the user group.
+  page: 56, # Integer | Page of the user group.
+  page_size: 56, # Integer | Page size of the user group.
+  filters: {'key' => "filters_example"} # Hash<String, String> | Filters of the user group.
+}
+
+begin
+  result = api_instance.list(buyer_id, opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling UserGroupApi->list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **search** | **String**| Search of the user group. | [optional] 
+ **search_on** | [**Array&lt;String&gt;**](String.md)| Search on of the user group. | [optional] 
+ **sort_by** | [**Array&lt;String&gt;**](String.md)| Sort by of the user group. | [optional] 
+ **page** | **Integer**| Page of the user group. | [optional] 
+ **page_size** | **Integer**| Page size of the user group. | [optional] 
+ **filters** | [**Hash&lt;String, String&gt;**](String.md)| Filters of the user group. | [optional] 
+
+### Return type
+
+[**ListUserGroup**](ListUserGroup.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_user_assignments**
+> ListUserGroupAssignment list_user_assignments(buyer_id, opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::UserGroupApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+opts = { 
+  user_group_id: "user_group_id_example", # String | ID of the user group.
+  user_id: "user_id_example", # String | ID of the user.
+  page: 56, # Integer | Page of the user group.
+  page_size: 56 # Integer | Page size of the user group.
+}
+
+begin
+  result = api_instance.list_user_assignments(buyer_id, opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling UserGroupApi->list_user_assignments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **user_group_id** | **String**| ID of the user group. | [optional] 
+ **user_id** | **String**| ID of the user. | [optional] 
+ **page** | **Integer**| Page of the user group. | [optional] 
+ **page_size** | **Integer**| Page size of the user group. | [optional] 
+
+### Return type
+
+[**ListUserGroupAssignment**](ListUserGroupAssignment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **patch**
+> UserGroup patch(buyer_id, user_group_id, group)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::UserGroupApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+user_group_id = "user_group_id_example" # String | ID of the user group.
+
+group = OrderCloud::UserGroup.new # UserGroup | 
+
+
+begin
+  result = api_instance.patch(buyer_id, user_group_id, group)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling UserGroupApi->patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **user_group_id** | **String**| ID of the user group. | 
+ **group** | [**UserGroup**](UserGroup.md)|  | 
+
+### Return type
+
+[**UserGroup**](UserGroup.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **save_user_assignment**
+> save_user_assignment(buyer_id, user_group_assignment)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::UserGroupApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+user_group_assignment = OrderCloud::UserGroupAssignment.new # UserGroupAssignment | 
+
+
+begin
+  api_instance.save_user_assignment(buyer_id, user_group_assignment)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling UserGroupApi->save_user_assignment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **user_group_assignment** | [**UserGroupAssignment**](UserGroupAssignment.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **update**
+> UserGroup update(buyer_id, user_group_id, group)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'order_cloud'
+# setup authorization
+OrderCloud.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = OrderCloud::UserGroupApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+user_group_id = "user_group_id_example" # String | ID of the user group.
+
+group = OrderCloud::UserGroup.new # UserGroup | 
+
+
+begin
+  result = api_instance.update(buyer_id, user_group_id, group)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling UserGroupApi->update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **user_group_id** | **String**| ID of the user group. | 
+ **group** | [**UserGroup**](UserGroup.md)|  | 
+
+### Return type
+
+[**UserGroup**](UserGroup.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+