Pyrus.ApiClient

The Pyrus API provides a .NET implementation of core API methods. To get started, you must do the following:

Getting Started

• Install the Pyrus.API library using the nuget package manager

Install-Package Pyrus.ApiClient

• Specify proxy settings if necessary

PyrusClient.Settings.ProxyIp = "127.0.0.1";
PyrusClient.Settings.ProxyPort = "8080";
PyrusClient.Settings.ProxyUserName = "UserName";
PyrusClient.Settings.ProxyPassword = "P@ssw0rd";

• Create an API client

var pyrusClient = new PyrusClient();

• Perform authorization

var authResponse = await pyrusClient.Auth(	
  "[email protected]", 
  "security_key_from_profile");

Now you're ready to use other API methods.

Forms

• Get all form templates

var formsResponse = await RequestBuilder.GetForms().Process(pyrusClient);
var forms = formsResponse.Forms;

• Get tasks list by form template

var formId = 14653;
var formRegisterResponse = await RequestBuilder
	.GetRegistry(formId)
	.IncludingArchived()
	.FilteredBy
	.Field(5).EqualsTo(253)
	.Field(2).GreaterThen(DateTime.Today.AddDays(-5))
	.Process(pyrusClient);

var tasks = formRegisterResponse.Tasks;

Tasks

• Get task with all comments

var taskId = 15353;
var taskResponse = await RequestBuilder.GetTask(taskId).Process(pyrusClient);;
var task = taskResponse.Task;

• Add task comment

var taskId = 15353;
var taskResponse = await RequestBuilder
	.CommentFormTask(taskId)
	.Approve()
	.FieldUpdates.Add(
		FormField.Create<FormFieldTable>(1)
		.AddRow(15, new List<FormField>
			{
				FormField.Create<FormFieldText>("Comment").WithValue("Thhats's right")
			}))
	.Process(pyrusClient);

• Create a task

var taskResponse = await RequestBuilder
	.CreateSimpleTask("Help me")
	.AddParticipant("[email protected]")
	.AddParticipant(1646)
	.WithDueDate(DateTime.Today.AddDays(2))
	.Process(pyrusClient);

Files

• Upload a file

var fileName = @"C:\path\to\file";
var fileResponse = await RequestBuilder.UploadFile(fileName).Process(pyrusClient);
var fileId = fileResponse.Guid;

Catalogs

• Get catalog with all items

var catalogId = 1525;
var catalogResponse = await RequestBuilder.GetCatalog(catalogId).Process(pyrusClient);
var items = catalogResponse.Items;

• Get catalog with filtered items

var catalogId = 1525;
var catalogResponse = await RequestBuilder.GetCatalogWithItems(catalogId)
    .AddValueFilter("Column", "Value")
    .Process(pyrusClient);
var items = catalogResponse.Items;

• Create catalog

var catalogResponse = await RequestBuilder
	.CreateCatalog("NewCatalog")
	.SetHeaders("Header1", "Header2")
	.AddItem("A1", "A2")
	.AddItem("B1", "B2")
	.Process(pyrusClient);
	
var catalogId = catalogResponse.CatalogId;

• Sync catalog (All unspecified catalog items and text columns will be deleted)

var catalogId = 1236;
var updateCatalogResponse = await RequestBuilder
	.SyncCatalog(catalogId)
	.SetHeaders("Header1", "Header3")
	.AddItem("A1", "A3")
	.AddItem("C1", "C2")
	.ApplyChanges()
	.Process(pyrusClient);

• Change catalog items

var catalogId = 1236;
var updateCatalogItemsResponse = await RequestBuilder
    .UpdateCatalogItems(catalogId)
    .UpsertItem("3", "gamma")
    .DeleteItem("2")
    .Process(pyrusClient);

Contacts

• Get all available contacts

var contactsResponse = await RequestBuilder.GetContacts().Process(pyrusClient);

Lists

• Get list

var listId = 1322;
var listResponse = await RequestBuilder.GetList(listId).Process(pyrusClient);

• Get all lists

var listsResponse = await RequestBuilder.GetLists().Process(pyrusClient);

• Get all tasks in list

var listId = 1322;
var taskListResponse = await RequestBuilder.GetTaskList(listId, maxItemCount: 25, includeArchived:true).Process(pyrusClient);

Roles

• Get all organization roles

var rolesResponse = await RequestBuilder.GetRoles().Process(pyrusClient);

• Create role

var roleResponse = await RequestBuilder.CreateRole("TechSupport")
    .AddMembers(1732, 4368)
    .Process(pyrusClient);

• Update role

var roleResponse = await RequestBuilder.UpdateRole(6476)
    .AddMember(2434)
    .RemoveMembers(1732, 4368)
    .SetExternalId("CustomIdentifier")
    .Process(pyrusClient);

Profile

• Get profile

var profileResponse = await RequestBuilder.GetProfile().Process(pyrusClient);

Inbox

• Get inbox

var inboxResponse = await RequestBuilder.GetInbox(10, 5).Process(pyrusClient);

Announcements

• Get announcement with all comments

var announcementResponse = await RequestBuilder.GetAnnouncement(15353).Process(pyrusClient);
var announcement = announcementResponse.Announcement;

• Get announcements with all comments

var announcementsResponse = await RequestBuilder.GetAnnouncements().Process(pyrusClient);
var announcements = announcementsResponse.Announcements;

• Add announcement comment

var announcementResponse = await RequestBuilder
	.CommentAnnouncement(15353)
	.WithText("SomeText")
	.Process(pyrusClient);

• Create an announcement

var announcementResponse = await RequestBuilder
	.CreateAnnouncement("New announcement")
	.Process(pyrusClient);