@worknice/js-sdk 0.11.8 → 0.11.9-rc.2

package/dist/api/_generated.d.ts

@@ -357,6 +357,7 @@ type BasicAbnFormTemplate = Template & {
     id: Scalars['ID']['output'];
     name: Scalars['String']['output'];
     org: Org;
+    /** Paperwork summaries are only returned for paperwork that can be summarised (the person has at least one assignment for the template or the template is marked as required for the person). */
     paperworkSummaries: Array<PaperworkSummary>;
     /** @deprecated Unused. */
     templateParameters: Array<TemplateParameter>;
@@ -437,6 +438,7 @@ type BasicBankAccountFormTemplate = Template & {
     id: Scalars['ID']['output'];
     name: Scalars['String']['output'];
     org: Org;
+    /** Paperwork summaries are only returned for paperwork that can be summarised (the person has at least one assignment for the template or the template is marked as required for the person). */
     paperworkSummaries: Array<PaperworkSummary>;
     /** @deprecated Unused. */
     templateParameters: Array<TemplateParameter>;
@@ -531,6 +533,7 @@ type BasicEmergencyContactFormTemplate = Template & {
     id: Scalars['ID']['output'];
     name: Scalars['String']['output'];
     org: Org;
+    /** Paperwork summaries are only returned for paperwork that can be summarised (the person has at least one assignment for the template or the template is marked as required for the person). */
     paperworkSummaries: Array<PaperworkSummary>;
     /** @deprecated Unused. */
     templateParameters: Array<TemplateParameter>;
@@ -608,6 +611,7 @@ type BasicPersonalDetailsFormTemplate = Template & {
     id: Scalars['ID']['output'];
     name: Scalars['String']['output'];
     org: Org;
+    /** Paperwork summaries are only returned for paperwork that can be summarised (the person has at least one assignment for the template or the template is marked as required for the person). */
     paperworkSummaries: Array<PaperworkSummary>;
     /** @deprecated Unused. */
     templateParameters: Array<TemplateParameter>;
@@ -671,6 +675,7 @@ type BasicPreEmploymentFormTemplate = Template & {
     introduction?: Maybe<Scalars['String']['output']>;
     name: Scalars['String']['output'];
     org: Org;
+    /** Paperwork summaries are only returned for paperwork that can be summarised (the person has at least one assignment for the template or the template is marked as required for the person). */
     paperworkSummaries: Array<PaperworkSummary>;
     /** @deprecated Unused. */
     templateParameters: Array<TemplateParameter>;
@@ -743,6 +748,7 @@ type BasicSuperFormTemplate = Template & {
     id: Scalars['ID']['output'];
     name: Scalars['String']['output'];
     org: Org;
+    /** Paperwork summaries are only returned for paperwork that can be summarised (the person has at least one assignment for the template or the template is marked as required for the person). */
     paperworkSummaries: Array<PaperworkSummary>;
     /** @deprecated Unused. */
     templateParameters: Array<TemplateParameter>;
@@ -809,6 +815,7 @@ type BasicTaxFormTemplate = Template & {
     id: Scalars['ID']['output'];
     name: Scalars['String']['output'];
     org: Org;
+    /** Paperwork summaries are only returned for paperwork that can be summarised (the person has at least one assignment for the template or the template is marked as required for the person). */
     paperworkSummaries: Array<PaperworkSummary>;
     /** @deprecated Unused. */
     templateParameters: Array<TemplateParameter>;
@@ -838,6 +845,7 @@ type Bundle = {
     id: Scalars['ID']['output'];
     name: Scalars['String']['output'];
     org: Org;
+    /** Paperwork summaries are only returned for paperwork that can be summarised (the person has at least one assignment for the template or the template is marked as required for the person). */
     paperworkSummaries: Array<PaperworkSummary>;
     updatedAt: Scalars['DateTime']['output'];
 };
@@ -929,6 +937,7 @@ type CertificateTemplate = Template & {
     issueDatePresence: FieldPresence;
     name: Scalars['String']['output'];
     org: Org;
+    /** Paperwork summaries are only returned for paperwork that can be summarised (the person has at least one assignment for the template or the template is marked as required for the person). */
     paperworkSummaries: Array<PaperworkSummary>;
     proof: CertificateProof;
     /** @deprecated Unused. */
@@ -1144,6 +1153,7 @@ type DocumentTemplate = Template & {
     id: Scalars['ID']['output'];
     name: Scalars['String']['output'];
     org: Org;
+    /** Paperwork summaries are only returned for paperwork that can be summarised (the person has at least one assignment for the template or the template is marked as required for the person). */
     paperworkSummaries: Array<PaperworkSummary>;
     /** @deprecated Use 'fields' instead. */
     templateParameters: Array<TemplateParameter>;
@@ -1730,6 +1740,7 @@ type KeypayEmployeeFormTemplate = Template & {
     mobilePhonePresence: FieldPresence;
     name: Scalars['String']['output'];
     org: Org;
+    /** Paperwork summaries are only returned for paperwork that can be summarised (the person has at least one assignment for the template or the template is marked as required for the person). */
     paperworkSummaries: Array<PaperworkSummary>;
     personalDetailsPresence: FieldPresence;
     superPresence: FieldPresence;
@@ -3553,6 +3564,7 @@ type Org = {
     locations: Array<Location>;
     logo?: Maybe<Media>;
     name: Scalars['String']['output'];
+    /** Paperwork summaries are only returned for paperwork that can be summarised (the person has at least one assignment for the template or the template is marked as required for the person). */
     paperworkSummaries: Array<PaperworkSummary>;
     people: Array<Maybe<Person>>;
     positions: Array<Position>;
@@ -3639,7 +3651,16 @@ type PaperworkAssignmentNotificationsArgs = {
     includeRead?: InputMaybe<Scalars['Boolean']['input']>;
     personId: Scalars['ID']['input'];
 };
-/** The summary of a person and template (a.k.a. a "paperwork type"). */
+/**
+ * The intersection of a person and template. Most usefully, this provides a `status` that
+ * explains relationship between each person and template (e.g. "missing" if the templates needs
+ * to be assigned to the person or "expired" if the person's most recent assignment that belongs to
+ * that template has expired).
+ *
+ * Note: A paperwork summary will never be returned for a "not required" case — when the template
+ * is not marked as required for the person and the person does not have any assignments that belong
+ * to the template.
+ */
 type PaperworkSummary = {
     /** @deprecated Use the 'latestAssignment' field instead. */
     canonical?: Maybe<PaperworkAssignment>;
@@ -3668,36 +3689,62 @@ type PaperworkSummary = {
  * The status of a paperwork summary is determined using the following algorithm:
  *
  * 1. Let _person_ be the person associated with this paperwork summary.
+ *
  * 2. Let _template_ be the template associated with this paperwork summary.
+ *
  * 3. Let _latest assignment_ be the most recently created assignment where the
- *   owner is _person_ and the template is _template_.
+ *    owner is _person_ and the template is _template_.
+ *
  * 4. If _latest assignment_ is not null:
- *   1. If the status of _latest assignment_ is `DRAFT`:
+ *
+ *    1. If the status of _latest assignment_ is `DRAFT`:
+ *
  *       1. If _latest assignment_ has 1 or more approvals (with any status):
- *         1. If all the approvals on _latest assignment_ have an "approved"
+ *
+ *          1. If all the approvals on _latest assignment_ have an "approved"
  *             status:
+ *
  *             1. Return `APPROVED`.
- *         2. Return `PENDING_APPROVAL`.
+ *          2. Return `PENDING_APPROVAL`.
+ *
  *       2. Return `DRAFT`.
- *   2. If the status of _latest assignment_ is `ASSIGNED`:
+ *
+ *    2. If the status of _latest assignment_ is `ASSIGNED`:
+ *
  *       1. If the current date is after the due date of _latest assignment_:
- *         1. Return `OVERDUE`.
+ *
+ *          1. Return `OVERDUE`.
+ *
  *       2. If the current date is after the due date of _latest assignment_
- *         minus 14 days:
- *         1. Return `DUE_SOON`.
+ *          minus 14 days:
+ *
+ *          1. Return `DUE_SOON`.
  *       3. Return `ASSIGNED`.
- *   3. If the status of _latest assignment_ is `SUBMITTED`:
+ *
+ *    3. If the status of _latest assignment_ is `SUBMITTED`:
+ *
  *       1. Return `SUBMITTED`.
- *   4. If the _template_ is marked as required for _person_:
+ *
+ *    4. If the _template_ is marked as required for _person_:
+ *
  *       1. If the expiry status of _latest assignment_ is `EXPIRED` or
  *          `RECENTLY_EXPIRED`:
- *         1. Return `EXPIRED`.
+ *
+ *          1. Return `EXPIRED`.
+ *
  *       2. If the expiry status of _latest assignment_ is `EXPIRING_SOON`:
- *         1. Return `EXPIRING_SOON`.
+ *
+ *          1. Return `EXPIRING_SOON`.
+ *
  *       3. Return `PROCESSED`.
- *   5. Return `PROCESSED`.
+ *
+ *    5. Return `PROCESSED`.
+ *
  * 5. If the _template_ is marked as required for _person_:
- *   1. Return `MISSING`.
+ *
+ *    1. Return `MISSING`.
+ *
+ * 6. Return nothing. (This is the "not required" condition — a paperwork summary will not exist and therefore a status is not required.)
  */
 declare enum PaperworkSummaryStatus {
     Approved = "APPROVED",
@@ -3816,6 +3863,7 @@ type Person = {
     notificationsUser?: Maybe<User>;
     org: Org;
     otherGivenNames?: Maybe<Scalars['String']['output']>;
+    /** Paperwork summaries are only returned for paperwork that can be summarised (the person has at least one assignment for the template or the template is marked as required for the person). */
     paperworkSummaries: Array<PaperworkSummary>;
     payPeriod?: Maybe<PayPeriod>;
     payRate?: Maybe<Scalars['Decimal']['output']>;
@@ -4628,6 +4676,7 @@ type QuestionnaireTemplate = Template & {
     instructions?: Maybe<Scalars['String']['output']>;
     name: Scalars['String']['output'];
     org: Org;
+    /** Paperwork summaries are only returned for paperwork that can be summarised (the person has at least one assignment for the template or the template is marked as required for the person). */
     paperworkSummaries: Array<PaperworkSummary>;
     questions: Array<QuestionnaireTemplateQuestion>;
     /** @deprecated Unused. */
@@ -4879,6 +4928,7 @@ type StandardReviewTemplate = Template & {
     id: Scalars['ID']['output'];
     name: Scalars['String']['output'];
     org: Org;
+    /** Paperwork summaries are only returned for paperwork that can be summarised (the person has at least one assignment for the template or the template is marked as required for the person). */
     paperworkSummaries: Array<PaperworkSummary>;
     questions: Array<StandardReviewTemplateQuestion>;
     reviewerInstructions?: Maybe<Scalars['Markdown']['output']>;
@@ -4974,6 +5024,7 @@ type TaskTemplate = Template & {
     id: Scalars['ID']['output'];
     name: Scalars['String']['output'];
     org: Org;
+    /** Paperwork summaries are only returned for paperwork that can be summarised (the person has at least one assignment for the template or the template is marked as required for the person). */
     paperworkSummaries: Array<PaperworkSummary>;
     /** @deprecated Unused. */
     templateParameters: Array<TemplateParameter>;
@@ -5006,6 +5057,7 @@ type Template = {
     id: Scalars['ID']['output'];
     name: Scalars['String']['output'];
     org: Org;
+    /** Paperwork summaries are only returned for paperwork that can be summarised (the person has at least one assignment for the template or the template is marked as required for the person). */
     paperworkSummaries: Array<PaperworkSummary>;
     /** @deprecated Unused. */
     templateParameters: Array<TemplateParameter>;