@silexpert/core 2.0.126 → 2.0.127-beta.0

package/ts/types/Interface/api/shopify/ShopifyOrder.ts

@@ -1,436 +0,0 @@
-import { Address } from './address.js';
-import { ShopifyObject } from './base.js';
-import { ClientDetails } from './client_details.js';
-import { Customer } from './customer.js';
-import { DiscountApplication } from './discount_application.js';
-import { DiscountCode } from './discount_code.js';
-import { Fulfillment } from './fulfillment.js';
-import { LineItem } from './line_item.js';
-import { NoteAttribute } from './note_attribute.js';
-import { PaymentDetails } from './payment_details.js';
-import { PriceSet } from './price_set.js';
-import { Refund } from './refund.js';
-import { ShippingLine } from './shipping_line.js';
-import { FinancialStatus } from './ShopifyFinancialStatus.js';
-import { TaxLine } from './tax_line.js';
-
-export interface ShopifyOrder extends ShopifyObject {
-  /**
-   * The ID of the app that created the order.
-   * @readonly
-   */
-  app_id: number;
-
-  /**
-   * The mailing address associated with the payment method. This address is an optional field that will not be available on orders that do not require one.
-   */
-  billing_address?: Address;
-
-  /**
-   * The IP address of the browser used by the customer when placing the order.
-   * @readonly
-   */
-  browser_ip: null | string;
-
-  /**
-   * Indicates whether or not the person who placed the order would like to receive email updates from the shop.
-   * This is set when checking the "I want to receive occasional emails about new products, promotions and other news" checkbox during checkout.
-   */
-  buyer_accepts_marketing: boolean;
-
-  /**
-   * The reason why the order was cancelled. If the order was not cancelled, this value is `null`. Known values are `customer`, `fraud`, `inventory` and `other`.
-   */
-  cancel_reason: null | string;
-
-  /**
-   * The date and time when the order was cancelled. If the order was not cancelled, this value is `null`.
-   * @readonly
-   */
-  cancelled_at: null | string;
-
-  /**
-   * Unique identifier for a particular cart that is attached to a particular order.
-   * @readonly
-   */
-  cart_token: null | string;
-
-  /**
-   * TODO - what is this?
-   */
-  checkout_id: null | number;
-
-  /**
-   * TODO - what is this?
-   */
-  checkout_token: null | string;
-
-  /**
-   * Information about the browser that the customer used when they placed their order:
-   *
-   * * **accept_language**: The languages and locales that the browser understands.
-   * * **browser_height**: The browser screen height in pixels, if available.
-   * * **browser_ip**: The browser IP address.
-   * * **browser_width**: The browser screen width in pixels, if available.
-   * * **session_hash**: A hash of the session.
-   * * **user_agent**: Details of the browsing client, including software and operating versions.
-   *
-   * @example
-   * "client_details": {
-   *   "accept_language": "en-US,en;q=0.9",
-   *   "browser_height": 1320,
-   *   "browser_ip": "216.191.105.146",
-   *   "browser_width": 1280,
-   *   "session_hash": "9ad4d1f4e6a8977b9dd98eed1e477643",
-   *   "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36"
-   * }
-   * @readonly
-   */
-  client_details?: ClientDetails;
-
-  /**
-   * The date and time when the order was closed. If the order was not clsoed, this value is null.
-   * @readonly
-   */
-  closed_at: string | null;
-
-  /**
-   * TODO - what is this?
-   */
-  confirmed: boolean;
-
-  /**
-   * The customer's contact email address.
-   * @note Can' be used to create an order, instead use `order: { customer: {email: "..." }}`
-   */
-  contact_email: string | null;
-
-  /**
-   * The date and time when the order was created in Shopify.
-   * @readonly
-   */
-  created_at: string;
-
-  /**
-   * The three letter code (ISO 4217) for the currency used for the payment.
-   */
-  currency: string;
-
-  /**
-   * A <see cref="ShopifyCustomer"/> object containing information about the customer. This value may be null if the order was created through Shopify POS.
-   */
-  customer?: Customer;
-
-  /**
-   * Locale string, i.e. 'de', 'en', or null
-   * @readonly
-   */
-  customer_locale: null | string;
-
-  /**
-   * An ordered list of stacked discount applications.
-   * @readonly
-   */
-  discount_applications: DiscountApplication[];
-
-  /**
-   * Applicable discount codes that can be applied to the order.
-   */
-  discount_codes: DiscountCode[];
-
-  /**
-   * The order's email address. Note?: On and after 2015-11-03, you should be using <see cref="ContactEmail"/> to refer to the customer's email address.
-   * Between 2015-11-03 and 2015-12-03, updates to an order's email will also update the customer's email. This is temporary so apps can be migrated over to
-   * doing customer updates rather than order updates to change the contact email. After 2015-12-03, updating updating an order's email will no longer update
-   * the customer's email and apps will have to use the customer update endpoint to do so.
-   */
-  email: string;
-
-  /**
-   * The financial status of an order. Known values are "authorized", "paid", "pending", "partially_paid", "partially_refunded", "refunded" and "voided".
-   */
-  financial_status: FinancialStatus;
-
-  /**
-   * An array of <see cref="ShopifyFulfillment"/> objects for this order.
-   */
-  fulfillments: Fulfillment[];
-
-  /**
-   * The fulfillment status for this order. Known values are 'fulfilled', 'partial' or null.
-   */
-  // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
-  fulfillment_status: 'fulfilled' | 'partial' | string | null;
-
-  /**
-   * The payment gateway used.
-   * @deprecated Use Transaction resource instead
-   */
-  gateway: string | null;
-
-  /**
-   * The URL for the page where the buyer landed when entering the shop.
-   * (can be `null`)
-   * @readonly
-   */
-  landing_site: string | null;
-
-  /**
-   * TODO: What is this? Probably landing_site referrer? (always null in available test data)
-   * (can be `null`)
-   * @readonly
-   */
-  landing_site_ref: string | null;
-
-  /**
-   * An array of <see cref="ShopifyLineItem"/> objects, each one containing information about an item in the order.
-   * @required
-   */
-  line_items: LineItem[];
-
-  /**
-   * The ID of the physical location where the order was processed.
-   */
-  location_id: number | null;
-
-  /**
-   * The customer's order name as represented by a number, e.g. `#1001`.
-   * @readonly
-   */
-  name: string;
-
-  /**
-   * The text of an optional note that a shop owner can attach to the order.
-   */
-  note: null | string;
-
-  /**
-   * Extra information that is added to the order.
-   */
-  note_attributes: NoteAttribute[];
-
-  /**
-   * Numerical identifier unique to the shop. A number is sequential and starts at 1000.
-   * @readonly
-   */
-  number: number;
-
-  /**
-   * A unique numeric identifier for the order. This one is used by the shop owner and customer.
-   * This is different from the id property, which is also a unique numeric identifier for the order, but used for API purposes.
-   * @readonly
-   */
-  order_number: number;
-
-  /**
-   * URL to see the order status
-   * @readonly
-   */
-  order_status_url: string;
-
-  /**
-   * Payment details for this order. May be null or undefined if the order was created via API without payment details.
-   * @deprecated Use the Transaction resource instead)
-   */
-  payment_details?: PaymentDetails | null;
-
-  /**
-   * The list of payment gateways used for the order.
-   * @readonly
-   */
-  payment_gateway_names: string[];
-
-  /**
-   * The customer's phone number.
-   */
-  phone: string;
-
-  /**
-   * The presentment currency that was used to display prices to the customer.
-   */
-  presentment_currency: string;
-
-  /**
-   * The date that the order was processed at.
-   */
-  processed_at: string;
-
-  /**
-   * The type of payment processing method. Known values are `checkout`, `direct`, `manual`, `offsite`, `express`, `free` and `none`.
-   * @readonly
-   */
-  processing_method: string;
-
-  /**
-   * The website that the customer clicked on to come to the shop.
-   */
-  referring_site: null | string;
-
-  /**
-   * A reference string (8-4-4-4-12 uppercase hexadecimal digits), not documented, can be `null`
-   */
-  reference: null | string;
-
-  /**
-   * A list of refunds applied to the order. For more information, see [the Refund API](https://help.shopify.com/en/api/reference/orders/refund).
-   * @example
-   * "refunds": [
-   *   {
-   *     "id": 18423447608,
-   *     "order_id": 394481795128,
-   *     "created_at": "2018-03-06T09:35:37-05:00",
-   *     "note": null,
-   *     "user_id": null,
-   *     "processed_at": "2018-03-06T09:35:37-05:00",
-   *     "refund_line_items": [],
-   *     "transactions": [],
-   *     "order_adjustments": []
-   *   }
-   * ]
-   * @readonly
-   */
-  refunds: Refund[];
-
-  /**
-   * The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require one.
-   */
-  shipping_address?: Address;
-
-  /**
-   * An array of <see cref="ShopifyShippingLine"/> objects, each of which details the shipping methods used.
-   */
-  shipping_lines: ShippingLine[];
-
-  /**
-   * undocumented string, which seems to be of the format `${location_id}-${POS_DEVICE_ID}-${POS_ORDER_NUMBER}` for POS orders, where `POS_DEVICE_ID` is an id associated with the device and `POS_ORDER_NUMBER` is counted up for each separate device
-   * (can be `null`)
-   */
-  source_identifier: string | null;
-
-  /**
-   * Where the order originated. May only be set during creation, and is not writeable thereafter.
-   * Orders created via the API may be assigned any string of your choice except for `web`, `pos`, `iphone`, and `android`.
-   * Default is `api`.
-   */
-  source_name: string;
-
-  /**
-   * not documented; always null in test data
-   */
-  // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
-  source_url?: null | any;
-
-  /**
-   * Price of the order before shipping and taxes
-   */
-  subtotal_price: string;
-
-  /**
-   * Price of the order before shipping and taxes, in shop and presentment currencies
-   * (BETA)
-   */
-  subtotal_price_set: PriceSet;
-
-  /**
-   * Tags are additional short descriptors, commonly used for filtering and searching, formatted as a string of comma-separated values.
-   */
-  tags: string;
-
-  /**
-   * An array of <see cref="ShopifyTaxLine"/> objects, each of which details the total taxes applicable to the order.
-   */
-  tax_lines: TaxLine[];
-
-  /**
-   * States whether or not taxes are included in the order subtotal.
-   */
-  taxes_included: boolean;
-
-  /**
-   * whether this is a test order
-   */
-  test: boolean;
-
-  /**
-   * Unique identifier for a particular order.
-   * @readonly
-   */
-  token: string;
-
-  /**
-   * The total amount of the discounts applied to the price of the order.
-   */
-  total_discounts: string;
-
-  /**
-   * The total amount of the discounts applied to the price of the order, in shop and presentment currencies.
-   * @beta
-   */
-  total_discounts_set: PriceSet;
-
-  /**
-   * The sum of all the prices of all the items in the order.
-   */
-  total_line_items_price: string;
-
-  /**
-   * The sum of all the prices of all the items in the order, in shop and presentment currencies.
-   * (BETA)
-   */
-  total_line_items_price_set: PriceSet;
-
-  /**
-   * The sum of all the prices of all the items in the order, with taxes and discounts included (must be positive).
-   */
-  total_price: string;
-
-  /**
-   * The sum of all the prices of all the items in the order, in shop and presentment currencies, with taxes and discounts included (must be positive).
-   * (BETA)
-   */
-  total_price_set: PriceSet;
-
-  /**
-   * The sum of all the shipping prices in the order, in shop and presentment currencies, with taxes and discounts included (must be positive).
-   * (BETA)
-   */
-  total_shipping_price_set: PriceSet;
-
-  /**
-   * The sum of all the prices of all the items in the order, in USD, with taxes and discounts included (must be positive).
-   */
-  total_price_usd: string;
-
-  /**
-   * The sum of all the taxes applied to the order (must be positive).
-   */
-  total_tax: string;
-
-  /**
-   * The sum of all the taxes applied to the order, in shop and presentment currencies (must be positive).
-   * (BETA)
-   */
-  total_tax_set: PriceSet;
-
-  /**
-   * The sum of all the tips in the order.
-   */
-  total_tip_received: string;
-
-  /**
-   * The sum of all the weights of the line items in the order, in grams.
-   */
-  total_weight: number | null;
-
-  /**
-   * The date and time when the order was last modified.
-   * @readonly
-   */
-  updated_at: string;
-
-  /**
-   * POS device user id for POS sales, or Shopify staff user id for draft orders
-   * null if not applicable
-   */
-  user_id: number | null;
-}

package/ts/types/Interface/api/shopify/address.ts

@@ -1,88 +0,0 @@
-import { ShopifyObject } from './base.js';
-
-export interface Address extends ShopifyObject {
-  /**
-   * The mailing address.
-   */
-  address1?: string;
-
-  /**
-   * An additional field for the mailing address.
-   */
-  address2?: string;
-
-  /**
-   * The city.
-   */
-  city?: string;
-
-  /**
-   * The company.
-   */
-  company?: string;
-
-  /**
-   * The country.
-   */
-  country?: string;
-
-  /**
-   * The two-letter country code corresponding to the country.
-   */
-  country_code?: string;
-
-  /**
-   * The normalized country name.
-   */
-  country_name?: string;
-
-  /**
-   * Indicates whether this address is the default address.
-   */
-  default?: boolean;
-
-  /**
-   * The first name.
-   */
-  first_name?: string;
-
-  /**
-   * The last name.
-   */
-  last_name?: string;
-
-  /**
-   * The latitude of the address.
-   */
-  latitude?: number;
-
-  /**
-   * The longitude of the address.
-   */
-  longitude?: number;
-
-  /**
-   * The name.
-   */
-  name?: string;
-
-  /**
-   * The phone number.
-   */
-  phone?: string;
-
-  /**
-   * The province or state name
-   */
-  province?: string;
-
-  /**
-   * The two-letter province or state code.
-   */
-  province_code?: string;
-
-  /**
-   * The ZIP or postal code.
-   */
-  zip?: string;
-}

