C# Class RingCentral.EngageDigital.Api.TagsApi

Represents a collection of functions to interact with the API endpoints

Inheritance: ITagsApi

ファイルを表示 Open project: joalmeid/engage-digital-client-csharp

Public Methods

Method	Description
CreateTag ( string name ) : Tag	Creating a tag This method creates a new tag. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).
CreateTagAsync ( string name ) : System.Threading.Tasks.Task	Creating a tag This method creates a new tag. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).
CreateTagAsyncWithHttpInfo ( string name ) : System.Threading.Tasks.Task>	Creating a tag This method creates a new tag. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).
CreateTagWithHttpInfo ( string name ) : RingCentral.EngageDigital.Client.ApiResponse	Creating a tag This method creates a new tag. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).
DeleteTag ( string tagId ) : Tag	Deleting a tag This method destroys an existing tag. It renders tag itself. It renders a 404 if id is invalid. Authorization: only users that are able to destroy tags.
DeleteTagAsync ( string tagId ) : System.Threading.Tasks.Task	Deleting a tag This method destroys an existing tag. It renders tag itself. It renders a 404 if id is invalid. Authorization: only users that are able to destroy tags.
DeleteTagAsyncWithHttpInfo ( string tagId ) : System.Threading.Tasks.Task>	Deleting a tag This method destroys an existing tag. It renders tag itself. It renders a 404 if id is invalid. Authorization: only users that are able to destroy tags.
DeleteTagWithHttpInfo ( string tagId ) : RingCentral.EngageDigital.Client.ApiResponse	Deleting a tag This method destroys an existing tag. It renders tag itself. It renders a 404 if id is invalid. Authorization: only users that are able to destroy tags.
GetAllTags ( int? offset = default(int?), int? limit = default(int?) ) : GetAllTagsResponse	Getting all tags This method renders tags ordered by name (ascending).
GetAllTagsAsync ( int? offset = default(int?), int? limit = default(int?) ) : System.Threading.Tasks.Task	Getting all tags This method renders tags ordered by name (ascending).
GetAllTagsAsyncWithHttpInfo ( int? offset = default(int?), int? limit = default(int?) ) : System.Threading.Tasks.Task>	Getting all tags This method renders tags ordered by name (ascending).
GetAllTagsWithHttpInfo ( int? offset = default(int?), int? limit = default(int?) ) : RingCentral.EngageDigital.Client.ApiResponse	Getting all tags This method renders tags ordered by name (ascending).
GetBasePath ( ) : String	Gets the base path of the API client.
GetTag ( string tagId ) : Tag	Getting a tag from its id This method renders a tag from given id.
GetTagAsync ( string tagId ) : System.Threading.Tasks.Task	Getting a tag from its id This method renders a tag from given id.
GetTagAsyncWithHttpInfo ( string tagId ) : System.Threading.Tasks.Task>	Getting a tag from its id This method renders a tag from given id.
GetTagWithHttpInfo ( string tagId ) : RingCentral.EngageDigital.Client.ApiResponse	Getting a tag from its id This method renders a tag from given id.
TagsApi ( ) : System	Initializes a new instance of the TagsApi class.
TagsApi ( RingCentral.EngageDigital.Client.Configuration configuration ) : System	Initializes a new instance of the TagsApi class using Configuration object
TagsApi ( RingCentral.EngageDigital.Client.ISynchronousClient client, RingCentral.EngageDigital.Client.IAsynchronousClient asyncClient, RingCentral.EngageDigital.Client.IReadableConfiguration configuration ) : System	Initializes a new instance of the TagsApi class using a Configuration object and client instance.
TagsApi ( String basePath ) : System	Initializes a new instance of the TagsApi class.
UpdateTag ( string tagId, string name ) : Tag	Updating a tag This method updates an existing tag from given attributes and renders it in case of success. Authorization: only users that are able to update tags.
UpdateTagAsync ( string tagId, string name ) : System.Threading.Tasks.Task	Updating a tag This method updates an existing tag from given attributes and renders it in case of success. Authorization: only users that are able to update tags.
UpdateTagAsyncWithHttpInfo ( string tagId, string name ) : System.Threading.Tasks.Task>	Updating a tag This method updates an existing tag from given attributes and renders it in case of success. Authorization: only users that are able to update tags.
UpdateTagWithHttpInfo ( string tagId, string name ) : RingCentral.EngageDigital.Client.ApiResponse	Updating a tag This method updates an existing tag from given attributes and renders it in case of success. Authorization: only users that are able to update tags.

