@raytio/types 7.3.0 → 8.1.0

package/dist/authz.d.ts

@@ -0,0 +1,4 @@
+/** Relation types used by the new authz tuple system */
+export type AuthzRelation = "viewer" | "editor" | "admin" | "owner" | "member";
+export type AuthzSubjectType = "user" | "group";
+export type AuthzObjectType = "dsm_node" | "dsm_access_application" | "dsm_access_application_instance" | "dsm_link" | "dsm_public_profile" | "far_customer" | "group";

package/dist/authz.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -5,3 +5,7 @@ export * from "./theme";
 export * from "./verification";
 export * from "./wizard";
 export * from "./orgs";
+export * from "./subscription";
+export * from "./merchant";
+export * from "./tenant";
+export * from "./authz";

package/dist/index.js

@@ -21,3 +21,7 @@ __exportStar(require("./theme"), exports);
 __exportStar(require("./verification"), exports);
 __exportStar(require("./wizard"), exports);
 __exportStar(require("./orgs"), exports);
+__exportStar(require("./subscription"), exports);
+__exportStar(require("./merchant"), exports);
+__exportStar(require("./tenant"), exports);
+__exportStar(require("./authz"), exports);

package/dist/merchant.d.ts

@@ -0,0 +1,20 @@
+import type { CommonFields, Json, MId, PRid } from "./raytio";
+export type MerchantTypeCode = "TYPE_1" | "TYPE_2";
+export type MerchantClassCode = "CLASS_1" | "CLASS_2";
+export type MerchantStatusCode = "ACTIVE" | "INACTIVE";
+export type MerchantApprovalStatusCode = "PENDING" | "APPROVED";
+export type Merchant = CommonFields<MId> & {
+    party_id: PRid;
+    merchant_name: string | null;
+    merchant_name_i18n: Json | null;
+    merchant_common_name: string | null;
+    merchant_common_name_i18n: Json | null;
+    merchant_description: string | null;
+    merchant_description_i18n: Json | null;
+    merchant_image_url_logo: string | null;
+    merchant_image_url_thumbnail: string | null;
+    merchant_type_code: MerchantTypeCode | null;
+    merchant_class_code: MerchantClassCode | null;
+    merchant_status_code: MerchantStatusCode | null;
+    merchant_approval_status_code: MerchantApprovalStatusCode | null;
+};

package/dist/merchant.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/orgs.d.ts

@@ -1,15 +1,70 @@
+import type { CId, CommonFields, LOCId, Lookup, OId, PCId, PRid, PermissionType, UId } from "./raytio";
 /** Types Used for Organization Related API Responses */
