@unito/integrations-platform-client 0.48.2 → 0.48.4

package/dist/src/api.d.ts

@@ -66,7 +66,7 @@ export type Error = {
     stack?: string[];
 };
 export type AuthorizationMethod = 'custom' | 'oauth2';
-export type AuthorizationGrantType = 'authorization_code' | 'password';
+export type AuthorizationGrantType = 'authorization_code' | 'password' | 'client_credentials';
 export type AuthorizationScope = {
     /** The name of the scope. */
     name: string;
@@ -161,6 +161,16 @@ export type Credential = Base & {
     /** The partition used to divide data into different buckets. */
     partitionKey?: string | null;
 };
+export type CredentialAccount = {
+    /** The native id of the provider account. */
+    id: string;
+    /** The display name of the provider account. */
+    displayName: string;
+    /** The emails associated with the provider account. */
+    emails: string[];
+    /** The partition used to divide data into different buckets. */
+    partition?: string;
+};
 export type UserRole = 'unitoAdministrator' | 'unitoService' | 'developer';
 export type UserSummary = Base & {
     /** The id of the user. */
@@ -177,16 +187,6 @@ export type User = UserSummary & {
     /** The API key of the user. */
     apiKey: string;
 };
-export type CredentialAccount = {
-    /** The native id of the provider account. */
-    id: string;
-    /** The display name of the provider account. */
-    displayName: string;
-    /** The emails associated with the provider account. */
-    emails: string[];
-    /** The partition used to divide data into different buckets. */
-    partition?: string;
-};
 /**
  * Get all the integrations
  */
@@ -353,12 +353,19 @@ export declare function updateCredential(credentialId: number, body?: {
  * Delete a credential
  */
 export declare function deleteCredential(credentialId: number, opts?: Oazapfts.RequestOpts): Promise<unknown>;
+/**
+ * Returns the credentialAccount either from the integration's /me endpoint, if available, or the credential's latestCredentialAccount
+ */
+export declare function getCredentialAccount(xUnitoCredentialId: string, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, }?: {
+    xUnitoCorrelationId?: string;
+    xUnitoAdditionalLoggingContext?: string;
+}, opts?: Oazapfts.RequestOpts): Promise<CredentialAccount>;
 /**
  * Used by the frontend to send analytics data
  */
 export declare function postTrack(body: {
     jwtToken: string;
-    event: 'AUTH_START' | 'AUTH_SUBMIT' | 'AUTH_ACTION' | 'AUTH_BLOCKED' | 'AUTH_CHOOSE_CONNECTION_START' | 'AUTH_CHOOSE_CONNECTION_SUBMIT';
+    event: 'AUTH_START' | 'AUTH_SUBMIT' | 'AUTH_ACTION' | 'AUTH_BLOCKED' | 'USER_SUCCEEDS_CONNECTION' | 'USER_FAILED_CONNECTION';
     payload?: {
         [key: string]: any;
     };
@@ -493,3 +500,39 @@ export declare function regenerateApiKey(userId: number, opts?: Oazapfts.Request
 export declare function getUserByEmail(email: string, opts?: Oazapfts.RequestOpts): Promise<User>;
 import { HttpError } from '@oazapfts/runtime';
 export { HttpError };
+import * as IntegrationApi from '@unito/integration-api';
+/**
+ * Return true if object has the shape of an item, false otherwise.
+ * @param object
+ */
+export declare function isIntegrationApiItem(object: any): object is IntegrationApi.Item;
+/**
+ * Return true if object has the shape of an item, false otherwise.
+ * @param object
+ */
+export declare function isIntegrationApiItemSummary(object: any): object is IntegrationApi.ItemSummary;
+/**
+ * Return true if object has the shape of a collection, false otherwise.
+ * @param object
+ */
+export declare function isIntegrationApiCollection(object: any): object is IntegrationApi.Collection;
+export declare function getProxyGraphItem(xUnitoCredentialId: string, path: string, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, }?: {
+    xUnitoCorrelationId?: string;
+    xUnitoAdditionalLoggingContext?: string;
+}, opts?: Oazapfts.RequestOpts): Promise<IntegrationApi.Item>;
+export declare function getProxyGraphCollection(xUnitoCredentialId: string, path: string, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, }?: {
+    xUnitoCorrelationId?: string;
+    xUnitoAdditionalLoggingContext?: string;
+}, opts?: Oazapfts.RequestOpts): Promise<IntegrationApi.Collection>;
+export declare function patchProxyGraphItem(xUnitoCredentialId: string, path: string, body?: object, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, }?: {
+    xUnitoCorrelationId?: string;
+    xUnitoAdditionalLoggingContext?: string;
+}, opts?: Oazapfts.RequestOpts): Promise<IntegrationApi.Item>;
+export declare function postProxyGraphCollection(xUnitoCredentialId: string, path: string, body?: object, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, }?: {
+    xUnitoCorrelationId?: string;
+    xUnitoAdditionalLoggingContext?: string;
+}, opts?: Oazapfts.RequestOpts): Promise<IntegrationApi.ItemSummary>;
+export declare function deleteProxyGraphItem(xUnitoCredentialId: string, path: string, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, }?: {
+    xUnitoCorrelationId?: string;
+    xUnitoAdditionalLoggingContext?: string;
+}, opts?: Oazapfts.RequestOpts): Promise<void>;

package/dist/src/api.js

@@ -173,6 +173,19 @@ export function deleteCredential(credentialId, opts) {
         method: 'DELETE',
     }));
 }
