@worknice/js-sdk 0.0.2 → 0.0.4

package/dist/_types-BXw9D0Qi.d.ts

@@ -0,0 +1,642 @@
+import { Exact, Scalars, InputMaybe, ConnectionStatus, PersonBankAccountsChangeInput, PersonDataTransferConfigInput, PersonEmergencyContactsChangeInput, PersonPersonalDetailsChangeInput, PersonPostalAddressChangeInput, PersonResidentialAddressChangeInput, PersonSuperFundsChangeInput, PersonTaxDetailsChangeInput, PersonTenureChangeInput, IntegrationStatus, AppCategory, AllocationMethod, Gender, TaxResidencyStatus, SuperFundNomination, TaxFileNumberExemption } from './api/_generated.js';
+
+declare const createWorkniceClient: (clientConfig?: ClientConfig) => {
+    fetchFromApi: <Data extends object, Variables extends object>(query: string, variables?: Variables, fetchOptions?: FetchOptions) => Promise<SuccessfulQueryResult<Data>>;
+    /**
+     * Transitions an integration with an 'UNAUTHORIZED' or 'UNCONFIGURED'
+     * status to an 'ACTIVE' status. Optionally, the name of the integration can
+     * be set at the same time.
+     */
+    activateIntegration: (variables: Pick<Exact<{
+        id: Scalars["ID"]["input"];
+        name?: InputMaybe<Scalars["String"]["input"]>;
+        rename: Scalars["Boolean"]["input"];
+    }>, "id" | "name">, fetchOptions?: FetchOptions) => Promise<{
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    }>;
+    authorizeIntegration: (variables: Exact<{
+        integrationId: Scalars["ID"]["input"];
+    }>, fetchOptions?: FetchOptions) => Promise<{
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    }>;
+    completeSync: (variables: Exact<{
+        integrationId: Scalars["ID"]["input"];
+    }>, fetchOptions?: FetchOptions) => Promise<{
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    }>;
+    /**
+     * Creates a new API token belonging to the current person.
+     */
+    createApiToken: (variables: Exact<{
+        name: Scalars["String"]["input"];
+    }>, fetchOptions?: FetchOptions) => Promise<{
+        token: string;
+        id: string;
+        name: string;
+    }>;
+    createDataImport: (variables: Exact<{
+        integrationId: Scalars["ID"]["input"];
+    }>, fetchOptions?: FetchOptions) => Promise<{
+        id: string;
+    }>;
+    createPersonConnection: (variables: {
+        integrationId: string;
+        personId: string;
+        remote: {
+            id: string;
+            name: string;
+        };
+        status: ConnectionStatus.Connected;
+    } | {
+        integrationId: string;
+        personId: string;
+        status: ConnectionStatus.LocalOnly;
+    } | {
+        integrationId: string;
+        personId: string;
+        remote: {
+            id: string;
+            name: string;
+        };
+        status: ConnectionStatus.Merged;
+    } | {
+        integrationId: string;
+        remote: {
+            id: string;
+            name: string;
+        };
+        status: ConnectionStatus.RemoteOnly;
+    }, fetchOptions?: FetchOptions) => Promise<({
+        __typename: "PersonConnection";
+        createdAt: string;
+        id: string;
+        status: ConnectionStatus;
+        updatedAt: string;
+        person?: {
+            displayName: string;
+            id: string;
+        } | null;
+        remote?: {
+            name: string;
+            id: string;
+            url?: string | null;
+        } | null;
+    } & {
+        status: ConnectionStatus.Connected;
+        remote: {
+            name: string;
+            id: string;
+            url?: string | null;
+        };
+        person: {
+            displayName: string;
+            id: string;
+        };
+    }) | ({
+        __typename: "PersonConnection";
+        createdAt: string;
+        id: string;
+        status: ConnectionStatus;
+        updatedAt: string;
+        person?: {
+            displayName: string;
+            id: string;
+        } | null;
+        remote?: {
+            name: string;
+            id: string;
+            url?: string | null;
+        } | null;
+    } & {
+        status: ConnectionStatus.Merged;
+        remote: {
+            name: string;
+            id: string;
+            url?: string | null;
+        };
+        person: {
+            displayName: string;
+            id: string;
+        };
+    }) | ({
+        __typename: "PersonConnection";
+        createdAt: string;
+        id: string;
+        status: ConnectionStatus;
+        updatedAt: string;
+        person?: {
+            displayName: string;
+            id: string;
+        } | null;
+        remote?: {
+            name: string;
+            id: string;
+            url?: string | null;
+        } | null;
+    } & {
+        status: ConnectionStatus.LocalOnly;
+        person: {
+            displayName: string;
+            id: string;
+        };
+        remote: null;
+    }) | ({
+        __typename: "PersonConnection";
+        createdAt: string;
+        id: string;
+        status: ConnectionStatus;
+        updatedAt: string;
+        person?: {
+            displayName: string;
+            id: string;
+        } | null;
+        remote?: {
+            name: string;
+            id: string;
+            url?: string | null;
+        } | null;
+    } & {
+        status: ConnectionStatus.RemoteOnly;
+        remote: {
+            name: string;
+            id: string;
+            url?: string | null;
+        };
+        person: null;
+    })>;
+    createPersonDataImportLine: (variables: Exact<{
+        bankAccounts?: InputMaybe<PersonBankAccountsChangeInput>;
+        config: PersonDataTransferConfigInput;
+        dataImportId: Scalars["ID"]["input"];
+        emergencyContacts?: InputMaybe<PersonEmergencyContactsChangeInput>;
+        personalDetails?: InputMaybe<PersonPersonalDetailsChangeInput>;
+        personId: Scalars["ID"]["input"];
+        postalAddress?: InputMaybe<PersonPostalAddressChangeInput>;
+        residentialAddress?: InputMaybe<PersonResidentialAddressChangeInput>;
+        superFunds?: InputMaybe<PersonSuperFundsChangeInput>;
+        taxDetails?: InputMaybe<PersonTaxDetailsChangeInput>;
+        tenure?: InputMaybe<PersonTenureChangeInput>;
+    }>, fetchOptions?: FetchOptions) => Promise<{
+        id: string;
+    }>;
+    /**
+     * Permanently deletes an API token belonging to the current person.
+     */
+    deleteApiToken: (variables: Exact<{
+        tokenId: Scalars["ID"]["input"];
+    }>, fetchOptions?: FetchOptions) => Promise<boolean>;
+    deletePersonConnection: (variables: Exact<{
+        personConnectionId: Scalars["ID"]["input"];
+    }>, fetchOptions?: FetchOptions) => Promise<boolean>;
+    /**
+     * Transitions an integration with an 'UNINITIALIZED' status to an 'UNAUTHORIZED' status.
+     */
+    initializeIntegration: (variables: Exact<{
+        id: Scalars["ID"]["input"];
+    }>, fetchOptions?: FetchOptions) => Promise<{
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    } | {
+        id: string;
+    }>;
+    /**
+     * Returns a list of API tokens belonging to the current person. This will not
+     * include the token values themselves as they are only available when the
+     * token is initially created.
+     *
+     * If there is no person associated with the session, a `NO_PERSON` error will
+     * be thrown.
+     */
+    getApiTokens: (variables: Exact<{
+        [key: string]: never;
+    }>, fetchOptions?: FetchOptions) => Promise<{
+        createdAt: string;
+        id: string;
+        name: string;
+    }[]>;
+    getIntegration: (variables: Exact<{
+        integrationId: Scalars["ID"]["input"];
+    }>, fetchOptions?: FetchOptions) => Promise<{
+        archived: boolean;
+        id: string;
+        status: IntegrationStatus;
+        app: {
+            category: AppCategory;
+            name: string;
+        };
+        org: {
+            id: string;
+        };
+    } | {
+        archived: boolean;
+        id: string;
+        status: IntegrationStatus;
+        app: {
+            category: AppCategory;
+            name: string;
+        };
+        org: {
+            id: string;
+        };
+    } | {
+        archived: boolean;
+        id: string;
+        status: IntegrationStatus;
+        app: {
+            category: AppCategory;
+            name: string;
+        };
+        org: {
+            id: string;
+        };
+    } | {
+        archived: boolean;
+        id: string;
+        status: IntegrationStatus;
+        app: {
+            category: AppCategory;
+            name: string;
+        };
+        org: {
+            id: string;
+        };
+    } | {
+        archived: boolean;
+        id: string;
+        status: IntegrationStatus;
+        app: {
+            category: AppCategory;
+            name: string;
+        };
+        org: {
+            id: string;
+        };
+    }>;
+    getPeople: (variables: Exact<{
+        orgId: Scalars["ID"]["input"];
+    }>, fetchOptions?: FetchOptions) => Promise<{
+        bankAccount1Allocation?: string | null;
+        bankAccount1AllocationMethod?: AllocationMethod | null;
+        bankAccount1Bsb?: string | null;
+        bankAccount1Name?: string | null;
+        bankAccount1Number?: string | null;
+        bankAccount2Allocation?: string | null;
+        bankAccount2AllocationMethod?: AllocationMethod | null;
+        bankAccount2Bsb?: string | null;
+        bankAccount2Name?: string | null;
+        bankAccount2Number?: string | null;
+        bankAccount3Allocation?: string | null;
+        bankAccount3AllocationMethod?: AllocationMethod | null;
+        bankAccount3Bsb?: string | null;
+        bankAccount3Name?: string | null;
+        bankAccount3Number?: string | null;
+        bankAccount4Allocation?: string | null;
+        bankAccount4AllocationMethod?: AllocationMethod | null;
+        bankAccount4Bsb?: string | null;
+        bankAccount4Name?: string | null;
+        bankAccount4Number?: string | null;
+        bankAccount5Allocation?: string | null;
+        bankAccount5AllocationMethod?: AllocationMethod | null;
+        bankAccount5Bsb?: string | null;
+        bankAccount5Name?: string | null;
+        bankAccount5Number?: string | null;
+        dateOfBirth?: string | null;
+        displayName: string;
+        employeeCode?: string | null;
+        endDate?: string | null;
+        familyName?: string | null;
+        gender?: Gender | null;
+        givenName?: string | null;
+        hasLoanOrStudentDebt?: boolean | null;
+        id: string;
+        otherGivenNames?: string | null;
+        personalEmail?: string | null;
+        personalPhone?: string | null;
+        profileEmail?: string | null;
+        residencyStatus?: TaxResidencyStatus | null;
+        residentialAddressCity?: string | null;
+        residentialAddressCountry?: string | null;
+        residentialAddressLine1?: string | null;
+        residentialAddressLine2?: string | null;
+        residentialAddressPostcode?: string | null;
+        residentialAddressState?: string | null;
+        startDate?: string | null;
+        superFund1MemberName?: string | null;
+        superFund1MemberNumber?: string | null;
+        superFund1Nomination?: SuperFundNomination | null;
+        superFund1Usi?: string | null;
+        taxFileNumber?: string | null;
+        taxFileNumberExemption?: TaxFileNumberExemption | null;
+        taxFreeThresholdClaimed?: boolean | null;
+        updatedAt: string;
+    }[]>;
+    getPersonConnections: (variables: Exact<{
+        integrationId: Scalars["ID"]["input"];
+    }>, fetchOptions?: FetchOptions) => Promise<(({
+        __typename: "PersonConnection";
+        createdAt: string;
+        id: string;
+        status: ConnectionStatus;
+        updatedAt: string;
+        person?: {
+            displayName: string;
+            id: string;
+        } | null;
+        remote?: {
+            name: string;
+            id: string;
+            url?: string | null;
+        } | null;
+    } & {
+        status: ConnectionStatus.Connected;
+        remote: {
+            name: string;
+            id: string;
+            url?: string | null;
+        };
+        person: {
+            displayName: string;
+            id: string;
+        };
+    }) | ({
+        __typename: "PersonConnection";
+        createdAt: string;
+        id: string;
+        status: ConnectionStatus;
+        updatedAt: string;
+        person?: {
+            displayName: string;
+            id: string;
+        } | null;
+        remote?: {
+            name: string;
+            id: string;
+            url?: string | null;
+        } | null;
+    } & {
+        status: ConnectionStatus.Merged;
+        remote: {
+            name: string;
+            id: string;
+            url?: string | null;
+        };
+        person: {
+            displayName: string;
+            id: string;
+        };
+    }) | ({
+        __typename: "PersonConnection";
+        createdAt: string;
+        id: string;
+        status: ConnectionStatus;
+        updatedAt: string;
+        person?: {
+            displayName: string;
+            id: string;
+        } | null;
+        remote?: {
+            name: string;
+            id: string;
+            url?: string | null;
+        } | null;
+    } & {
+        status: ConnectionStatus.LocalOnly;
+        person: {
+            displayName: string;
+            id: string;
+        };
+        remote: null;
+    }) | ({
+        __typename: "PersonConnection";
+        createdAt: string;
+        id: string;
+        status: ConnectionStatus;
+        updatedAt: string;
+        person?: {
+            displayName: string;
+            id: string;
+        } | null;
+        remote?: {
+            name: string;
+            id: string;
+            url?: string | null;
+        } | null;
+    } & {
+        status: ConnectionStatus.RemoteOnly;
+        remote: {
+            name: string;
+            id: string;
+            url?: string | null;
+        };
+        person: null;
+    }))[]>;
+    updatePersonConnection: (variables: {
+        personConnectionId: string;
+        personId: string;
+        remote: {
+            id: string;
+            name: string;
+        };
+        status: ConnectionStatus.Connected;
+    } | {
+        personConnectionId: string;
+        personId: string;
+        status: ConnectionStatus.LocalOnly;
+    } | {
+        personConnectionId: string;
+        personId: string;
+        remote: {
+            id: string;
+            name: string;
+        };
+        status: ConnectionStatus.Merged;
+    } | {
+        personConnectionId: string;
+        remote: {
+            id: string;
+            name: string;
+        };
+        status: ConnectionStatus.RemoteOnly;
+    }, fetchOptions?: FetchOptions) => Promise<({
+        __typename: "PersonConnection";
+        createdAt: string;
+        id: string;
+        status: ConnectionStatus;
+        updatedAt: string;
+        person?: {
+            displayName: string;
+            id: string;
+        } | null;
+        remote?: {
+            name: string;
+            id: string;
+            url?: string | null;
+        } | null;
+    } & {
+        status: ConnectionStatus.Connected;
+        remote: {
+            name: string;
+            id: string;
+            url?: string | null;
+        };
+        person: {
+            displayName: string;
+            id: string;
+        };
+    }) | ({
+        __typename: "PersonConnection";
+        createdAt: string;
+        id: string;
+        status: ConnectionStatus;
+        updatedAt: string;
+        person?: {
+            displayName: string;
+            id: string;
+        } | null;
+        remote?: {
+            name: string;
+            id: string;
+            url?: string | null;
+        } | null;
+    } & {
+        status: ConnectionStatus.Merged;
+        remote: {
+            name: string;
+            id: string;
+            url?: string | null;
+        };
+        person: {
+            displayName: string;
+            id: string;
+        };
+    }) | ({
+        __typename: "PersonConnection";
+        createdAt: string;
+        id: string;
+        status: ConnectionStatus;
+        updatedAt: string;
+        person?: {
+            displayName: string;
+            id: string;
+        } | null;
+        remote?: {
+            name: string;
+            id: string;
+            url?: string | null;
+        } | null;
+    } & {
+        status: ConnectionStatus.LocalOnly;
+        person: {
+            displayName: string;
+            id: string;
+        };
+        remote: null;
+    }) | ({
+        __typename: "PersonConnection";
+        createdAt: string;
+        id: string;
+        status: ConnectionStatus;
+        updatedAt: string;
+        person?: {
+            displayName: string;
+            id: string;
+        } | null;
+        remote?: {
+            name: string;
+            id: string;
+            url?: string | null;
+        } | null;
+    } & {
+        status: ConnectionStatus.RemoteOnly;
+        remote: {
+            name: string;
+            id: string;
+            url?: string | null;
+        };
+        person: null;
+    })>;
+};
+
+type SuccessfulQueryResult<Data extends object = object> = Readonly<{
+    data: Data;
+}> | Readonly<{
+    data: Data;
+    errors: ReadonlyArray<GraphQLFormattedError>;
+}>;
+type FailedQueryResult = Readonly<{
+    data: null;
+    errors: ReadonlyArray<GraphQLFormattedError>;
+}> | Readonly<{
+    errors: ReadonlyArray<GraphQLFormattedError>;
+}>;
+type QueryResult<Data extends object = object> = SuccessfulQueryResult<Data> | FailedQueryResult;
+type FetchOptions = {
+    signal?: AbortSignal;
+};
+type ClientConfig = {
+    accessToken?: string;
+    apiUrl?: string;
+};
+type WorkniceClient = ReturnType<typeof createWorkniceClient>;
+interface GraphQLFormattedError {
+    /**
+     * A short, human-readable summary of the problem that **SHOULD NOT** change
+     * from occurrence to occurrence of the problem, except for purposes of
+     * localization.
+     */
+    readonly message: string;
+    /**
+     * If an error can be associated to a particular point in the requested
+     * GraphQL document, it should contain a list of locations.
+     */
+    readonly locations?: ReadonlyArray<SourceLocation>;
+    /**
+     * If an error can be associated to a particular field in the GraphQL result,
+     * it _must_ contain an entry with the key `path` that details the path of
+     * the response field which experienced the error. This allows clients to
+     * identify whether a null result is intentional or caused by a runtime error.
+     */
+    readonly path?: ReadonlyArray<string | number>;
+    /**
+     * Reserved for implementors to extend the protocol however they see fit,
+     * and hence there are no additional restrictions on its contents.
+     */
+    readonly extensions?: {
+        [key: string]: unknown;
+    };
+}
+interface SourceLocation {
+    readonly line: number;
+    readonly column: number;
+}
+
+export { type ClientConfig as C, type FetchOptions as F, type QueryResult as Q, type SuccessfulQueryResult as S, type WorkniceClient as W, type FailedQueryResult as a, createWorkniceClient as c };