@viu/emporix-sdk 2.8.0 → 2.9.0

package/dist/types.gen-C_wOXYZB.d.cts

@@ -0,0 +1,455 @@
+type MetadataUpdate = {
+    /**
+     * Version of the document.
+     */
+    version?: number;
+    /**
+     * Links to the mixin schemas. A map where the keys represent mixins set attributes and the values represent url to a schema for a particular set.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+type Metadata = MetadataUpdate & {
+    /**
+     * Date and time when the document was created.
+     */
+    createdAt?: string;
+    /**
+     * Date and time when the document was last modified.
+     */
+    modifiedAt?: string;
+};
+type CustomerGroup = {
+    /**
+     * The unique identifier of the customer group.
+     */
+    id: string;
+    /**
+     * Localized name of a customer group.
+     */
+    name?: unknown;
+    /**
+     * The customer group role.
+     */
+    role?: string;
+};
+type ResourceId = {
+    /**
+     * Id of a resource.
+     */
+    id?: string;
+};
+type LegalEntity = {
+    /**
+     * The legal entity unique identifier.
+     */
+    id?: string;
+    /**
+     * The name of the legal entity.
+     */
+    name?: string;
+    /**
+     * The type of the legal entity.
+     */
+    type?: 'COMPANY' | 'SUBSIDIARY';
+    /**
+     * The id of the parent legal entity.
+     */
+    parentId?: string;
+    accountLimit?: AccountLimit;
+    legalInfo?: LegalInfo;
+    /**
+     * The list of customer groups assigned to the legal entity.
+     */
+    customerGroups?: Array<CustomerGroup>;
+    /**
+     * The list of locations assigned to the legal entity.
+     */
+    entitiesAddresses?: Array<Location>;
+    /**
+     * The list of customer assignment of the approval group of the legal entity.
+     */
+    approvalGroup?: Array<ContactAssignmentWithoutExpandedLegalEntity>;
+    restrictions?: Restrictions;
+    metadata?: Metadata;
+    /**
+     * Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+type AccountLimit = {
+    /**
+     * The account limit currency.
+     */
+    currency?: string;
+    /**
+     * The purchasing limit for account in the legal entity.
+     */
+    value?: number;
+};
+type LegalInfo = {
+    /**
+     * The legal name of the entity.
+     */
+    legalName?: string;
+    /**
+     * The registration date of the legal entity in the ISO 8601 format, e.g. 2020-04-30T04:00:00.000Z.
+     */
+    registrationDate?: string;
+    /**
+     * The tax registration number of the legal entity.
+     */
+    taxRegistrationNumber?: string;
+    /**
+     * The registration agency of the legal entity.
+     */
+    registrationAgency?: string;
+    /**
+     * The country in which the legal entity has been registered. The country needs to be defined and active in the Country Service.
+     */
+    countryOfRegistration?: string;
+    /**
+     * The unique identifier of the legal entity registration.
+     */
+    registrationId?: string;
+};
+/**
+ * List of restrictions which determine who can view or manage the Legal Entity.
+ */
+type Restrictions = Array<string> | null;
+type LegalEntityCreate = {
+    /**
+     * Custom legal entity identifier. If not provided, it is automatically generated.
+     */
+    id?: string;
+    /**
+     * The name of the legal entity.
+     */
+    name: string;
+    /**
+     * The type of the legal entity. Default value if not provided is: `COMPANY`
+     */
+    type?: 'COMPANY' | 'SUBSIDIARY';
+    /**
+     * The id of the parent legal entity.
+     */
+    parentId?: string;
+    accountLimit?: AccountLimit;
+    legalInfo?: LegalInfo;
+    /**
+     * The list of customer group IDs assigned to the legal entity.
+     */
+    customerGroups?: Array<CustomerGroup>;
+    /**
+     * The list of location IDs assigned to the legal entity.
+     */
+    entitiesAddresses?: Array<ResourceId>;
+    /**
+     * The list of customer assignment IDs of an approval group of the legal entity.
+     */
+    approvalGroup?: Array<ResourceId>;
+    restrictions?: Restrictions;
+    metadata?: MetadataCreate;
+    /**
+     * Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+type LegalEntityUpdate = {
+    /**
+     * The name of the legal entity.
+     */
+    name: string;
+    /**
+     * The type of the legal entity.
+     */
+    type: 'COMPANY' | 'SUBSIDIARY';
+    /**
+     * The id of the parent legal entity.
+     */
+    parentId?: string;
+    accountLimit?: AccountLimit;
+    legalInfo?: LegalInfo;
+    /**
+     * The list of customer group IDs assigned to the legal entity.
+     */
+    customerGroups?: Array<ResourceId>;
+    /**
+     * The list of location IDs assigned to the legal entity.
+     */
+    entitiesAddresses?: Array<ResourceId>;
+    /**
+     * The list of customer assignment IDs of an approval user group of the legal entity.
+     */
+    approvalGroup?: Array<ResourceId>;
+    restrictions?: Restrictions;
+    metadata?: MetadataUpdate;
+    /**
+     * Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+type Customer = {
+    /**
+     * The customer unique identifier.
+     */
+    id?: string;
+    /**
+     * The name of the customer.
+     */
+    name?: string;
+    /**
+     * The surname of the customer.
+     */
+    surname?: string;
+    /**
+     * The email of the customer.
+     */
+    email?: string;
+    /**
+     * The phone number of the customer.
+     */
+    phone?: string;
+};
+type ContactAssignment = {
+    /**
+     * The customer assignment unique identifier.
+     */
+    id?: string;
+    legalEntity?: LegalEntity;
+    customer?: Customer;
+    /**
+     * The type of the customer assignment.
+     */
+    type?: 'PRIMARY' | 'BILLING' | 'LOGISTICS' | 'CONTACT';
+    /**
+     * Indicates whether the customer is primary.
+     */
+    primary?: boolean;
+    metadata?: Metadata;
+    /**
+     * Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+type ContactAssignmentWithoutExpandedLegalEntity = {
+    /**
+     * The customer assignment unique identifier.
+     */
+    id?: string;
+    /**
+     * Assigned legal entity.
+     */
+    legalEntity?: {
+        /**
+         * The legal entity unique identifier.
+         */
+        id?: string;
+    };
+    customer?: Customer;
+    /**
+     * The type of the customer assignment.
+     */
+    type?: 'PRIMARY' | 'BILLING' | 'LOGISTICS' | 'CONTACT';
+    /**
+     * Indicates whether the customer is primary.
+     */
+    primary?: boolean;
+    metadata?: Metadata;
+};
+type ContactAssignmentCreate = {
+    /**
+     * Custom assignment identifier. If not provided, it is automatically generated.
+     */
+    id?: string;
+    /**
+     * The legal entity unique identifier.
+     */
+    legalEntity: {
+        /**
+         * The unique identifier of the legal entity.
+         */
+        id: string;
+    };
+    /**
+     * The customer unique identifier.
+     */
+    customer: {
+        /**
+         * The unique identifier of the customer.
+         */
+        id: string;
+    };
+    /**
+     * The type of the customer assignment. If not provided, it is set to `Contact` by default.
+     */
+    type?: 'PRIMARY' | 'BILLING' | 'LOGISTICS' | 'CONTACT';
+    /**
+     * Indicates whether the customer is primary.
+     */
+    primary?: boolean;
+    metadata?: MetadataCreate;
+    /**
+     * Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+type ContactAssignmentUpdate = {
+    /**
+     * The legal entity unique identifier.
+     */
+    legalEntity: {
+        /**
+         * The unique identifier of the legal entity.
+         */
+        id: string;
+    };
+    /**
+     * The customer unique identifier.
+     */
+    customer: {
+        /**
+         * The unique identifier of the customer.
+         */
+        id: string;
+    };
+    /**
+     * The type of the customer assignment.
+     */
+    type: 'PRIMARY' | 'BILLING' | 'LOGISTICS' | 'CONTACT';
+    /**
+     * Indicates whether the customer is primary.
+     */
+    primary?: boolean;
+    metadata?: MetadataUpdate;
+    /**
+     * Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+type Location = {
+    /**
+     * The location unique identifier.
+     */
+    id?: string;
+    /**
+     * The name of the location
+     */
+    name?: string;
+    /**
+     * The type of the location.
+     */
+    type?: 'HEADQUARTER' | 'WAREHOUSE' | 'OFFICE';
+    contactDetails?: ContactDetails;
+    metadata?: Metadata;
+    /**
+     * Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+type LocationCreate = {
+    /**
+     * Custom location identifier. If not provided, it is automatically generated.
+     */
+    id?: string;
+    /**
+     * The name of the location,
+     */
+    name?: string;
+    /**
+     * The type of the location.
+     */
+    type: 'HEADQUARTER' | 'WAREHOUSE' | 'OFFICE';
+    contactDetails: ContactDetails;
+    metadata?: MetadataCreate;
+    /**
+     * Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+type LocationUpdate = {
+    /**
+     * The name of the location
+     */
+    name?: string;
+    /**
+     * The type of the location.
+     */
+    type: 'HEADQUARTER' | 'WAREHOUSE' | 'OFFICE';
+    contactDetails: ContactDetails;
+    metadata?: MetadataUpdate;
+    /**
+     * Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+type ContactDetails = {
+    /**
+     * The list of contact emails.
+     */
+    emails?: Array<string>;
+    /**
+     * The list of contact phone numbers.
+     */
+    phones?: Array<string>;
+    /**
+     * The first address line of the contact.
+     */
+    addressLine1?: string;
+    /**
+     * The second address line of the contact.
+     */
+    addressLine2?: string;
+    /**
+     * The city of the contact.
+     */
+    city?: string;
+    /**
+     * The state of the contact.
+     */
+    state?: string;
+    /**
+     * The post code of the contact.
+     */
+    postcode?: string;
+    /**
+     * The country code of the contact.
+     */
+    countryCode?: string;
+    /**
+     * Allows to tag the location.
+     */
+    tags?: Array<string>;
+};
+/**
+ * Metadata request.
+ */
+type MetadataCreate = {
+    /**
+     * Links to the mixin schemas. A map where the keys represent mixins set attributes and the values represent url to a schema for a particular set.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+
+export type { AccountLimit as A, ContactAssignment as C, LegalEntity as L, ContactAssignmentCreate as a, ContactAssignmentUpdate as b, ContactDetails as c, CustomerGroup as d, LegalEntityCreate as e, LegalEntityUpdate as f, LegalInfo as g, Location as h, LocationCreate as i, LocationUpdate as j };