-/** An Organisation */
-export type Party = {
-    id: string;
-    start_date: string;
-    end_date: string;
-    active: boolean;
+/**
+ * An organization.
+ * NOTE: this is different to how the schema defines an Organization. **The schema is wrong (see #468)**
+ */
+export type Organization = {
+    id: CId;
+    orgId: OId;
+    name: string;
+    contact_point?: Pick<ContactPoint, "email_address" | "id">;
+    address?: unknown;
+    customerUsers: CustomerUser[];
+};
+/** @internal some APIs now return extra info. this is what gets passed around in the client.  */
+export type FullOrg = {
+    id: CId;
+    organization: Omit<Organization, "id">;
+    /** 🧙‍♂️ */
+    gandalf?: unknown;
+    stripe?: {
+        customer: unknown;
+    };
+    centrix_credentials?: unknown;
+};
+/** An organization/customer, directly returned by the API */
+export type Customer = CommonFields<CId> & {
+    customer_code: string;
+    party_id: PRid;
+    party_description: OId;
+    permission_type: PermissionType | null;
+    user_id: UId | null;
+    owner_email: string;
+    user_email: string;
+    prm_parties?: Party;
+};
+/** Organization Customer / User, Returned directly by the API */
+export type CustomerUser = CommonFields<CId> & {
+    customer_code: string;
+    party_id: PRid;
     party_name: string;
-    party_description: string;
+    party_description: OId;
+    owner_id: UId;
+    owner_email: string;
+    permission_type: PermissionType | null;
+    user_id: UId | null;
+    user_email: string | null;
+    group_name: string | null;
+};
+export type Party = CommonFields<PRid, PartyMetadata> & {
+    party_name: string;
+    party_description: OId;
     party_type: string;
-    metadata: PartyMetadata;
-    party_number: number;
+    party_image_url_logo: string | null;
+    far_customers: CommonFields<CId> & {
+        freight_term_code: string;
+        customer_type_code: string;
+        customer_class_code: string;
+        customer_status_code: string;
+        price_list_version_id: string | null;
+        customer_approval_status_code: string;
+        far_customers_customer_type_lookup: Lookup;
+        far_customers_freight_terms_lookup: Lookup;
+        far_customers_customer_class_lookup: Lookup;
+        far_customers_customer_status_lookup: Lookup;
+        far_customers_customer_approval_status_lookup: Lookup;
+    }[];
 };
 /** An Organizations credentials */
 export type PartyMetadata = {
@@ -20,26 +75,31 @@ export type PartyMetadata = {
     centrix_credentials: unknown;
 };
 /** An Organization Site */
-export type PartySite = {
-    id: string;
-    start_date: string;
-    end_date: string;
-    active: boolean;
-    party_id: string;
-    location_number: number;
+export type PartySite = CommonFields<never> & {
+    party_id: PRid;
+    location_id: number;
     party_site_name: string;
     party_site_description: string | null;
-    party_site_number: string | null;
     party_uses: string[];
     party_use_primary: string;
-    metadata: unknown;
+};
+export type CustomerSite = CommonFields<never> & {
+    org_id: OId;
+    party_site_id: string;
+    customer_site_code: string;
+    customer_site_status_code: string;
+};
+export type CustomerSiteUse = CommonFields<never> & {
+    org_id: OId;
+    customer_site_id: string;
+    customer_site_use_purpose_code: string;
+    customer_site_use_name: string;
+    freight_term_code: string | null;
+    payment_term_id: string;
+    price_list_version_id: string | null;
 };
 /** An Organization Location */
-export type Location = {
-    id: string;
-    start_date: string;
-    end_date: string;
-    active: boolean;
+export type Location = CommonFields<LOCId> & {
     location_name: string;
     location_description: string | null;
     address_line_1: string | null;
@@ -61,15 +121,10 @@ export type Location = {
     country: string | null;
     geolocation: string | null;
     geolocation_outline: string | null;
-    metadata: unknown;
 };
 /** A Contact Point for an Organization */
-export type ContactPoint = {
-    id: string;
-    start_date: string;
-    end_date: string;
-    active: boolean;
-    to_table: string;
+export type ContactPoint = CommonFields<PCId> & {
+    party_id: PRid;
     uuid: string | undefined;
     contact_point_purpose: string;
     contact_point_type: string;
@@ -80,5 +135,4 @@ export type ContactPoint = {
     url_type: string | null;
     email_address: string;
     email_address_preferred_format: string;
-    metadata: unknown;
 };

package/dist/raytio.d.ts

@@ -5,7 +5,7 @@ export type StringWithIdentity<T> = string & {
     $$typeof$$: T;
 };
 /** @internal */
-type Json = Record<string, any>;
+export type Json = Record<string, any>;
 /** A `p_id` is the ID of a {@link Relationship} */
 export type PId = StringWithIdentity<"PId">;
 /** An `i_id` is the ID of an {@link Instance} */
@@ -20,17 +20,65 @@ export type GId = StringWithIdentity<"GId">;
 export type UId = StringWithIdentity<"UId">;
 /** An `a_id` is the ID of an {@link AA} */
 export type AId = StringWithIdentity<"AId">;
-/** An `o_id` is the ID of an {@link Organization} */
+/** An `ao_id` is the ID of an {@link AAObject} */
+export type AOId = StringWithIdentity<"AOId">;
+/** A `aain_id` is the ID of an Instance Node */
+export type AINId = StringWithIdentity<"AINId">;
+/** A `aaink_id` is the ID of an Instance Node Key */
+export type AINKId = StringWithIdentity<"AINKId">;
+/** A `tnt_id` is the ID of a Tenant */
+export type TNTId = StringWithIdentity<"TNTId">;
+/**
+ * An `o_id` is the ID of an {@link Organization}
+ *
+ * NOTE: Will be deprecated soon. Use CId instead.
+ * */
 export type OId = StringWithIdentity<"OId">;
+/** A `pr_id` is the ID of a {@link Party} */
+export type PRid = StringWithIdentity<"PRid">;
+/** A `pc_id` is the ID of a Party Contact Point */
+export type PCId = StringWithIdentity<"PCId">;
 /** A `wi_id` is the ID of a {@link Webhook} */
 export type WId = StringWithIdentity<"WId">;
 /** An `l_id` is the ID of any data stored in the KV-Store */ export type LId = StringWithIdentity<"LId">;
 /** A `k_id` (also called a `aack_id` or a `publicKeyId`) is the ID of an AA's public key  */
 export type KId = StringWithIdentity<"KId">;
+/** A `pk_id` is the ID of an AA's private key  */
+export type PKId = StringWithIdentity<"PKId">;
+/** A `c_id` is the ID of a {@link Customer}, (will eventually replace org_id) */
+export type CId = StringWithIdentity<"CId">;
+/** A `t_id` is the ID of a transaction */
+export type TId = StringWithIdentity<"TId">;
+/** A `ws_id` is the ID of a transition */
+export type WSId = StringWithIdentity<"WSId">;
 /** A `SchemaName` is the ID of a {@link Schema} */
 export type SchemaName = StringWithIdentity<"SchemaName">;
+/** A `loc_id` is the ID of a location */
+export type LOCId = StringWithIdentity<"LOCId">;
+/** A `pl_id` is the ID of a PriceList */
+export type PLId = StringWithIdentity<"PLId">;
+/** A `prc_id` is the ID of a Price */
+export type PRCId = StringWithIdentity<"PRCId">;
+/** A `pll_id` is the ID of a PriceListLine/Plan */
+export type PLLId = StringWithIdentity<"PLLId">;
+/** A `s_id` is the ID of a Subscription */
+export type SId = StringWithIdentity<"SId">;
+/** A `sl_id` is the ID of a SubscriptionLine */
+export type SLId = StringWithIdentity<"SLId">;
+/** A `pm_id` is the ID of a PaymentMethod */
+export type PMId = StringWithIdentity<"PMId">;
+/** A `pt_id` is the ID of a PaymentProcessor */
+export type PTId = StringWithIdentity<"PTId">;
+/** A `m_id` is the ID of a Merchant */
+export type MId = StringWithIdentity<"MId">;
+/** A `gpm_id` is the ID of a Verification Type */
+export type GPMId = StringWithIdentity<"GPMId">;
+/** A `b_id` is the ID of a badge definition */
+export type BId = StringWithIdentity<"BId">;
+/** a `GroupName` is the unique name of a group, often used instead of {@link GId} */
+export type GroupName = StringWithIdentity<"GroupName">;
 export type DataTypes = "string" | "number" | "boolean" | "object" | "integer" | "array" | "null";
-export type SubmissionStatus = "Submitted" | "Processing" | "Rejected" | "Expired" | "Completed" | "DataChanged" | "Received" | "Accepted";
+export type SubmissionStatus = "Submitted" | "Processing" | "Rejected" | "Expired" | "Completed" | "DataChanged" | "Received" | "Pending" | "Accepted";
 /**
  * Every object in the new database has these fields. In the
  * interest of type-safety, the `id` should be one of the
@@ -51,7 +99,13 @@ export type CommonFields<IdType extends StringWithIdentity<string>, Metadata = u
     end_date: string;
     active: boolean;
     metadata: Metadata | undefined;
+    row_version?: number;
+    resource_group?: string;
+    resource_name?: string;
+    resource_url?: string;
+    tenant_id?: string;
 };
+export type PermissionType = "ADMINS" | "VIEWS" | "EDITS" | "OWNS";
 /** You can supply an option type argument if you know exactly what the properties will be */
 export type ProfileObject<Properties = Json> = Partial<CommonFields<NId2>> & {
     n_id: NId;
@@ -79,6 +133,7 @@ export type ProfileObjectForUpload<Properties = Json> = {
 export type UrnNodeType = "user" | "profile_object" | "instance" | "schema" | "temp_object" | "document";
 /** e.g. "urn:user:..." */
 export type Urn = `urn:user:${UId}` | `urn:profile_object:${NId}` | `urn:instance:${IId}` | `urn:temp_object:${LId}` | `urn:schema:${SchemaName}` | `urn:document:${NId}`;
+export type ContentUrl = `url:${string}`;
 export type Relationship = {
     start: Urn;
     end: Urn;
@@ -100,10 +155,12 @@ export type Lookup = {
     label?: string | number;
     children?: Lookup[];
     description?: string;
+    /** Icon source in format `icon:{AntDesignIconName}` (e.g., `icon:CameraOutlined`) */
+    image_src?: string;
     /** used in AkahuDynamicSection only */
     requires_2FA?: boolean;
 };
-export type AATag = "type:client_only" | "type:share_with_new_user" | `related_service_provider:n_id:${NId}` | "ServiceProvider";
+export type AATag = "type:client_only" | "type:share_with_new_user" | "Merchant";
 export type AA = {
     a_id: AId;
     name: string;
@@ -123,14 +180,19 @@ export type AA = {
         font?: CustomFonts;
         colors?: Colors;
     };
-    /** the n_id of the associated service provider */
+    /** @deprecated use merchant_id instead */
     service_provider_n_id?: NId;
     /** the id of the associated organization */
-    org_id: OId;
+    org_id?: OId;
+    customer_id: CId;
+    /** the id of the associated merchant (replaces service_provider_n_id) */
+    merchant_id?: MId;
     /** configuration for the submission rules */
     ruleset?: unknown;
     /** if true, only specific email addresses can submit the form */
     auth_list_enabled?: boolean;
+    /** Bot protection challenge type. If set, users must complete a challenge before accessing the wizard. */
+    client_challenge_type?: "turnstile" | null;
     /** Currently Unused Attributes */
     start_date?: Date;
     end_date?: Date;
@@ -139,9 +201,27 @@ export type AA = {
     logout_uri?: string[];
     metadata?: unknown;
     secret?: unknown;
-    /** @internal */
+    /** @internal fetched separately (see #1511)  */
     transitions?: unknown[];
 };
+export type AAObject = CommonFields<AOId> & {
+    aa_id: AId;
+    aai_id: IId;
+    properties: Json;
+    labels: string[];
+};
+export type InstanceNode = CommonFields<AINId> & {
+    aa_id: AId;
+    n_id: NId;
+    field_list: string[];
+};
+export type InstanceNodeKey = CommonFields<AINKId> & {
+    aa_id: AId;
+    aai_id: IId;
+    aain_id: AINId;
+    field_name: string;
+    key_data: string;
+};
 export type InstanceWithoutData = CommonFields<IId, {
     message?: string;
 }> & {
@@ -158,10 +238,10 @@ export type InstanceWithoutData = CommonFields<IId, {
     thread: string;
     /** The status of a submission */
     state: SubmissionStatus;
-    /** Hash of the Service Provider ID */
-    sub_service_provider_hash: string;
-    /** Service provider ID */
-    service_provider_n_id: NId;
+    /** Hash of the Merchant ID */
+    sub_merchant_hash: string;
+    /** Merchant ID (replaces service_provider_n_id) */
+    merchant_id: MId;
     /** added by the client once it calculates the score */
     score?: unknown;
     /** Previous status of the shared information */
@@ -194,28 +274,6 @@ export type Instance = InstanceWithoutData & {
     };
     relationships: Relationship[];
 };
-/**
- * An organization.
- * NOTE: this is different to how the schema defines an Organization. **The schema is wrong (see #468)**
- */
-export type Organization = {
-    id: OId;
-    name: string;
-    email: string;
-    address: unknown;
-    customer: unknown;
-};
-/** @internal some APIs now return extra info */
-export type FullOrg = {
-    id: OId;
-    organization: Omit<Organization, "id">;
-    /** 🧙‍♂️ */
-    gandalf: unknown;
-    stripe: {
-        customer: unknown;
-    };
-    centrix_credentials: unknown;
-};
 /** validation data returned by preVerify (part of the extract&map API) */
 export type Validation = {
     score: number;
@@ -232,38 +290,62 @@ export type Validation = {
         };
     };
 };
-export type WebhookStatus = "subscribed" | "pending" | "unsubscribe_failed";
-export type Webhook = {
-    wi_id: WId;
-    /** n_id of "the webhook provider which can be set up against a service provider" */
-    provider_webhook_id: NId;
-    /** not sure what this is */
-    provider_webhook_subscription_id: NId;
-    status: WebhookStatus;
-    /** ISO Date */
-    date_created: string;
-    /** ISO Date */
-    date_updated: string;
+export type WebhookStatus = "PENDING" | "SUBSCRIBED" | "UNSUBSCRIBED" | "UNSUBSCRIBE_FAILED" | "ERROR" | "ARCHIVED";
+export type Webhook = CommonFields<WId> & {
+    aa_id: AId;
+    webhook_processing_rules: unknown;
+    provider_subscription_credentials: unknown;
+    provider_signature_check_enabled: boolean;
+    provider_signature_credentials: unknown;
+    webhook_filter_source: string | null;
     webhook_filter_schema: {
         operator: string;
         field_value: string;
         field_name: string;
-    };
+    } | null;
     webhook_action: {
         webhook_action_type: string;
-    }[];
-    webhook_filter_source: string;
+    }[] | null;
     webhook_field_mapping_schema: {
         [key: string]: string;
-    };
-    webhook_processing_rules: unknown;
-    provider_subscription_credentials: unknown;
-    provider_signature_check_enabled: boolean;
-    provider_signature_credentials: unknown;
+    } | null;
+    provider_webhook_id: string;
+    provider_webhook_subscription_id: string | null;
     subscribe_log?: {
         date: string;
         response_status_code: number;
         response_payload: Json;
-    }[];
+    }[] | null;
+    status: WebhookStatus;
+    metadata: unknown;
+    wi_id?: WId;
+    date_created?: string;
+    date_updated?: string;
+};
+/**
+ * Link used for an Access Application, including all additional information
+ */
+export type Link = {
+    id: NId;
+    a_id: AId;
+    name: string;
+    subtitle: string;
+    code: LId;
+    url: string;
+    details?: AA;
+    isDefault?: boolean;
+};
+export type Permission = {
+    id: NId;
+    n_id: NId;
+    labels: string[];
+    properties: {
+        permissions: string;
+        provider_name: string;
+    };
+    user_permission_type: string | null;
+    group_permission_type: "VIEWS" | "EDITS" | null;
+    group_name: "ALL" | "Public" | `sharing|${UId}|${UId}` | GId;
+    is_owner: boolean;
+    permission_id: PId;
 };
-export {};