Interface IEconomyAdminApi

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: Unity.Services.Apis.Admin.Economy

Assembly: Unity.Services.Apis.dll

Syntax

public interface IEconomyAdminApi : IApiAccessor

Methods

AddConfigResource(string, string, AddConfigResourceRequest, CancellationToken)

Add Config Resource

Declaration

ApiOperation<AddConfigResource201Response> AddConfigResource(string projectId, string environmentId, AddConfigResourceRequest addConfigResourceRequest, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	environmentId	ID of the environment
AddConfigResourceRequest	addConfigResourceRequest	Add config resource, currency, inventory item.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<AddConfigResource201Response>	The operation

DeleteConfigResource(string, string, string, CancellationToken)

Delete Config Resource

Declaration

ApiOperation DeleteConfigResource(string projectId, string environmentId, string resourceId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	environmentId	ID of the environment
string	resourceId	Unique identifier for the resource
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

EditConfigResource(string, string, string, AddConfigResourceRequest, CancellationToken)

Edit Config Resource

Declaration

ApiOperation<AddConfigResource201Response> EditConfigResource(string projectId, string environmentId, string resourceId, AddConfigResourceRequest addConfigResourceRequest, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	environmentId	ID of the environment
string	resourceId	Unique identifier for the resource
AddConfigResourceRequest	addConfigResourceRequest	Edit an entity config item.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<AddConfigResource201Response>	The operation

GetPublishedResources(string, string, int?, int?, CancellationToken)

Get Published Resources

Declaration

ApiOperation<GetPublishedResourcesResponse> GetPublishedResources(string projectId, string environmentId, int? offset = null, int? limit = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	environmentId	ID of the environment
int?	offset	Defaults to 0 (optional)
int?	limit	Number of items to be returned. Defaults to 1000 (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<GetPublishedResourcesResponse>	The operation

GetResources(string, string, int?, int?, CancellationToken)

Get Resources

Declaration

ApiOperation<GetResourcesResponse> GetResources(string projectId, string environmentId, int? offset = null, int? limit = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	environmentId	ID of the environment
int?	offset	Defaults to 0 (optional)
int?	limit	Number of items to be returned. Defaults to 1000 (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<GetResourcesResponse>	The operation

PublishEconomy(string, string, PublishBody, CancellationToken)

Publish Economy

Declaration

ApiOperation PublishEconomy(string projectId, string environmentId, PublishBody publishBody, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	environmentId	ID of the environment
PublishBody	publishBody
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation