Response

This page documents the Response model.

Data Shape

Gadget's database stores Response records by storing and retrieving each of the fields defined on the model in the Gadget Editor to a managed database. Gadget has generated a GraphQL type matching the configured fields for Response:

Response Schema
1export interface Response {
2 __typename: "Response";
3
4 /** The globally unique, unchanging identifier for this record. Assigned and managed by Gadget. */
5 id: Scalars["GadgetID"];
6
7 /** The time at which this record was first created. Set once upon record creation and never changed. Managed by Gadget. */
8 createdAt: Scalars["DateTime"];
9
10 /** The time at which this record was last changed. Set each time the record is successfully acted upon by an action. Managed by Gadget. */
11 updatedAt: Scalars["DateTime"];
12
13 /** The current state this record is in. Changed by invoking actions. Managed by Gadget. */
14 state: Scalars["RecordState"];
15
16 result: Result | null;
17
18 resultId: Scalars["GadgetID"] | null;
19
20 quiz: Quiz | null;
21
22 quizId: Scalars["GadgetID"] | null;
23
24 conversionState: Scalars["String"];
25
26 email: Scalars["EmailAddress"] | null;
27
28 answers: AnswerConnection;
29
30 /** Get all the fields for this record. Useful for not having to list out all the fields you want to retrieve, but slower. */
31 _all: Scalars["JSONObject"];
32}
1type Response {
2 """
3 The globally unique, unchanging identifier for this record. Assigned and managed by Gadget.
4 """
5 id: GadgetID!
6
7 """
8 The time at which this record was first created. Set once upon record creation and never changed. Managed by Gadget.
9 """
10 createdAt: DateTime!
11
12 """
13 The time at which this record was last changed. Set each time the record is successfully acted upon by an action. Managed by Gadget.
14 """
15 updatedAt: DateTime!
16
17 """
18 The current state this record is in. Changed by invoking actions. Managed by Gadget.
19 """
20 state: RecordState!
21 result: Result
22 resultId: GadgetID
23 quiz: Quiz
24 quizId: GadgetID
25 conversionState: String!
26 email: EmailAddress
27 answers(
28 """
29 Returns the items in the list that come after the specified cursor.
30 """
31 after: String
32
33 """
34 Returns the first n items from the list.
35 """
36 first: Int
37
38 """
39 Returns the items in the list that come before the specified cursor.
40 """
41 before: String
42
43 """
44 Returns the last n items from the list.
45 """
46 last: Int
47
48 """
49 A list of sort orders to return the results in
50 """
51 sort: [AnswerSort!]
52
53 """
54 A list of filters to refine the results by
55 """
56 filter: [AnswerFilter!]
57
58 """
59 A free form text search query to find records matching
60 """
61 search: String
62 ): AnswerConnection!
63
64 """
65 Get all the fields for this record. Useful for not having to list out all the fields you want to retrieve, but slower.
66 """
67 _all: JSONObject!
68}

You can preview what a real record's shape looks like by fetching it using the alida-quiz-app-2 API Playground.

Any fetched Response record will have this same Response type, and expose the same data by default, regardless of if it's fetched by ID or as part of a findMany. This means you can select any of the record's fields wherever you like in a GraphQL query according to the use case at hand.

Retrieving one Response record

Individual Response records can be retrieved using the "find by ID" API endpoint. You can also return only some fields, or extra fields beyond what Gadget retrieves by default, using the select option.

The findOne function throws an error if no matching record is found, which you will need to catch and handle. Alternatively, you can use the maybeFindOne function, which returns null if no record is found, without throwing an error.

Similarly, the useFindOne React hook returns (but does not throw) an error when no matching record is found, while the useMaybeFindOne hook simply returns null if no record is found, without also returning an error.

Get one Response
const responseRecord = await api.response.findOne("some-id");
console.log(responseRecord.id); //=> a string
console.log(responseRecord.createdAt); //=> a Date object
const [result, refresh] = useFindOne(api.response, "some-id");
const { data, error, fetching } = result;
console.log(data?.id); //=> a string
console.log(data?.createdAt); //=> a Date object
1query GetOneResponse($id: GadgetID!) {
2 response(id: $id) {
3 __typename
4 id
5 state
6 answers {
7 edges {
8 node {
9 id
10 state
11 createdAt
12 question {
13 id
14 state
15 body
16 createdAt
17 imageUrl
18 required
19 sequence
20 title
21 updatedAt
22 }
23 response {
24 id
25 state
26 conversionState
27 createdAt
28 email
29 updatedAt
30 }
31 result {
32 id
33 state
34 body
35 createdAt
36 imageUrl
37 updatedAt
38 }
39 sequence
40 text
41 updatedAt
42 }
43 }
44 }
45 conversionState
46 createdAt
47 email
48 quiz {
49 id
50 state
51 body
52 createdAt
53 title
54 updatedAt
55 }
56 result {
57 id
58 state
59 body
60 createdAt
61 imageUrl
62 productSuggestion {
63 id
64 state
65 barcode
66 compareAtPrice
67 createdAt
68 fulfillmentService
69 grams
70 inventoryManagement
71 inventoryPolicy
72 inventoryQuantity
73 inventoryQuantityAdjustment
74 oldInventoryQuantity
75 option1
76 option2
77 option3
78 position
79 presentmentPrices
80 price
81 requiresShipping
82 shopifyCreatedAt
83 shopifyUpdatedAt
84 sku
85 taxCode
86 taxable
87 title
88 updatedAt
89 weight
90 weightUnit
91 }
92 quiz {
93 id
94 state
95 body
96 createdAt
97 title
98 updatedAt
99 }
100 updatedAt
101 }
102 updatedAt
103 }
104}
Variables
json
{
"id": "some-id"
}

Retrieving the first of many Response records

The first record from a list of records can be retrieved using the "find first" API endpoint. The source list of records can be filtered using the filter option, sorted using the sort option, searched using the search option, though no pagination options are available on this endpoint. You can also return only some fields, or extra fields beyond what Gadget retrieves by default using the select option.

The findFirst function throws an error if no matching record is found, which you will need to catch and handle. Alternatively, you can use the maybeFindFirst function, which returns null if no record is found, without throwing an error.

Similarly, the useFindFirst React hook returns (but does not throw) an error when no matching record is found, while the useMaybeFindFirst hook simply returns null if no record is found, without also returning an error.

Get one Response
const responseRecord = await api.response.findFirst();
console.log(responseRecord.id); //=> a string
console.log(responseRecord.createdAt); //=> a Date object
const [result, refresh] = useFindFirst(api.response);
const { data, error, fetching } = result;
console.log(data?.id); //=> a string
console.log(data?.createdAt); //=> a Date object
1query FindManyResponses(
2 $first: Int
3 $search: String
4 $sort: [ResponseSort!]
5 $filter: [ResponseFilter!]
6) {
7 responses(first: $first, search: $search, sort: $sort, filter: $filter) {
8 edges {
9 node {
10 __typename
11 id
12 state
13 answers {
14 edges {
15 node {
16 id
17 state
18 createdAt
19 question {
20 id
21 state
22 body
23 createdAt
24 imageUrl
25 required
26 sequence
27 title
28 updatedAt
29 }
30 response {
31 id
32 state
33 conversionState
34 createdAt
35 email
36 updatedAt
37 }
38 result {
39 id
40 state
41 body
42 createdAt
43 imageUrl
44 updatedAt
45 }
46 sequence
47 text
48 updatedAt
49 }
50 }
51 }
52 conversionState
53 createdAt
54 email
55 quiz {
56 id
57 state
58 body
59 createdAt
60 title
61 updatedAt
62 }
63 result {
64 id
65 state
66 body
67 createdAt
68 imageUrl
69 productSuggestion {
70 id
71 state
72 barcode
73 compareAtPrice
74 createdAt
75 fulfillmentService
76 grams
77 inventoryManagement
78 inventoryPolicy
79 inventoryQuantity
80 inventoryQuantityAdjustment
81 oldInventoryQuantity
82 option1
83 option2
84 option3
85 position
86 presentmentPrices
87 price
88 requiresShipping
89 shopifyCreatedAt
90 shopifyUpdatedAt
91 sku
92 taxCode
93 taxable
94 title
95 updatedAt
96 weight
97 weightUnit
98 }
99 quiz {
100 id
101 state
102 body
103 createdAt
104 title
105 updatedAt
106 }
107 updatedAt
108 }
109 updatedAt
110 }
111 }
112 }
113}
Variables
json
{
"first": 1
}

Retrieving many Response records

Pages of Response records can be retrieved by using the "find many" API endpoint. The returned records can be filtered using the filter option, sorted using the sort option, searched using the search option, and paginated using standard Relay-style pagination options. You can also return only some fields, or extra fields beyond what Gadget retrieves by default using the select option.

This GraphQL endpoint returns records in the Relay Connection style (as a list of edges with nodes and cursors) so they can be paginated. The responses GraphQL endpoint works with any Relay-compatible caching client, or you can use Gadget's JS client for pagination with the findMany function.

Find a page of Responses

Fetch a page of records with the response.findMany JS method or the responses GraphQL field. No options are required. The records returned will be implicitly sorted by ID ascending.

Find many Responses
const responseRecords = await api.response.findMany();
console.log(responseRecords.length); //=> a number
console.log(responseRecords[0].id); //=> a string
const [result, refresh] = useFindMany(api.response);
const { data, error, fetching } = result;
console.log(data?.length); //=> a number
console.log(data?.[0].length); //=> a string
1query FindManyResponses {
2 responses {
3 edges {
4 node {
5 __typename
6 id
7 state
8 # ...
9 createdAt
10 updatedAt
11 }
12 }
13 }
14}
Variables
json
{}

Retrieving a single Response record by a uniquely identifiable field

After adding a unique validation to a field, you can retrieve a single record by using the finders generated below. If you would like to edit the fields returned or filtering, see the filtering section.

Retrieving a single Response record by ID

Individual Response records can be retrieved using the "find many" API endpoint pre-filtered by the field's ID. Throws if stored data is not unique.

Find Responses
const responseRecord = await api.response.findById("some-value");
console.log(responseRecord.id); //=> a string
const [result, refresh] = useFindBy(api.response.findById, "some-value");
const { data, error, fetching } = result;
console.log(data?.id); //=> a string

Sorting

Records can be sorted in the database to retrieve them in a certain order. Records are always implicitly sorted by ID ascending unless an explicit sort on the id field is defined. The GraphQL type ResponseSort defines which fields can be sorted by.

