Sdk4me.GraphQL 1.2.0

About

A .NET client for accessing the 4me GraphQL API.

Documentation

More information and documentation can be found on the 4me developer website and on the code4me GitHub repository.

The data entities in the SDK are modeled after the 4me Quality Assurance GraphQL schema, which may include objects or properties that are not yet available in production.

How to use

Minimal example

using Sdk4me.GraphQL;

AuthenticationToken token = new AuthenticationToken("clientID", "clientSecret");
Sdk4meClient client = new(token, "account-name", EnvironmentType.Production, EnvironmentRegion.EU);
Person me = client.Me().Result;
Console.WriteLine($"{me.Name} ({me.PrimaryEmail})");

Querying

PersonQuery query = new PersonQuery()
    .View(PersonView.All)
    .OrderBy(PersonOrderField.Vip, OrderBySortOrder.Descending)
    .Filter(PersonField.CreatedAt, FilterOperator.GreaterThanOrEqualsTo, new DateTime(2020, 1, 1))
    .SelectContacts(new ContactQuery()
        .Select("*"))
    .SelectPermissions(new PermissionQuery()
        .ItemsPerRequest(10)
        .Select(PermissionField.Account, PermissionField.Roles))
    .SelectTeams(new TeamQuery()
        .ItemsPerRequest(10)
        .SelectMembers(new PersonQuery()
            .ItemsPerRequest(50)
            .Select(PersonField.Name)))
    .SelectConfigurationItems(new ConfigurationItemQuery()
        .Select(ConfigurationItemField.Label)
        .ItemsPerRequest(10)
        .SelectRequests(new RequestQuery()
            .ItemsPerRequest(10)
            .Select(RequestField.Subject, RequestField.Supplier)));

DataList<Person> people = client.Get(query).Result;

Mutations

PersonCreatePayload result = await client.Mutation(new PersonCreateInput
{
    Name = "James",
    PrimaryEmail = "James@MyCompany.com",
    Disabled = true,
    EmployeeID = "123",
    TeamIds = new() { "NG1lLnFhL1RlYW0vMjA1MTQ", "NG1lLnFhL1RlYW0vMjA1MGv" },
    Source = "Sdk4me",
    TimeFormat24h = true,
    TimeZone = "Brussels",
    DoNotTranslateLanguages = new() { "en", "nl" }
},
new PersonQuery()
    .Select(PersonField.ID, PersonField.Account),  false);

PersonUpdatePayload result = await client.Mutation(new PersonUpdateInput
{
    ID = "NG1qLfFhL1blcnNvci8ysjMxSjIx",
    PrimaryEmail = "James_Updated@MyCompany.com",
},
new PersonQuery()
    .Select(PersonField.ID, PersonField.PrimaryEmail), true);

Events

RequestEventCreateInput requestCreate = new RequestEventCreateInput()
    .Category(RequestCategory.Incident)
    .Note("The first note")
    .Subject("Sdk4me.GraphQL Test")
    .Source("Sdk4me.GraphQL")
    .SourceID("1")
    .ServiceInstance(416)
    .Impact(RequestImpact.Medium)
    .ConfigurationItem(1998)
    .Team(12);

Request request = await client.CreateEvent(requestCreate);

Related Packages

• Newtonsoft.Json

Feedback

Sdk4me.GraphQL is released as open source under the MIT license. Bug reports are welcome at the GitHub repository.