@raytio/types 7.2.0 → 8.0.0

package/dist/index.d.ts

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

package/dist/index.js

@@ -21,3 +21,5 @@ __exportStar(require("./theme"), exports);
 __exportStar(require("./verification"), exports);
 __exportStar(require("./wizard"), exports);
 __exportStar(require("./orgs"), exports);
+__exportStar(require("./subscription"), exports);
+__exportStar(require("./merchant"), 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

@@ -1,32 +1,101 @@
-import { Encrypted } from "./crypto";
-import { Colors, CustomFonts } from "./theme";
+import type { Encrypted } from "./crypto";
+import type { Colors, CustomFonts } from "./theme";
 /** @internal see Microsoft/TypeScript#202 */
 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} */
 export type IId = StringWithIdentity<"IId">;
 /** An `n_id` is the ID of a {@link ProfileObject} */
 export type NId = StringWithIdentity<"NId">;
+/** ⚠️ This ID duplicates the {@link NId} and should only be used in exceptional circumstances */
+export type NId2 = StringWithIdentity<"NId2">;
 /** A `g_id` is the ID of a group */
 export type GId = StringWithIdentity<"GId">;
 /** A `u_id` is the ID of a user */
 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 `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">;
 export type DataTypes = "string" | "number" | "boolean" | "object" | "integer" | "array" | "null";
 export type SubmissionStatus = "Submitted" | "Processing" | "Rejected" | "Expired" | "Completed" | "DataChanged" | "Received" | "Accepted";
+/**
+ * Every object in the new database has these fields. In the
+ * interest of type-safety, the `id` should be one of the
+ * well-known IDs that extend {@link StringWithIdentity} (e.g.
+ * {@link NId} or {@link AId}). If the ID is irrelevant, then
+ * use `CommonFields<never>` rather than `CommonFields<string>`.
+ * This will deliberately prevent you from utilising the `id`
+ * field until you define a special type for that ID.
+ *
+ * This is especially important with the new API where it is much
+ * easier to mix up the different types of IDs.
+ */
+export type CommonFields<IdType extends StringWithIdentity<string>, Metadata = unknown> = {
+    id: IdType;
+    /** ISO Date */
+    start_date: string;
+    /** ISO Date */
+    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> = {
+export type ProfileObject<Properties = Json> = Partial<CommonFields<NId2>> & {
     n_id: NId;
     properties: Properties;
     labels: string[];
@@ -46,12 +115,13 @@ export type ProfileObjectForUpload<Properties = Json> = {
         type?: string;
     };
     labels?: string[];
-    schema?: string;
+    schema?: SchemaName;
     n_id?: NId;
 };
 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:${string}` | `urn:document:${NId}`;
+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;
@@ -62,6 +132,9 @@ export type Relationship = {
         name?: string;
         [fieldName: string]: unknown;
     };