Records can be sorted by multiple different fields and in multiple different directions by passing a list of ResponseSort instead of just one.

GraphQL
1input ResponseSort {
2 id: SortOrder
3 createdAt: SortOrder
4 updatedAt: SortOrder
5 state: SortOrder
6 conversionState: SortOrder
7 email: SortOrder
8}

Pass the sort option to the JS client, or the sort variable to a GraphQL query to sort the records returned.

Sort Response by most recently created
const responseRecords = await api.response.findMany({
sort: { createdAt: "Descending" },
});
const [result, refresh] = useFindMany(api.response, {
sort: { createdAt: "Descending" },
});
const { data, error, fetching } = result;
1query FindManyResponses($sort: [ResponseSort!]) {
2 responses(sort: $sort) {
3 edges {
4 node {
5 __typename
6 id
7 state
8 # ...
9 createdAt
10 updatedAt
11 }
12 }
13 }
14}
Variables
json
{
"sort": {
"createdAt": "Descending"
}
}

Sort by multiple fields by passing an array of { [field]: "Ascending" | "Descending" } objects.

Sort Response by multiple fields
const responseRecords = await api.response.findMany({
sort: [{ state: "Descending" }, { createdAt: "Ascending" }],
});
const [result, refresh] = useFindMany(api.response, {
sort: [{ state: "Descending" }, { createdAt: "Ascending" }],
});
const { data, error, fetching } = result;
1query FindManyResponses($sort: [ResponseSort!]) {
2 responses(sort: $sort) {
3 edges {
4 node {
5 __typename
6 id
7 state
8 # ...
9 createdAt
10 updatedAt
11 }
12 }
13 }
14}
Variables
json
1{
2 "sort": [
3 {
4 "state": "Descending"
5 },
6 {
7 "createdAt": "Ascending"
8 }
9 ]
10}

All primitive field types in Gadget are sortable so you are able to sort by fields you have added to a model as well.

Sort Responses by ID descending
const responseRecords = await api.response.findMany({
sort: { id: "Descending" },
});
const [result, refresh] = useFindMany(api.response, {
sort: { id: "Descending" },
});
const { data, error, fetching } = result;
1query FindManyResponses($sort: [ResponseSort!]) {
2 responses(sort: $sort) {
3 edges {
4 node {
5 __typename
6 id
7 state
8 # ...
9 createdAt
10 updatedAt
11 }
12 }
13 }
14}
Variables
json
{
"sort": {
"id": "Descending"
}
}

Searching

Response records can be searched using Gadget's built in full text search functionality. Gadget search is appropriate for powering autocompletes, searchable tables, or other experiences where humans are writing search queries. It's typo tolerant, synonym aware and supports simple search operators like ! to exclude search terms.

Search Responses by passing the search parameter with a search query string.

Search isn't field specific in Gadget -- all String or RichText field types are searched with the built in search functionality.

Full text search Responses
const responseRecords = await api.response.findMany({
search: "a specific phrase to search for",
});
const [result, refresh] = useFindMany(api.response, {
search: "a specific phrase to search for",
});
const { data, error, fetching } = result;
1query FindManyResponses($search: String) {
2 responses(search: $search) {
3 edges {
4 node {
5 __typename
6 id
7 state
8 # ...
9 createdAt
10 updatedAt
11 }
12 }
13 }
14}
Variables
json
{
"search": "a specific phrase to search for"
}

Filtering

Response records can be filtered to return only the appropriate records. Records can be filtered on any field, including those managed by Gadget or fields added by developers. Filters can be combined with sorts, searches and paginated using cursor based Relay pagination.

Filter Responses by passing the filter parameter with a filter object. Filter objects are nestable boolean conditions expressed as JS objects capturing a key, an operator, and usually a value.

The GraphQL type ResponseFilter defines which fields can be filtered on.

Records can be filtered by multiple different fields. If you want to combine filters using boolean logic, nest them under the AND, OR, or NOT keys of a parent filter. Filters can be nested deeply by passing multiple levels boolean condition filters.

You can also pass a list of filters to the filter parameter which will be implicitly ANDed with one another such that they all need to match for a record to be returned.