+/**
+ * Returns the credentialAccount either from the integration's /me endpoint, if available, or the credential's latestCredentialAccount
+ */
+export function getCredentialAccount(xUnitoCredentialId, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
+    return oazapfts.ok(oazapfts.fetchJson('/credentialAccount', {
+        ...opts,
+        headers: oazapfts.mergeHeaders(opts?.headers, {
+            'X-Unito-Credential-Id': xUnitoCredentialId,
+            'X-Unito-Correlation-Id': xUnitoCorrelationId,
+            'X-Unito-Additional-Logging-Context': xUnitoAdditionalLoggingContext,
+        }),
+    }));
+}
 /**
  * Used by the frontend to send analytics data
  */
@@ -379,5 +392,81 @@ export function getUserByEmail(email, opts) {
         ...opts,
     }));
 }
+// MANUAL ADDONS
 import { HttpError } from '@oazapfts/runtime';
 export { HttpError };
+/**
+ * Return true if object has the shape of an item, false otherwise.
+ * @param object
+ */
+export function isIntegrationApiItem(object) {
+    return object && typeof object === 'object' && 'fields' in object && 'relations' in object;
+}
+/**
+ * Return true if object has the shape of an item, false otherwise.
+ * @param object
+ */
+export function isIntegrationApiItemSummary(object) {
+    return object && typeof object === 'object' && 'path' in object;
+}
+/**
+ * Return true if object has the shape of a collection, false otherwise.
+ * @param object
+ */
+export function isIntegrationApiCollection(object) {
+    return object && typeof object === 'object' && 'info' in object && 'data' in object && Array.isArray(object.data);
+}
+export async function getProxyGraphItem(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
+    const response = await getProxyGraph(xUnitoCredentialId, path, {
+        xUnitoCorrelationId,
+        xUnitoAdditionalLoggingContext,
+    }, opts);
+    if (isIntegrationApiItem(response)) {
+        return response;
+    }
+    else {
+        throw new Error(`Response does not match expected Item shape`);
+    }
+}
+export async function getProxyGraphCollection(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
+    const response = await getProxyGraph(xUnitoCredentialId, path, {
+        xUnitoCorrelationId,
+        xUnitoAdditionalLoggingContext,
+    }, opts);
+    if (isIntegrationApiCollection(response)) {
+        return response;
+    }
+    else {
+        throw new Error(`Response does not match expected Collection shape`);
+    }
+}
+export async function patchProxyGraphItem(xUnitoCredentialId, path, body, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
+    const response = await patchProxyGraph(xUnitoCredentialId, path, body, {
+        xUnitoCorrelationId,
+        xUnitoAdditionalLoggingContext,
+    }, opts);
+    if (isIntegrationApiItem(response)) {
+        return response;
+    }
+    else {
+        throw new Error(`Response does not match expected Item shape`);
+    }
+}
+export async function postProxyGraphCollection(xUnitoCredentialId, path, body, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
+    const response = await postProxyGraph(xUnitoCredentialId, path, body, {
+        xUnitoCorrelationId,
+        xUnitoAdditionalLoggingContext,
+    }, opts);
+    if (isIntegrationApiItemSummary(response)) {
+        return response;
+    }
+    else {
+        throw new Error(`Response does not match expected ItemSummary shape`);
+    }
+}
+export async function deleteProxyGraphItem(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
+    await deleteProxyGraph(xUnitoCredentialId, path, {
+        xUnitoCorrelationId,
+        xUnitoAdditionalLoggingContext,
+    }, opts);
+}

package/dist/src/index.cjs

@@ -196,6 +196,19 @@ function deleteCredential(credentialId, opts) {
         method: 'DELETE',
     }));
 }
+/**
+ * Returns the credentialAccount either from the integration's /me endpoint, if available, or the credential's latestCredentialAccount
+ */
+function getCredentialAccount(xUnitoCredentialId, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
+    return oazapfts.ok(oazapfts.fetchJson('/credentialAccount', {
+        ...opts,
+        headers: oazapfts.mergeHeaders(opts?.headers, {
+            'X-Unito-Credential-Id': xUnitoCredentialId,
+            'X-Unito-Correlation-Id': xUnitoCorrelationId,
+            'X-Unito-Additional-Logging-Context': xUnitoAdditionalLoggingContext,
+        }),
+    }));
+}
 /**
  * Used by the frontend to send analytics data
  */
@@ -402,6 +415,81 @@ function getUserByEmail(email, opts) {
         ...opts,
     }));
 }
+/**
+ * Return true if object has the shape of an item, false otherwise.
+ * @param object
+ */
+function isIntegrationApiItem(object) {
+    return object && typeof object === 'object' && 'fields' in object && 'relations' in object;
+}
+/**
+ * Return true if object has the shape of an item, false otherwise.
+ * @param object
+ */
+function isIntegrationApiItemSummary(object) {
+    return object && typeof object === 'object' && 'path' in object;
+}
+/**
+ * Return true if object has the shape of a collection, false otherwise.
+ * @param object
+ */
+function isIntegrationApiCollection(object) {
+    return object && typeof object === 'object' && 'info' in object && 'data' in object && Array.isArray(object.data);
+}
+async function getProxyGraphItem(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
+    const response = await getProxyGraph(xUnitoCredentialId, path, {
+        xUnitoCorrelationId,
+        xUnitoAdditionalLoggingContext,
+    }, opts);
+    if (isIntegrationApiItem(response)) {
+        return response;
+    }
+    else {
+        throw new Error(`Response does not match expected Item shape`);
+    }
+}
+async function getProxyGraphCollection(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
+    const response = await getProxyGraph(xUnitoCredentialId, path, {
+        xUnitoCorrelationId,
+        xUnitoAdditionalLoggingContext,
+    }, opts);
+    if (isIntegrationApiCollection(response)) {
+        return response;
+    }
+    else {
+        throw new Error(`Response does not match expected Collection shape`);
+    }
+}
+async function patchProxyGraphItem(xUnitoCredentialId, path, body, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
+    const response = await patchProxyGraph(xUnitoCredentialId, path, body, {
+        xUnitoCorrelationId,
+        xUnitoAdditionalLoggingContext,
+    }, opts);
+    if (isIntegrationApiItem(response)) {
+        return response;
+    }
+    else {
+        throw new Error(`Response does not match expected Item shape`);
+    }
+}
+async function postProxyGraphCollection(xUnitoCredentialId, path, body, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
+    const response = await postProxyGraph(xUnitoCredentialId, path, body, {
+        xUnitoCorrelationId,
+        xUnitoAdditionalLoggingContext,
+    }, opts);
+    if (isIntegrationApiItemSummary(response)) {
+        return response;
+    }
+    else {
+        throw new Error(`Response does not match expected ItemSummary shape`);
+    }
+}
+async function deleteProxyGraphItem(xUnitoCredentialId, path, { xUnitoCorrelationId, xUnitoAdditionalLoggingContext, } = {}, opts) {
+    await deleteProxyGraph(xUnitoCredentialId, path, {
+        xUnitoCorrelationId,
+        xUnitoAdditionalLoggingContext,
+    }, opts);
+}
 
 var api = {
     __proto__: null,
@@ -414,7 +502,9 @@ var api = {
     deleteCredential: deleteCredential,
     deleteIntegration: deleteIntegration,
     deleteProxyGraph: deleteProxyGraph,
+    deleteProxyGraphItem: deleteProxyGraphItem,
     encryptData: encryptData,
+    getCredentialAccount: getCredentialAccount,
     getCredentialById: getCredentialById,
     getCredentials: getCredentials,
     getIntegrationById: getIntegrationById,
@@ -424,14 +514,21 @@ var api = {
     getIntegrations: getIntegrations,
     getProfile: getProfile,
     getProxyGraph: getProxyGraph,
+    getProxyGraphCollection: getProxyGraphCollection,
+    getProxyGraphItem: getProxyGraphItem,
     getProxyMe: getProxyMe,
     getUserByEmail: getUserByEmail,
     getUserById: getUserById,
     getUsers: getUsers,
     inviteOrganization: inviteOrganization,
     inviteUser: inviteUser,
+    isIntegrationApiCollection: isIntegrationApiCollection,
+    isIntegrationApiItem: isIntegrationApiItem,
+    isIntegrationApiItemSummary: isIntegrationApiItemSummary,
     patchProxyGraph: patchProxyGraph,
+    patchProxyGraphItem: patchProxyGraphItem,
     postProxyGraph: postProxyGraph,
+    postProxyGraphCollection: postProxyGraphCollection,
     postTrack: postTrack,
     publishIntegration: publishIntegration,
     reencryptData: reencryptData,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integrations-platform-client",
-  "version": "0.48.2",
+  "version": "0.48.4",
   "description": "The Unito Integrations Platform Client",
   "type": "module",
   "types": "./dist/src/index.d.ts",
@@ -48,6 +48,7 @@
     "typescript": "5.x"
   },
   "dependencies": {
-    "@oazapfts/runtime": "1.x"
+    "@oazapfts/runtime": "1.x",
+    "@unito/integration-api": "0.x"
   }
 }