@unito/integrations-platform-client 0.44.3 → 0.45.0

package/README.md

@@ -8,13 +8,13 @@ This component is a JS client library to communicate with the Integrations Platf
 1. Install the library:
 
 ```sh
-npm install @unitoio/integrations-platform-client
+npm install @unito/integrations-platform-client
 ```
 
 2. Use the library:
 
 ```typescript
-import IntegrationsPlatform from '@unitoio/integrations-platform-client';
+import IntegrationsPlatform from '@unito/integrations-platform-client';
 
 IntegrationsPlatform.defaults.baseUrl = 'http://enpoint.to.the.server';
 IntegrationsPlatform.defaults.headers = { Authorization: 'Bearer YOUR_TOKEN' };

package/dist/src/api.d.ts

@@ -5,13 +5,14 @@
  * See https://www.npmjs.com/package/oazapfts
  */
 import * as Oazapfts from 'oazapfts/lib/runtime';
-export declare const defaults: Oazapfts.RequestOpts;
+export declare const defaults: Oazapfts.Defaults<Oazapfts.CustomHeaders>;
 export declare const servers: {
     local: string;
     staging: string;
     production: string;
 };
 export type Pagination = {
+    /** The total number of results. */
     total: number;
 };
 export type Base = {
@@ -20,51 +21,77 @@ export type Base = {
     archivedAt: string | null;
 };
 export type IntegrationSummary = Base & {
+    /** The id of the integration. */
     id: number;
+    /** The name of the integration. */
     name: string;
+    /** The base URL where the integration is located. */
     baseUrl: string | null;
+    /** The relative URL (to the baseUrl) where the graph of items of the integration is located. */
     graphRelativeUrl: string;
+    /** The relative URL (to the baseUrl) to fetch the current integration's authenticated user. */
     credentialAccountRelativeUrl: string;
+    /** The relative URL (to the baseUrl) to parse a webhook payload. */
     webhookParsingRelativeUrl?: string | null;
+    /** The relative URL (to the baseUrl) to operate on webhook subscriptions. */
     webhookSubscriptionsRelativeUrl?: string | null;
+    /** The relative URL (to the baseUrl) to acknowledge a webhook reception. */
     webhookAcknowledgeRelativeUrl?: string | null;
+    /** The visibility of the integration. */
     visibility: 'private' | 'public';
+    /** The list of organization ids for which this integration is visibile. */
     unitoOrganizationIds: string[];
+    /** The UI-related information of the integration. */
     ui: {
+        /** The name of the integration, as it should be displayed in a UI. */
         displayName: string;
+        /** The logo of the integration, in SVG format. */
         logo: string | null;
     };
+    /** The encrypted secrets of the integration. */
     secrets?: {
         [key: string]: string;
     };
+    /** The date at which the integration has been disabled */
     disabledAt?: string | null;
 };
 export type Error = {
+    /** The message of the error. */
     message: string;
+    /** The details of the error. */
     details?: {
         [key: string]: any;
     };
+    /** The stack trace of the error. */
     stack?: string[];
 };
 export type AuthorizationMethod = 'custom' | 'oauth2';
 export type AuthorizationGrantType = 'authorization_code' | 'password';
 export type AuthorizationScope = {
+    /** The name of the scope. */
     name: string;
+    /** Message to the end-user to explain the usage of the scope by Unito. */
     help?: string;
 };
 export type AuthorizationOAuth2ContentType = 'application/x-www-form-urlencoded' | 'application/json';
 export type AuthorizationOAuth2RequestParameters = {
+    /** Extra information to include in the HTTP request headers. */
     header?: {
         [key: string]: string | number | boolean;
     };
+    /** Extra information to include in the HTTP request body. */
     body?: {
         [key: string]: string | number | boolean;
     };
 };
 export type AuthorizationOAuth2 = {
+    /** The Client Secret obtained from the provider. */
     clientSecret?: string;
+    /** The Client Id obtained from the provider. */
     clientId?: string;
+    /** The URL to grant or deny access to the user account. */
     authorizationUrl?: string;
+    /** The URL to obtain or refresh an access token. */
     tokenUrl: string;
     grantType: AuthorizationGrantType;
     scopes: AuthorizationScope[];
@@ -93,46 +120,71 @@ export type Authorization = Base & {
     method: AuthorizationMethod;
     oauth2: AuthorizationOAuth2;
     variables: AuthorizationVariables;
+    /** The Base64-encoded data URL of an <img> src content. For example: 'data:image/png;base64,<base64>' */
     instructionsImage?: string | null;
+    /** A string representing a markdown document. */
     instructionsMarkdown?: string | null;
 };
 export type Integration = IntegrationSummary & {
+    /** The authorizations of the integration. */
     authorizations: Authorization[];
+    /** The ids of the developers of the integration. */
     userIds: number[];
 };
 export type IntegrationEvent = {
+    /** The date at which the event took place. */
     date: string;
+    /** The text of the event. */
     text: string;
+    /** The tags associated with the event. */
     tags: string[];
+    /** The title of the event. */
     title: string;
 };
 export type Credential = Base & {
+    /** The id of the credential. */
     id: number;
+    /** The id of the integration. */
     integrationId: number;
+    /** The name of the integration. */
     integrationName: string;
+    /** The id of the authorization. */
     authorizationId: number;
+    /** The scope of the credential. */
     scope: 'development' | 'compliance' | 'production' | 'service';
+    /** The id of the Unito User for which this credential belongs to. */
     unitoUserId: string | null;
+    /** The payload of the credential, which conforms to the schema (ex. variables) of the authorization. */
     payload: {
         [key: string]: any;
     };
+    /** The partition used to divide data into different buckets. */
     partitionKey?: string | null;
 };
 export type UserRole = 'unitoAdministrator' | 'unitoService' | 'developer';
 export type UserSummary = Base & {
+    /** The id of the user. */
     id: number;
+    /** The email of the user. */
     email: string;
+    /** The ID of the organization which will have access to integrations created by this user. */
     defaultUnitoOrganizationId: string | null;
+    /** The date & time at which the user accepted the terms & conditions of the SDK. */
     termsAcceptedAt: string | null;
     role: UserRole;
 };
 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;
 };
 /**
@@ -140,12 +192,15 @@ export type CredentialAccount = {
  */
 export declare function getIntegrations({ pagination, unitoOrganizationId, search, }?: {
     pagination?: {
+        /** Number of 'first results' to skip */
         offset?: number;
+        /** Maximum number of results after the offset */
         limit?: number;
     };
     unitoOrganizationId?: string;
     search?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<Pagination & {
+    /** The integrations. */
     data: IntegrationSummary[];
 }>;
 /**
@@ -164,6 +219,7 @@ export declare function createIntegration(body?: {
  * Publish an integration
  */
 export declare function publishIntegration(body?: {
+    /** The archive of the integration, including the .unito.json file. */
     file: Blob;
 }, opts?: Oazapfts.RequestOpts): Promise<Integration>;
 /**
@@ -176,6 +232,12 @@ export declare function getIntegrationByName(integrationName: string, opts?: Oaz
 export declare function inviteUser(integrationId: number, body?: {
     email?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<Integration>;
+/**
+ * Invite a unito organization to an integration
+ */
+export declare function inviteOrganization(integrationId: number, body?: {
+    unitoOrganizationId?: string;
+}, opts?: Oazapfts.RequestOpts): Promise<Integration>;
 /**
  * Get an integration
  */
@@ -207,6 +269,7 @@ export declare function updateIntegration(integrationId: number, body?: {
     };
     visibility?: 'private' | 'public';
     unitoOrganizationIds?: string[];
+    /** The encrypted secrets of the integration. */
     secrets?: {
         [key: string]: string;
     };
@@ -219,6 +282,7 @@ export declare function deleteIntegration(integrationId: number, name: string, o
  * Get the events associated with this integration.
  */
 export declare function getIntegrationEvents(integrationId: number, opts?: Oazapfts.RequestOpts): Promise<Pagination & {
+    /** The integration events. */
     data: IntegrationEvent[];
 }>;
 /**
@@ -230,17 +294,25 @@ export declare function getIntegrationLogo(integrationName: string, opts?: Oazap
  */
 export declare function getCredentials({ pagination, filters, }?: {
     pagination?: {
+        /** Number of 'first results' to skip */
         offset?: number;
+        /** Maximum number of results after the offset */
         limit?: number;
     };
     filters?: {
+        /** The authorization id of the credential. */
         authorizationId?: number;
+        /** The integration id of the credential. */
         integrationId?: number;
+        /** The scope of the credential. */
         credentialScope?: 'development' | 'compliance' | 'production' | 'service';
+        /** The id of the Unito User for which this credential belongs to. */
         unitoUserId?: string;
+        /** The id of the credential account for which this credential belongs to. */
         credentialAccountId?: string;
     };
 }, opts?: Oazapfts.RequestOpts): Promise<Pagination & {
+    /** The credentials. */
     data: Credential[];
 }>;
 /**
@@ -374,10 +446,13 @@ export declare function deleteProxyGraph(xUnitoCredentialId: string, path: strin
  */
 export declare function getUsers({ pagination, }?: {
     pagination?: {
+        /** Number of 'first results' to skip */
         offset?: number;
+        /** Maximum number of results after the offset */
         limit?: number;
     };
 }, opts?: Oazapfts.RequestOpts): Promise<Pagination & {
+    /** The users. */
     data: UserSummary[];
 }>;
 /**
@@ -417,5 +492,5 @@ export declare function getHealthReady(opts?: Oazapfts.RequestOpts): Promise<nev
  * Whether the service is responsive
  */
 export declare function getHealthAlive(opts?: Oazapfts.RequestOpts): Promise<never>;
-import { HttpError } from 'oazapfts';
+import { HttpError } from './httpError.js';
 export { HttpError };