Available filters
GraphQL
1input ResponseFilter {
2 AND: [ResponseFilter]
3 OR: [ResponseFilter]
4 NOT: [ResponseFilter]
5 id: IDFilter
6 createdAt: DateTimeFilter
7 updatedAt: DateTimeFilter
8 state: StateFilter
9 result: IDFilter
10 quiz: IDFilter
11 conversionState: StringFilter
12 email: StringFilter
13}
Find Responses created in the last day
const yesterday = new Date(Date.now() - 864e5);
const responseRecords = await api.response.findMany({
filter: { createdAt: { greaterThan: yesterday } },
});
const yesterday = new Date(Date.now() - 864e5);
const [result, refresh] = useFindMany(api.response, {
filter: { createdAt: { greaterThan: yesterday } },
});
const { data, error, fetching } = result;
1query FindManyResponses($filter: [ResponseFilter!]) {
2 responses(filter: $filter) {
3 edges {
4 node {
5 __typename
6 id
7 state
8 # ...
9 createdAt
10 updatedAt
11 }
12 }
13 }
14}
Variables
json
1{
2 "filter": {
3 "createdAt": {
4 "greaterThan": "2022-10-03T05:49:14.730Z"
5 }
6 }
7}
Responses created this week or updated today
1const yesterday = new Date(Date.now() - 86400000);
2const oneWeekAgo = new Date(Date.now() - 604800000);
3const responseRecords = await api.response.findMany({
4 filter: {
5 OR: [
6 {
7 createdAt: { greaterThan: oneWeekAgo },
8 },
9 {
10 updated: { greaterThan: yesterday },
11 },
12 ],
13 },
14});
1const yesterday = new Date(Date.now() - 86400000);
2const oneWeekAgo = new Date(Date.now() - 604800000);
3const [result, refresh] = useFindMany(api.response, {
4 filter: {
5 OR: [
6 {
7 createdAt: { greaterThan: oneWeekAgo },
8 },
9 {
10 updated: { greaterThan: yesterday },
11 },
12 ],
13 },
14});
15const { data, error, fetching } = result;
1query FindManyResponses($filter: [ResponseFilter!]) {
2 responses(filter: $filter) {
3 edges {
4 node {
5 __typename
6 id
7 state
8 # ...
9 createdAt
10 updatedAt
11 }
12 }
13 }
14}
Variables
json
1{
2 "filter": {
3 "OR": [
4 {
5 "createdAt": {
6 "greaterThan": "2022-09-27T05:49:14.730Z"
7 }
8 },
9 {
10 "updated": {
11 "greaterThan": "2022-10-03T05:49:14.730Z"
12 }
13 }
14 ]
15 }
16}
Filter records that are in the created state
const responseRecords = await api.response.findMany({
filter: {
state: { inState: "created" },
},
});
1const [result, refresh] = useFindMany(api.response, {
2 filter: {
3 state: { inState: "created" },
4 },
5});
6const { data, error, fetching } = result;
1query FindManyResponses($filter: [ResponseFilter!]) {
2 responses(filter: $filter) {
3 edges {
4 node {
5 __typename
6 id
7 state
8 # ...
9 createdAt
10 updatedAt
11 }
12 }
13 }
14}
Variables
json
1{
2 "filter": {
3 "state": {
4 "inState": "created"
5 }
6 }
7}

Most field types in Gadget are filterable, so you are able to filter by fields you have added to a model as well.

const responseRecords = await api.response.findMany({
filter: {
id: { isSet: true },
},
});
1const [result, refresh] = useFindMany(api.response, {
2 filter: {
3 id: { isSet: true },
4 },
5});
6const { data, error, fetching } = result;
1query FindManyResponses($filter: [ResponseFilter!]) {
2 responses(filter: $filter) {
3 edges {
4 node {
5 __typename
6 id
7 state
8 # ...
9 createdAt
10 updatedAt
11 }
12 }
13 }
14}
Variables
json
1{
2 "filter": {
3 "id": {
4 "isSet": true
5 }
6 }
7}

Pagination

All Gadget record lists, including the top level Response finder as well as associations to Response, are structured as GraphQL connections. GraphQL connections are the defacto standard for querying lists and support cursor based forward and backward pagination. When querying via GraphQL, you must select the edges field and then the node field to get the Response record. When querying using a Gadget API client, the GraphQL queries are generated for you and the records are unwrapped and returned as a GadgetRecordList ready for use.

Response pagination supports the standard GraphQL connection pagination arguments: first + after, or last + before. Pagination is done using cursors, which you can retrieve from the edge.cursor field or the pageInfo.startCursor properties.

Get the first page of 25 Responses
const responseRecords = await api.response.findMany({ first: 25 });
console.log(responseRecords.length); //=> no greater than 25
const [result, refresh] = useFindMany(api.response, { first: 25 });
const { data, error, fetching } = result;
console.log(data?.length); //=> no greater than 25
1query FindManyResponses($first: Int, $after: String) {
2 responses(first: $first, after: $after) {
3 edges {
4 cursor
5 node {
6 __typename
7 id
8 state
9 # ...
10 createdAt
11 updatedAt
12 }
13 }
14 pageInfo {
15 endCursor
16 hasNextPage
17 hasPreviousPage
18 startCursor
19 }
20 }
21}
Variables
json
{
"first": 25
}

The after cursor used in this example data won't return any records if used in a real API request.

Next 25 Response records after cursor
const responseRecords = await api.response.findMany({ after: "abcdefg", first: 25 });
const [result, refresh] = useFindMany(api.response, { after: "abcdefg", first: 25 });
const { data, error, fetching } = result;
1query FindManyResponses($first: Int, $after: String) {
2 responses(first: $first, after: $after) {
3 edges {
4 cursor
5 node {
6 __typename
7 id
8 state
9 # ...
10 createdAt
11 updatedAt
12 }
13 }
14 pageInfo {
15 endCursor
16 hasNextPage
17 hasPreviousPage
18 startCursor
19 }
20 }
21}
Variables
json
{
"first": 25,
"after": "abcdefg"
}

Pagination Limits

Root level record finders like responses support a maximum page size of 250 records, and a default page size of 50 records. The page size is controlled using the first or last GraphQL field arguments.

Related record finders that access lists of records through a HasMany or HasManyThrough field support a maximum page size of 100 records, and a default page size of 50 records.

Get the next or previous page

When using the generated JavaScript API client, the record lists returned from find many calls can be paginated using the nextPage() or previousPage() option.

Both nextPage() and previousPage() will throw an error if the corresponding hasNextPage or hasPreviousPage is false.

JavaScript
1const responseRecords =
2 await api.response.findMany();
3if (responseRecords.hasNextPage) {
4 const nextPage =
5 await responseRecords.nextPage();
6}
7if (responseRecords.hasPreviousPage) {
8 const prevPage =
9 await responseRecords.previousPage();
10}

Selecting fields, and fields of fields

When using the JavaScript client, all of findOne, maybeFindOne, findMany, findFirst, maybeFindFirst, and various action functions, allow requesting specific fields of a Response and its relationships. The select option controls which fields are selected in the generated GraphQL query sent to the Gadget API. Pass each field you want to select in an object, with true as the value for scalar fields, and a nested object of the same shape for nested fields.

Gadget has a default selection that will retrieve all of the scalar fields for a Response, as well as concise representations of each of the relationships containing an id and an automatically inferred title field. If you don't pass a select option to a record finder, this default selection will be used.

Select only some Response fields
// fetch only the id, state, and createdAt field
const responseRecords = await api.response.findMany({
select: { id: true, state: true, createdAt: true },
});
// fetch only the id, state, and createdAt field
const [result, refresh] = useFindMany(api.response, {
select: { id: true, state: true, createdAt: true },
});
const { data, error, fetching } = result;
Type Safety

The select option is fully type safe if you're using TypeScript. The returned GadgetRecord type will have a <Shape> exactly matching the fields and nested fields you selected. For more information, see Type Safety .

This behavior of selecting only some fields is built right into GraphQL. If you want to limit or expand what you retrieve from a GraphQL query, include or exclude those fields in your GraphQL query. For more information on executing GraphQL queries, see GraphQL.

Select nested Response fields
1// fetch the id, state, and createdAt field, and fetch some nested fields from an example relationship field named `someRelatedObject`
2const responseRecords = await api.response.findMany({
3 select: {
4 id: true,
5 state: true,
6 createdAt: true,
7 someRelatedObject: { id: true, createdAt: true },
8 },
9});
1// fetch the id, state, and createdAt field, and fetch some nested fields from an example relationship field named `someRelatedObject`
2const [result, refresh] = useFindMany(api.response, {
3 select: {
4 id: true,
5 state: true,
6 createdAt: true,
7 someRelatedObject: { id: true, createdAt: true },
8 },
9});
10const { data, error, fetching } = result;

Combining parameters

Sort, search, filtering, selection, and pagination parameters can be combined to access the exact set of records needed for your use case.

Combining Parameters
1const responseRecords = await api.response.findMany({
2 search: "<some search query>",
3 sort: { createdAt: "Descending" },
4 filter: { updatedAt: { greaterThan: new Date(Date.now() - 864e5) } },
5 select: { id: true, createdAt: true },
6 first: 25,
7 after: "abcdefg",
8});
1const [result, refresh] = useFindMany(api.response, {
2 search: "<some search query>",
3 sort: { createdAt: "Descending" },
4 filter: { updatedAt: { greaterThan: new Date(Date.now() - 864e5) } },
5 select: { id: true, createdAt: true },
6 first: 25,
7 after: "abcdefg",
8});
9const { data, error, fetching } = result;
1query FindManyResponses(
2 $after: String
3 $before: String
4 $first: Int
5 $last: Int
6 $search: String
7 $sort: [ResponseSort!]
8 $filter: [ResponseFilter!]
9) {
10 responses(
11 after: $after
12 before: $before
13 first: $first
14 last: $last
15 search: $search
16 sort: $sort
17 filter: $filter
18 ) {
19 edges {
20 cursor
21 node {
22 __typename
23 id
24 state
25 answers {
26 edges {
27 node {
28 id
29 state
30 createdAt
31 question {
32 id
33 state
34 body
35 createdAt
36 imageUrl
37 required
38 sequence
39 title
40 updatedAt
41 }
42 response {
43 id
44 state
45 conversionState
46 createdAt
47 email
48 updatedAt
49 }
50 result {
51 id
52 state
53 body
54 createdAt
55 imageUrl
56 updatedAt
57 }
58 sequence
59 text
60 updatedAt
61 }
62 }
63 }
64 conversionState
65 createdAt
66 email
67 quiz {
68 id
69 state
70 body
71 createdAt
72 title
73 updatedAt
74 }
75 result {
76 id
77 state
78 body
79 createdAt
80 imageUrl
81 productSuggestion {
82 id
83 state
84 barcode
85 compareAtPrice
86 createdAt
87 fulfillmentService
88 grams
89 inventoryManagement
90 inventoryPolicy
91 inventoryQuantity
92 inventoryQuantityAdjustment
93 oldInventoryQuantity
94 option1
95 option2
96 option3
97 position
98 presentmentPrices
99 price
100 requiresShipping
101 shopifyCreatedAt
102 shopifyUpdatedAt
103 sku
104 taxCode
105 taxable
106 title
107 updatedAt
108 weight
109 weightUnit
110 }
111 quiz {
112 id
113 state
114 body
115 createdAt
116 title
117 updatedAt
118 }
119 updatedAt
120 }
121 updatedAt
122 }
123 }
124 pageInfo {
125 endCursor
126 hasNextPage
127 hasPreviousPage
128 startCursor
129 }
130 }
131}
Variables
json
1{
2 "search": "<some search query>",
3 "sort": {
4 "createdAt": "Descending"
5 },
6 "filter": {
7 "updatedAt": {
8 "greaterThan": "2022-10-03T05:49:14.871Z"
9 }
10 },
11 "first": 25,
12 "after": "abcdefg"
13}