Method Details

CreateTag() public method

Creating a tag This method creates a new tag. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).

Thrown when fails to make API call

public CreateTag ( string name ) : Tag
name	string	Tag name (mandatory).
return	Tag

CreateTagAsync() public method

Creating a tag This method creates a new tag. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).

Thrown when fails to make API call

public CreateTagAsync ( string name ) : System.Threading.Tasks.Task
name	string	Tag name (mandatory).
return	System.Threading.Tasks.Task

CreateTagAsyncWithHttpInfo() public method

Creating a tag This method creates a new tag. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).

Thrown when fails to make API call

public CreateTagAsyncWithHttpInfo ( string name ) : System.Threading.Tasks.Task>
name	string	Tag name (mandatory).
return	System.Threading.Tasks.Task>

CreateTagWithHttpInfo() public method

Creating a tag This method creates a new tag. In case of success it renders the created tag, otherwise, it renders an error (422 HTTP code).

Thrown when fails to make API call

public CreateTagWithHttpInfo ( string name ) : RingCentral.EngageDigital.Client.ApiResponse
name	string	Tag name (mandatory).
return	RingCentral.EngageDigital.Client.ApiResponse

DeleteTag() public method

Deleting a tag This method destroys an existing tag. It renders tag itself. It renders a 404 if id is invalid. Authorization: only users that are able to destroy tags.

Thrown when fails to make API call

public DeleteTag ( string tagId ) : Tag
tagId	string
return	Tag

DeleteTagAsync() public method

Deleting a tag This method destroys an existing tag. It renders tag itself. It renders a 404 if id is invalid. Authorization: only users that are able to destroy tags.

Thrown when fails to make API call

public DeleteTagAsync ( string tagId ) : System.Threading.Tasks.Task
tagId	string
return	System.Threading.Tasks.Task

DeleteTagAsyncWithHttpInfo() public method

Deleting a tag This method destroys an existing tag. It renders tag itself. It renders a 404 if id is invalid. Authorization: only users that are able to destroy tags.

Thrown when fails to make API call

public DeleteTagAsyncWithHttpInfo ( string tagId ) : System.Threading.Tasks.Task>
tagId	string
return	System.Threading.Tasks.Task>

DeleteTagWithHttpInfo() public method

Deleting a tag This method destroys an existing tag. It renders tag itself. It renders a 404 if id is invalid. Authorization: only users that are able to destroy tags.

Thrown when fails to make API call

public DeleteTagWithHttpInfo ( string tagId ) : RingCentral.EngageDigital.Client.ApiResponse
tagId	string
return	RingCentral.EngageDigital.Client.ApiResponse

GetAllTags() public method

Getting all tags This method renders tags ordered by name (ascending).

Thrown when fails to make API call

public GetAllTags ( int? offset = default(int?), int? limit = default(int?) ) : GetAllTagsResponse
offset	int?	The record index to start. Default value is 0. (optional)
limit	int?	The max number of records to return. Default value is 30, max value is 150. (optional)
return	GetAllTagsResponse

GetAllTagsAsync() public method

Getting all tags This method renders tags ordered by name (ascending).

Thrown when fails to make API call

public GetAllTagsAsync ( int? offset = default(int?), int? limit = default(int?) ) : System.Threading.Tasks.Task
offset	int?	The record index to start. Default value is 0. (optional)
limit	int?	The max number of records to return. Default value is 30, max value is 150. (optional)
return	System.Threading.Tasks.Task

GetAllTagsAsyncWithHttpInfo() public method

Getting all tags This method renders tags ordered by name (ascending).

Thrown when fails to make API call

public GetAllTagsAsyncWithHttpInfo ( int? offset = default(int?), int? limit = default(int?) ) : System.Threading.Tasks.Task>
offset	int?	The record index to start. Default value is 0. (optional)
limit	int?	The max number of records to return. Default value is 30, max value is 150. (optional)
return	System.Threading.Tasks.Task>

GetAllTagsWithHttpInfo() public method