package/ts/types/Interface/api/shopify/base.ts

@@ -1,10 +0,0 @@
-export interface ShopifyObject {
-  /**
-   * The object's unique id.
-   */
-  id: number;
-  /**
-   * To help with migrating from our REST to the GraphQL, REST responses now include the GraphQL Admin API ID field, admin_graphql_api_id,. The ID in this field can be used to query the object directly using the GraphQL Admin API.
-   */
-  admin_graphql_api_id: string;
-}

package/ts/types/Interface/api/shopify/client_details.ts

@@ -1,33 +0,0 @@
-import { ShopifyObject } from './base.js';
-
-export interface ClientDetails extends ShopifyObject {
-  /**
-   * Shopify does not offer documentation for this field.
-   */
-  accept_language: string | null;
-
-  /**
-   *  The browser screen height in pixels, if available.
-   */
-  browser_height: number | null;
-
-  /**
-   *  The browser IP address.
-   */
-  browser_ip: string;
-
-  /**
-   *  The browser screen width in pixels, if available.
-   */
-  browser_width: number | null;
-
-  /**
-   *  A hash of the session.
-   */
-  session_hash: string | null;
-
-  /**
-   *  The browser's user agent string.
-   */
-  user_agent: string;
-}

package/ts/types/Interface/api/shopify/customer.ts