Invoking Actions

Response records are changed by invoking Actions. Actions are the things that "do" stuff -- update records, make API calls, call backend code, etc. Actions each have one corresponding GraphQL mutation and a corresponding function available in the API client libraries. Nested Actions can also be invoked with the API client, by providing the actions as input to any relationship fields.

Action Result format

Each API action returns results in the same format that includes a success indicator, errors, and the actual result if the action succeeded. The result is the record that was acted on for a model action, or a list of records for a bulk action, or a JSON blob for Global Actions. Model actions that delete the record don't return the record.

The success field returns a boolean indicating if the action executed as expected. Any execution errors are returned in the errors object, which will always be null if success is true or contain ExecutionError objects if success is false.

ExecutionError objects always have a message describing what error prevented the action from succeeding, as well as a code attribute that gives a stable, searchable, human readable error class code for referencing this specific error. Details on each error code can be found in the Errors documentation. All ExecutionError object types returned by the GraphQL object can be one of many types of error, where some types have extra data that is useful for remedying the error. All error types will always have message and code properties, but some, like InvalidRecordError have extra fields for use by clients.

Errors when using the generated client

The generated JavaScript client automatically interprets errors from invoking actions and throws JavaScript Error instances if the action didn't succeed. The Error objects it throws are rich, and expose extra error properties beyond just message and code if they exist.

Errors thrown by the JavaScript client are easiest to catch by using a try/catch statement around an await, like so:

JavaScript
1import {
2 GadgetOperationError,
3 InvalidRecordError,
4} from "@gadget-client/example-app";
5
6// must be in an async function to use `await` syntax
7const runAction = async () => {
8 try {
9 return await api.exampleModel.create(
10 {
11 exampleModel: {
12 name: "example record name",
13 },
14 }
15 );
16 } catch (error) {
17 if (
18 error instanceof
19 GadgetOperationError
20 ) {
21 // a recognized general error has occurred, retry the operation or inspect error.code`
22 console.error(error);
23 } else if (
24 error instanceof
25 InvalidRecordError
26 ) {
27 // the submitted input data for the action was invalid, inspect the invalid fields which `InvalidRecordError` exposes
28 console.error(
29 error.validationErrors
30 );
31 } else {
32 // an unrecognized error occurred, like an HTTP connection interrupted error or a syntax error. Re-throw it because it's not clear what to do to fix ti
33 throw error;
34 }
35 }
36};

For more information on error codes, consult the Errors documentation.

Response Delete

The Delete action destroys the record.

Input

Delete operates on one Response in particular, identified by the id variable.

Example Delete Invocation
await api.response.delete("some-id");
const [result, deleteResponse] = useAction(api.response.delete);
const { data, error, fetching } = result;
await deleteResponse({
id: "some-id",
});
1mutation ($id: GadgetID!) {
2 deleteResponse(id: $id) {
3 success
4 errors {
5 message
6 ... on InvalidRecordError {
7 validationErrors {
8 apiIdentifier
9 message
10 }
11 record
12 model {
13 apiIdentifier
14 }
15 }
16 }
17 }
18}
Variables
json
{
"id": "some-id"
}
Output

Delete deletes the record, so it returns void in the JS client. In GraphQL it returns only the success and errors from the action result format.

Delete Output Data
type DeleteResponseResult {
success: Boolean!
errors: [ExecutionError!]
}

Response Update

The Update action transitions a Response from Created to Created.

Input

Update operates on one Response in particular, identified by the id variable. Update accepts the following input parameters:

Update Input Data
1export interface UpdateResponseInput {
2 result?: ResultBelongsToInput | null;
3
4 quiz?: QuizBelongsToInput | null;
5
6 conversionState?: (Scalars["String"] | null) | null;
7
8 email?: (Scalars["String"] | null) | null;
9
10 answers?: (AnswerHasManyInput | null)[];
11}
12
13export interface UpdateResponseArguments {
14 response?: UpdateResponseInput | null;
15}
1input UpdateResponseInput {
2 result: ResultBelongsToInput
3 quiz: QuizBelongsToInput
4 conversionState: String
5 email: String
6 answers: [AnswerHasManyInput]
7}
8
9input UpdateResponseArguments {
10 response: UpdateResponseInput
11}
Example Update Invocation
1const responseRecord = await api.response.update("some-id", {
2 response: {
3 // field values for Response
4 },
5});
6console.log(responseRecord.id); //=> a string
1const [result, updateResponse] = useAction(api.response.update);
2const { data, error, fetching } = result;
3await updateResponse({
4 id: "some-id",
5 response: {
6 // field values for Response
7 },
8});
9console.log(data?.id); //=> a string
1mutation ($id: GadgetID!, $response: UpdateResponseInput) {
2 updateResponse(id: $id, response: $response) {
3 success
4 errors {
5 message
6 ... on InvalidRecordError {
7 validationErrors {
8 apiIdentifier
9 message
10 }
11 record
12 model {
13 apiIdentifier
14 }
15 }
16 }
17 response {
18 __typename
19 id
20 state
21 answers {
22 edges {
23 node {
24 id
25 state
26 createdAt
27 question {
28 id
29 state
30 body
31 createdAt
32 imageUrl
33 required
34 sequence
35 title
36 updatedAt
37 }
38 response {
39 id
40 state
41 conversionState
42 createdAt
43 email
44 updatedAt
45 }
46 result {
47 id
48 state
49 body
50 createdAt
51 imageUrl
52 updatedAt
53 }
54 sequence
55 text
56 updatedAt
57 }
58 }
59 }
60 conversionState
61 createdAt
62 email
63 quiz {
64 id
65 state
66 body
67 createdAt
68 title
69 updatedAt
70 }
71 result {
72 id
73 state
74 body
75 createdAt
76 imageUrl
77 productSuggestion {
78 id
79 state
80 barcode
81 compareAtPrice
82 createdAt
83 fulfillmentService
84 grams
85 inventoryManagement
86 inventoryPolicy
87 inventoryQuantity
88 inventoryQuantityAdjustment
89 oldInventoryQuantity
90 option1
91 option2
92 option3
93 position
94 presentmentPrices
95 price
96 requiresShipping
97 shopifyCreatedAt
98 shopifyUpdatedAt
99 sku
100 taxCode
101 taxable
102 title
103 updatedAt
104 weight
105 weightUnit
106 }
107 quiz {
108 id
109 state
110 body
111 createdAt
112 title
113 updatedAt
114 }
115 updatedAt
116 }
117 updatedAt
118 }
119 }
120}
Variables
json
{
"id": "some-id",
"response": {}
}
Output

Update returns the Response. In the JS client, the fields returned can be controlled with the select option. In GraphQL, the return format is the action result format, which includes the record if the action was successful. You can include or exclude the fields you need right in the mutation itself.

Update Output Data
type UpdateResponseResult {
success: Boolean!
errors: [ExecutionError!]
response: Response
}

Response Create

The Create action transitions a Response from Start to Created.

Input

Create accepts the following input parameters:

Create Input Data
1export interface CreateResponseInput {
2 result?: ResultBelongsToInput | null;
3
4 quiz?: QuizBelongsToInput | null;
5
6 conversionState?: (Scalars["String"] | null) | null;
7
8 email?: (Scalars["String"] | null) | null;
9
10 answers?: (AnswerHasManyInput | null)[];
11}
12
13export interface CreateResponseArguments {
14 response?: CreateResponseInput | null;
15}
1input CreateResponseInput {
2 result: ResultBelongsToInput
3 quiz: QuizBelongsToInput
4 conversionState: String
5 email: String
6 answers: [AnswerHasManyInput]
7}
8
9input CreateResponseArguments {
10 response: CreateResponseInput
11}
Example Create Invocation
1const responseRecord = await api.response.create({
2 response: {
3 // field values for Response
4 },
5});
6console.log(responseRecord.id); //=> a string
1const [result, createResponse] = useAction(api.response.create);
2const { data, error, fetching } = result;
3await createResponse({
4 response: {
5 // field values for Response
6 },
7});
8console.log(data?.id); //=> a string
1mutation ($response: CreateResponseInput) {
2 createResponse(response: $response) {
3 success
4 errors {
5 message
6 ... on InvalidRecordError {
7 validationErrors {
8 apiIdentifier
9 message
10 }
11 record
12 model {
13 apiIdentifier
14 }
15 }
16 }
17 response {
18 __typename
19 id
20 state
21 answers {
22 edges {
23 node {
24 id
25 state
26 createdAt
27 question {
28 id
29 state
30 body
31 createdAt
32 imageUrl
33 required
34 sequence
35 title
36 updatedAt
37 }
38 response {
39 id
40 state
41 conversionState
42 createdAt
43 email
44 updatedAt
45 }
46 result {
47 id
48 state
49 body
50 createdAt
51 imageUrl
52 updatedAt
53 }
54 sequence
55 text
56 updatedAt
57 }
58 }
59 }
60 conversionState
61 createdAt
62 email
63 quiz {
64 id
65 state
66 body
67 createdAt
68 title
69 updatedAt
70 }
71 result {
72 id
73 state
74 body
75 createdAt
76 imageUrl
77 productSuggestion {
78 id
79 state
80 barcode
81 compareAtPrice
82 createdAt
83 fulfillmentService
84 grams
85 inventoryManagement
86 inventoryPolicy
87 inventoryQuantity
88 inventoryQuantityAdjustment
89 oldInventoryQuantity
90 option1
91 option2
92 option3
93 position
94 presentmentPrices
95 price
96 requiresShipping
97 shopifyCreatedAt
98 shopifyUpdatedAt
99 sku
100 taxCode
101 taxable
102 title
103 updatedAt
104 weight
105 weightUnit
106 }
107 quiz {
108 id
109 state
110 body
111 createdAt
112 title
113 updatedAt
114 }
115 updatedAt
116 }
117 updatedAt
118 }
119 }
120}
Variables
json
{
"response": {}
}
Output

Create returns the Response. In the JS client, the fields returned can be controlled with the select option. In GraphQL, the return format is the action result format, which includes the record if the action was successful. You can include or exclude the fields you need right in the mutation itself.