Getting all tags This method renders tags ordered by name (ascending).

Thrown when fails to make API call

public GetAllTagsWithHttpInfo ( int? offset = default(int?), int? limit = default(int?) ) : RingCentral.EngageDigital.Client.ApiResponse
offset	int?	The record index to start. Default value is 0. (optional)
limit	int?	The max number of records to return. Default value is 30, max value is 150. (optional)
return	RingCentral.EngageDigital.Client.ApiResponse

GetBasePath() public method

Gets the base path of the API client.

public GetBasePath ( ) : String
return	String

GetTag() public method

Getting a tag from its id This method renders a tag from given id.

Thrown when fails to make API call

public GetTag ( string tagId ) : Tag
tagId	string
return	Tag

GetTagAsync() public method

Getting a tag from its id This method renders a tag from given id.

Thrown when fails to make API call

public GetTagAsync ( string tagId ) : System.Threading.Tasks.Task
tagId	string
return	System.Threading.Tasks.Task

GetTagAsyncWithHttpInfo() public method

Getting a tag from its id This method renders a tag from given id.

Thrown when fails to make API call

public GetTagAsyncWithHttpInfo ( string tagId ) : System.Threading.Tasks.Task>
tagId	string
return	System.Threading.Tasks.Task>

GetTagWithHttpInfo() public method

Getting a tag from its id This method renders a tag from given id.

Thrown when fails to make API call

public GetTagWithHttpInfo ( string tagId ) : RingCentral.EngageDigital.Client.ApiResponse
tagId	string
return	RingCentral.EngageDigital.Client.ApiResponse

TagsApi() public method

Initializes a new instance of the TagsApi class.

public TagsApi ( ) : System
return	System

TagsApi() public method

Initializes a new instance of the TagsApi class using Configuration object

public TagsApi ( RingCentral.EngageDigital.Client.Configuration configuration ) : System
configuration	RingCentral.EngageDigital.Client.Configuration	An instance of Configuration
return	System

TagsApi() public method

Initializes a new instance of the TagsApi class using a Configuration object and client instance.

public TagsApi ( RingCentral.EngageDigital.Client.ISynchronousClient client, RingCentral.EngageDigital.Client.IAsynchronousClient asyncClient, RingCentral.EngageDigital.Client.IReadableConfiguration configuration ) : System
client	RingCentral.EngageDigital.Client.ISynchronousClient	The client interface for synchronous API access.
asyncClient	RingCentral.EngageDigital.Client.IAsynchronousClient	The client interface for asynchronous API access.
configuration	RingCentral.EngageDigital.Client.IReadableConfiguration	The configuration object.
return	System

TagsApi() public method

Initializes a new instance of the TagsApi class.

public TagsApi ( String basePath ) : System
basePath	String
return	System

UpdateTag() public method

Updating a tag This method updates an existing tag from given attributes and renders it in case of success. Authorization: only users that are able to update tags.

Thrown when fails to make API call

public UpdateTag ( string tagId, string name ) : Tag
tagId	string
name	string	Tag’s label.
return	Tag

UpdateTagAsync() public method

Updating a tag This method updates an existing tag from given attributes and renders it in case of success. Authorization: only users that are able to update tags.

Thrown when fails to make API call

public UpdateTagAsync ( string tagId, string name ) : System.Threading.Tasks.Task
tagId	string
name	string	Tag’s label.
return	System.Threading.Tasks.Task

UpdateTagAsyncWithHttpInfo() public method

Updating a tag This method updates an existing tag from given attributes and renders it in case of success. Authorization: only users that are able to update tags.

Thrown when fails to make API call

public UpdateTagAsyncWithHttpInfo ( string tagId, string name ) : System.Threading.Tasks.Task>
tagId	string
name	string	Tag’s label.
return	System.Threading.Tasks.Task>

UpdateTagWithHttpInfo() public method

Updating a tag This method updates an existing tag from given attributes and renders it in case of success. Authorization: only users that are able to update tags.

Thrown when fails to make API call

public UpdateTagWithHttpInfo ( string tagId, string name ) : RingCentral.EngageDigital.Client.ApiResponse
tagId	string
name	string	Tag’s label.
return	RingCentral.EngageDigital.Client.ApiResponse