+    start_date?: string;
+    end_date?: string;
+    active?: boolean;
 };
 export type Lookup = {
     key: string | number;
@@ -96,7 +169,8 @@ export type AA = {
     /** the n_id of the associated service provider */
     service_provider_n_id?: NId;
     /** the id of the associated organization */
-    org_id: OId;
+    org_id?: OId;
+    customer_id: CId;
     /** configuration for the submission rules */
     ruleset?: unknown;
     /** if true, only specific email addresses can submit the form */
@@ -109,16 +183,16 @@ export type AA = {
     logout_uri?: string[];
     metadata?: unknown;
     secret?: unknown;
-    /** @internal */
+    /** @internal fetched separately (see #1511)  */
     transitions?: unknown[];
 };
-export type Instance = {
-    /** Access application instance ID */
-    i_id: IId;
+export type InstanceWithoutData = CommonFields<IId, {
+    message?: string;
+}> & {
     /** ID of the access application this submission was made to */
-    a_id: AId;
-    /** name of the access application this submission was made to */
-    aa_name: string;
+    aa_id: AId;
+    /** ID of the public key for this AA */
+    aack_id: KId;
     /** Code that validates information has been shared */
     confirmation_code: string;
     /** reference provided by the user who shared the data */
@@ -126,29 +200,12 @@ export type Instance = {
     /** Email of user who shared the data */
     data_provider_email: string;
     thread: string;
-    /** Latest date in which the shared information was available */
-    end_date: string;
-    /** Earliest date on which the shared information was available */
-    start_date: string;
     /** The status of a submission */
     state: SubmissionStatus;
-    /** @deprecated The status of a submission */
-    _state?: SubmissionStatus;
     /** Hash of the Service Provider ID */
-    sub_service_provider_hash?: string;
+    sub_service_provider_hash: string;
     /** Service provider ID */
-    service_provider_n_id?: NId;
-    /** data associated is access application's instance */
-    profile_objects: ProfileObject[];
-    keys: {
-        [nId: NId]: {
-            [fieldName: string]: {
-                data: string;
-                n_id: NId;
-            };
-        };
-    };
-    relationships?: Relationship[];
+    service_provider_n_id: NId;
     /** added by the client once it calculates the score */
     score?: unknown;
     /** Previous status of the shared information */
@@ -165,34 +222,21 @@ export type Instance = {
     platform_footer_html?: unknown;
     /** Related Service Types */
     related_service_types?: unknown;
-    /** Activity Status */
-    active?: boolean;
-    /** Key (Can be used to retrieve instance) */
-    aack_id?: string;
-    /** Metadata */
-    metadata?: unknown;
 };
 /**
- * An organization.
- * NOTE: this is different to how the schema defines an Organization. **The schema is wrong (see #468)**
+ * The API used to store data in this format, but it no
+ * longer does :( so `@raytio/core` reconstructs this object.
  */
-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;
+export type Instance = InstanceWithoutData & {
+    profile_objects: ProfileObject[];
+    keys: {
+        [nId2: NId2]: {
+            [fieldName: string]: {
+                data: string;
+            };
+        };
     };
-    centrix_credentials: unknown;
+    relationships: Relationship[];
 };
 /** validation data returned by preVerify (part of the extract&map API) */
 export type Validation = {
@@ -244,4 +288,16 @@ export type Webhook = {
         response_payload: Json;
     }[];
 };
-export {};
+/**
+ * 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;
+};

package/dist/schema.d.ts

@@ -1,5 +1,6 @@
-import { AA, DataTypes, Organization, Urn } from "./raytio";
-import { WizardConfig } from "./wizard";
+import type { AA, DataTypes, SchemaName, Urn } from "./raytio";
+import type { Organization } from "./orgs";
+import type { WizardConfig } from "./wizard";
 /** should be renamed since this applies to ConditionallyVerifiable */
 export type ConditionallyRequired = {
     field: string;
@@ -7,8 +8,8 @@ export type ConditionallyRequired = {
         [fieldName: string]: (string | number | boolean)[];
     };
 };
-export type SchemaFieldTag = "password" | `group:${string}` | `upload-group:${string}` | "display:stars" | "display:no_autofill" | "display:currency" | "display:cascade" | "display:survey" | "display:quoting" | "display:customModal" | `display:replace:'${string}':'${string}'` | "display:terms_conditions" | `display:main_media:${string}` | "date_component:day" | "date_component:month" | "date_component:year" | "action:client_upload" | "action:require_webauthn" | "verify:show_if_pending" | "special:hide_select_behind_button" | "type:capture_geolocation" | "type:extract_required";
-export type SchemaTag = "action:experimental_pass_object_store_id" | "action:verify" | "default_camera:rear" | "default_camera:front" | `oauth2_component:name:${string}` | `oauth2_component:redirect_url:${string}` | `time:${string}:${number}` | `link_to:${string}:${string}` | "type:service_provider" | "type:service_offer" | "type:marketplace" | "type:client_only" | "type:globally_unique_field";
+export type SchemaFieldTag = "password" | `group:${string}` | `upload-group:${string}` | "display:stars" | "display:no_autofill" | "display:currency" | "display:cascade" | "display:survey" | "display:quoting" | "display:customModal" | "display:mask" | `display:replace:('${string}', '${string}')` | "display:terms_conditions" | `display:main_media:${string}` | "date_component:day" | "date_component:month" | "date_component:year" | "action:allow_copy" | "action:allow_unreplace" | "action:allow_password_compromise_check" | "action:client_upload" | "action:hash" | "action:require_webauthn" | `action:generate_pepper:` | "verify:show_if_pending" | "special:hide_select_behind_button" | "type:capture_geolocation" | "type:extract_required";
+export type SchemaTag = "action:experimental_pass_object_store_id" | "action:verify" | `action:display_qr_code:${string}:${string}` | "default_camera:rear" | "default_camera:front" | `oauth2_component:name:${string}` | `oauth2_component:redirect_url:${string}` | `time:${string}:${number}` | `link_to:${string}:${string}` | "display:default_view:edit" | "type:service_provider" | "type:service_offer" | "type:marketplace" | "type:client_only" | "type:globally_unique_field";
 export type SchemaField = {
     /** @deprecated don't use, it's inconsistent */
     $id?: string;
@@ -41,6 +42,20 @@ export type SchemaField = {
     format?: "date" | "date-time" | "uri";
     contentMediaType?: string;
     contentEncoding?: "base64";
+    /**
+     * if this field is a foreign key, i.e. it is a primary key
+     * of a different schema, then that other's schema name should be listed here.
+     * e.g.
+     * ```json
+     * {
+     *   "name": "ss_AA",
+     *   "properties": {
+     *     "org_id": { "foreign_key_of": "ss_Org" }
+     *   }
+     * }
+     * ```
+     */
+    foreign_key_of?: SchemaName;
     /** `items` is used for nested arrays, (while `properties` is used for nested objects) */
     items?: {
         type: DataTypes;
@@ -53,7 +68,7 @@ export type SchemaField = {
         [subFieldName: string]: SchemaField;
     };
     /** If this field refers to a sub-object */
-    $ref?: string;
+    $ref?: SchemaName;
     /**
      * @internal
      * the client adds this for conditional properties, see #329
@@ -79,6 +94,10 @@ export type SchemaField = {
     description_decorator?: "md";
     /** if a `pattern` is specified, this is the error message */
     patternMessage?: string;
+    /** the input string for a platform_unique_id */
+    hash_inputs?: string;
+    /** determines where an image is sourced from */
+    content_source?: string;
     override?: {
         permissions: {
             /**
@@ -175,9 +194,9 @@ export type CommonSchemaAttributes = {
         /** if required_relationship then use will be alerted in relationship menu and won't be able to share PO unless filled out */
         required_relationship?: boolean;
         /** Specify `oneOf` XOR `anyOf`. It's a list of schema names, or `"instance"` (see #784) */
-        oneOf?: string[];
+        oneOf?: (SchemaName | "instance")[];
         /** Specify `oneOf` XOR `anyOf` It's a list of schema names. */
-        anyOf?: string[];
+        anyOf?: SchemaName[];
         /** assume TRUE if not specified */
         multiple?: boolean;
         /** these are arbitary fields on the relationship */
@@ -212,12 +231,25 @@ export type CommonSchemaAttributes = {
             fields: string[];
             label: string;
         }[];
+        /**
+         * By default, the admin dashboard shows columns for all fields
+         * in listed in `head_main`. In rare cases you can use this property
+         * to specify a different set of fields to show to admins by default.
+         */
+        tabular?: {
+            fields: string[];
+        };
+        /**
+         * determines if profile pages should display using compacted 'MiniPO'
+         * view or deafult view
+         */
+        compact_table?: boolean;
     };
     /** only the schema used for the onboarding wizard have this property */
     onboard_properties?: {
         /** Profile Objects that should be created */
         profile_objects?: {
-            schema_name: string;
+            schema_name: SchemaName;
             properties: Record<string, unknown>;
         }[];
         /** Relationships that should be created */
@@ -254,7 +286,7 @@ export type CommonSchemaAttributes = {
  */
 export type Schema = CommonSchemaAttributes & {
     /** added by the client, copied from {@link WrappedSchema} */
-    name: string;
+    name: SchemaName;
     /** added by client */
     type?: DataTypes;
     /** the localized title of the `schema_group`. added by the client */
@@ -273,6 +305,16 @@ export type Schema = CommonSchemaAttributes & {
     properties: {
         [fieldName: string]: SchemaField;
     };
+    /**
+     * Some schema's represent data that is not stored as a profile object.
+     * In this case, this attribute defines what database table we need to use
+     * to fetch the corresponding data, and which field is the primary_key of that
+     * table (e.g. `id`, `o_id` etc.)
+     */
+    database?: {
+        table: string;
+        primary_key: string;
+    };
     /** the client adds this after processing the i18n property */
     groupNames?: Record<string, string>;
     /** added by the client to inform downstream components which locale from schema.i18n was used */
@@ -299,7 +341,7 @@ export type WrappedSchema = {
     /** ISO Date. If this tag exists, the schema is deprecated. */
     end_date: string;
     /** Schema Name Type and Version Properties */
-    schema_name: string;
+    schema_name: SchemaName;
     schema_type: SchemaType;
     schema_version: string;
     /** whether the \`version\` is the latest version */

package/dist/subscription.d.ts

@@ -0,0 +1,89 @@
+import type { CId, CommonFields, PLId, PLLId, PMId, PRCId, PRid, PTId, SId, SLId } from "./raytio";
+export type PriceList = {
+    id: PLId;
+    price_list_type: string;
+    price_list_currency: string;
+    price_list_name: string;
+    price_list_name_i18n?: string;
+    price_list_description?: string;
+    price_list_description_i18n?: string;
+    pcm_price_list_versions?: [
+        {
+            id: string;
+            price_list_version_name: string;
+            pcm_price_list_lines: PriceListLine[];
+        }
+    ];
+};
+export type PriceListLine = {
+    id: PLLId;
+    pcm_prices: {
+        id: PRCId;
+        amount: number;
+        gpm_items: {
+            id: string;
+            item_key: string;
+            item_name: string;
+            primary_uom: string;
+            item_name_i18n: string | null;
+            item_description: string;
+            item_description_i18n: string | null;
+        };
+        price_currency: string;
+        billing_recurrence: string;
+        recurring_billing_scheme: string;
+        recurring_billing_interval: string | null;
+        recurring_billing_usage_type: string;
+        recurring_billing_interval_count: number;
+    };
+};
+export type Subscription = CommonFields<SId> & {
+    subscribed_to_customer_id: string;
+    subscribed_to_customer_site_id: string | null;
+    subscribed_to_party_contact_point_id: string;
+    billing_cycle_month: number | null;
+    billing_cycle_day_of_month: number | null;
+    billing_cycle_day_of_week: number | null;
+    billing_cycle_hour: number | null;
+    billing_cycle_minute: number | null;
+    billing_cycle_second: number | null;
+    subscription_name: string;
+    subscription_name_i18n: string | null;
+    current_billing_period_start: string;
+    current_billing_period_end: string | null;
+    cancellation_request_date: string | null;
+    cancellation_effective_date: string | null;
+    cancellation_request_reason: string | null;
+    cancellation_final_invoice_action: string;
+};
+export type SubscriptionLine = CommonFields<SLId> & {
+    billing_subscription_id: SId;
+    price_id: PRCId;
+    subscribed_qty: number;
+    metadata: string | null;
+};
+export type PaymentMethod = CommonFields<PMId> & {
+    customer_id: CId;
+    payer_payment_method_type: string;
+    primary_payment_method: boolean;
+    payment_processor_id: string;
+    payment_method_country_code: string | null;
+    payment_method_scheme: string;
+    payment_method_available_networks: string[] | string;
+    payment_method_preferred_network?: string | null;
+    card_expiry_month: number;
+    card_expiry_year: number;
+    card_funding_method: string;
+    card_last_4_digits: string;
+    card_fingerprint?: string | null;
+    payment_processor_payment_method_id: string;
+    address_line1_check?: string | null;
+    address_postal_code_check?: string | null;
+    cvc_check?: string | null;
+    three_d_secure_usage?: string | null;
+};
+export type PaymentProcessor = CommonFields<PTId> & {
+    party_id: PRid;
+    payment_processor_name: string;
+    payment_processor_system: string;
+};

package/dist/subscription.js

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