Create Output Data
type CreateResponseResult {
success: Boolean!
errors: [ExecutionError!]
response: Response
}

Linking to an Existing Child Record

During a create or update operation, you can link to existing child records simply by nesting the data structure on your operation, using an update object wrapper around the child record's properties.

Existing nested child
1const resultRecord = await api.result.create({
2 result: {
3 answers: "answersValue",
4 responses: {
5 // Updates existing `response` record
6 // (`id` of record required),
7 // and links it to result.
8 update: {
9 id: "123",
10 conversionState: "responsesConversionStateValue",
11 },
12 },
13 },
14});
15console.log(resultRecord.id); //=> a string
1const [result, createResult] = useAction(api.result.create);
2const { data, error, fetching } = result;
3await createResult({
4 result: {
5 answers: "answersValue",
6 responses: {
7 // Updates existing `response` record
8 // (`id` of record required),
9 // and links it to result.
10 update: {
11 id: "123",
12 conversionState: "responsesConversionStateValue",
13 },
14 },
15 },
16});
17console.log(data?.id); //=> a string
1mutation ($result: CreateResultInput) {
2 createResult(result: $result) {
3 success
4 errors {
5 message
6 }
7 result {
8 id
9 answers
10 responses {
11 id
12 }
13 }
14 }
15}
Variables
json
1{
2 "answers": "answersValue",
3 "responses": {
4 "update": {
5 "id": "123",
6 "conversionState": "responsesConversionStateValue"
7 }
8 }
9}

Linking to a New Child Record

During a create or update operation, you can create linked child records simply by nesting the data structure on your operation, using a create object wrapper around the child record's properties.

New nested child
1const resultRecord = await api.result.create({
2 result: {
3 answers: "answersValue",
4 responses: {
5 // Creates `response` record,
6 // linked to result.
7 create: {
8 conversionState: "responsesConversionStateValue",
9 },
10 },
11 },
12});
13console.log(resultRecord.id); //=> a string
1const [result, createResult] = useAction(api.result.create);
2const { data, error, fetching } = result;
3await createResult({
4 result: {
5 answers: "answersValue",
6 responses: {
7 // Creates `response` record,
8 // linked to result.
9 create: {
10 conversionState: "responsesConversionStateValue",
11 },
12 },
13 },
14});
15console.log(data?.id); //=> a string
1mutation ($result: CreateResultInput) {
2 createResult(result: $result) {
3 success
4 errors {
5 message
6 }
7 result {
8 id
9 answers
10 responses {
11 id
12 }
13 }
14 }
15}
Variables
json
1{
2 "answers": "answersValue",
3 "responses": {
4 "create": {
5 "conversionState": "responsesConversionStateValue"
6 }
7 }
8}

Linking to an Existing Parent Record

When you wish to link to an existing parent record, you must use a _link property in your data, with the id of the parent record that this child record will belong to.

Linked creation
1const responseRecord = await api.response.create({
2 response: {
3 conversionState: "conversionStateValue",
4 // Links response to existing
5 // parent `result` record.
6 result: {
7 _link: "123",
8 },
9 },
10});
11console.log(responseRecord.id); //=> a string
1const [result, createResponse] = useAction(api.response.create);
2const { data, error, fetching } = result;
3await createResponse({
4 response: {
5 conversionState: "conversionStateValue",
6 // Links response to existing
7 // parent `result` record.
8 result: {
9 _link: "123",
10 },
11 },
12});
13console.log(data?.id); //=> a string
1mutation ($response: CreateResponseInput) {
2 createResponse(response: $response) {
3 success
4 errors {
5 message
6 }
7 response {
8 id
9 conversionState
10 result {
11 id
12 }
13 }
14 }
15}
Variables
json
1{
2 "conversionState": "conversionStateValue",
3 "result": {
4 "_link": "123"
5 }
6}

Linking to a New Parent Record

You cannot directly link to a new parent record when creation a child record. However, you can jointly create both parent and child via the Linking to a New Child Record method.

Bulk Actions

Actions that support it can be performed in bulk. Bulk Actions are executed as a single GraphQL mutation and have a corresponding function available in the API client libraries. Bulk Actions are performed on a set of ids. Bulk Actions repeat the same action, with the same options and parameters, across all ids and should not be confused with batching up different actions in the same request.

Bulk Actions will be performed on the entire set. If an action fails on an individual record, the Bulk Action will still occur on the other records in the set. Only the records which completed the action successfully will be returned.

Bulk Response Delete

The Bulk Delete action destroys the records.

Input

Bulk Delete operates on a set of Responses, identified by the ids variable.

Example Delete Invocation
await api.response.bulkDelete(["some-id", "another-id"]);
const [responseResult, bulkDelete] = useBulkAction(api.response.bulkDelete);
const { data, error, fetching } = result;
await bulkDelete({ ids: ["some-id", "another-id"] });
1mutation ($ids: [GadgetID!]!) {
2 bulkDeleteResponses(ids: $ids) {
3 success
4 errors {
5 message
6 }
7 }
8}
Variables
json
1{
2 "ids": [
3 "some-id",
4 "another-id"
5 ]
6}
Output

Bulk Delete deletes the record, so it returns void in the JS client. In GraphQL it returns only the success and errors from the action result format.

Delete Output Data
type BulkDeleteResponsesResult {
success: Boolean!
errors: [ExecutionError!]
}