@@ -1,124 +0,0 @@
-import { Address } from './address.js';
-import { ShopifyObject } from './base.js';
-
-export interface Customer extends ShopifyObject {
-  id: number;
-  admin_graphql_api_id: string;
-  /**
-   * Indicates whether the customer has consented to be sent marketing material via email.
-   */
-  accepts_marketing: boolean;
-
-  /**
-   * A list of addresses for the customer.
-   */
-  addresses?: Address[];
-
-  /**
-   * The date and time when the customer was created.
-   */
-  created_at: string;
-
-  /**
-   * The three-letter code (ISO 4217 format) for the currency that the customer used when they paid for their last order. Defaults to the shop currency. Returns the shop currency for test orders.
-   * (BETA)
-   */
-  currency: string;
-
-  /**
-   * The default address for the customer.
-   */
-  default_address: Address;
-
-  /**
-   * The email address of the customer.
-   */
-  email: string | null;
-
-  /**
-   * The customer's first name.
-   */
-  first_name: string | null;
-
-  /**
-   * The customer's last name.
-   */
-  last_name: string | null;
-
-  /**
-   * The customer's first and last names.
-   */
-  name: string | null;
-
-  /**
-   * The id of the customer's last order.
-   */
-  last_order_id: number;
-
-  /**
-   * The name of the customer's last order. This is directly related to the Order's name field.
-   */
-  last_order_name: string;
-
-  /**
-   * The customer's identifier used with Multipass login
-   */
-  multipass_identifier: string | null;
-
-  /**
-   * A note about the customer.
-   */
-  note: string | null;
-
-  /**
-   * The number of orders associated with this customer.
-   */
-  orders_count: number | null;
-
-  /**
-   * The number of orders associated with this customer.
-   */
-  phone: string | null;
-
-  /**
-   * The state of the customer in a shop. Known values are 'disabled', 'decline', 'invited' and 'enabled'.
-   */
-  state: string;
-
-  /**
-   * Tags are additional short descriptors formatted as a string of comma-separated values.
-   */
-  tags: string;
-
-  /**
-   * Indicates whether the customer should be charged taxes when placing orders.
-   */
-  tax_exempt: boolean;
-
-  /**
-   * The total amount of money that the customer has spent at the shop. Note: the Shopify API may return this as a string value.
-   */
-  total_spent: string;
-
-  /**
-   * The date and time when the customer information was updated.
-   */
-  updated_at: string;
-
-  /**
-   * States whether or not the email address has been verified.
-   */
-  verified_email: boolean;
-}
-
-export interface CustomerInvite {
-  to?: string;
-
-  from?: string;
-
-  bcc?: string[];
-
-  subject?: string;
-
-  custom_message?: string;
-}

package/ts/types/Interface/api/shopify/discount_allocation.ts

@@ -1,19 +0,0 @@
-import { PriceSet } from './price_set.js';
-
-export interface DiscountAllocation {
-  /**
-   *  The discount amount allocated to the line.
-   */
-  amount: number;
-
-  /**
-   *  The discount amount allocated to the line item in shop and presentment currencies.
-   *  (BETA)
-   */
-  amount_set: PriceSet;
-
-  /**
-   *  The index of the associated discount application in the order's discount_applications list.
-   */
-  discount_application_index: number;
-}