Request :: type property

[jecoute]

In the API, type is set as an enumeration, but the Zendesk API has this property as a String field.

[mozts2005]

Yes, the enum is used to limit the options to a fixed list the converter uses the names not the values.

Do we need to add an option to the enum?

[jecoute]

Hmm... I found when i used the enum, I didn't get a value in the request for it after it was created.

[mozts2005]

We have a number of tests that confirm this functionality. Can you please create a PR with a test that replicates your issue?

ZendeskApi_v2/tests/ZendeskApi_v2.Tests/RequestTests.cs

Line 178 in 909b7bb

Assert.That(res.Request.Type, Is.EqualTo(RequestType.Incident));

[jecoute]

I'm not sure what's happening, but for some reason I wasn't able to make any PR. Attached you can see the screenshots where we use your zendesk client. From the first screenshot, UnitTest1, I've set the Type to 'task'. The second one, UnitTest2,shows the response received and the Type is defaulted to 'incident'.

I think it probably should be an enum where we can at cast the enum with ToString() to get the string literal of the enum to set the desired type which the API is showing, see UnitTest 4.

[mozts2005]

Based on what I am reading you are using your own instance of the Newtonsoft seriallizer and not the one configured by the library.

try the following in a NUnit test class. Please make sure you are using version 3.12.0.

        [Test]
        public void CanCreateRequests()
        {

            var api = new ZendeskApi(Organization.SiteURL, Admin.Email, Admin.Password);
            var req = new Request
            {
                Subject = "end user request test",
                Type = RequestType.Task,
                Comment = new Comment
                { Body = "end user test", HtmlBody = "end user test with </br> new line", Public = true },
                Requester = new Requester
                {
                    Name = "Test Name"
                },
                Tags = new List<string> { "tag1", "tag2" }
            };

            var res = api.Requests.CreateRequest(req);

                Assert.That(res, Is.Not.Null);
                Assert.That(res.Request, Is.Not.Null);
                Assert.That(res.Request.Id.HasValue, Is.True);
                Assert.That(res.Request.Type, Is.EqualTo(RequestType.Task));
        }

ZendeskApi_v2/src/ZendeskApi_v2/Models/Requests/Request.cs

Lines 36 to 38 in 7b9aa5a

	[JsonConverter(typeof(StringEnumConverter))]
	[JsonProperty("type")]
	public RequestType? Type { get; set; }

As you can see, we are using the StringEnumConverter to make Newtonsoft seriallizer output a string.

We would be happy to fix an issue once we have a reproducible failing test case. Given that only a fix set of strings allowed, it is incorrect to allow a generic string to be the property type.