@silexpert/core 0.4.43 → 0.4.46

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

@@ -0,0 +1,83 @@
+export interface DiscountApplication {
+
+  /**
+     *  The method by which the discount application value has been allocated to entitled lines.
+     *
+     *  Valid values:
+     *   * across: The value is spread across all entitled lines.
+     *   * each: The value is applied onto every entitled line.
+     *   * one: The value is applied onto a single line.
+     */
+  allocation_method: 'across' | 'each' | 'one';
+
+  /**
+     *  The discount code that was used to apply the discount.
+     *
+     *  Available only for discount code applications.
+     *
+     *  (only exists if type === "discount_code")
+     */
+  code?: string;
+
+  /**
+     *  The description of the discount application, as defined by the merchant or the Shopify Script.
+     *  (can be null)
+     *
+     *  Available only for manual and script discount applications.
+     *
+     *  (only exists if type === "manual" || type === "script")
+     */
+  description?: string | null;
+
+  /**
+     *  The lines on the order, of the type defined by target_type, that the discount is allocated over.
+     *
+     *  Valid values:
+     *   * all: The discount is allocated onto all lines.
+     *   * entitled: The discount is allocated only onto lines it is entitled for.
+     *   * explicit: The discount is allocated only onto explicitly selected lines.
+     */
+  target_selection: 'all' | 'entitled' | 'explicit';
+
+  /**
+     *  The type of line on the order that the discount is applicable on.
+     *
+     *  Valid values:
+     *   * line_item: The discount applies to line items.
+     *   * shipping_line: The discount applies to shipping lines.
+     */
+  target_type: 'line_item' | 'shipping_line';
+
+  /**
+     *  The title of the discount application, as defined by the merchant.
+     *
+     *  Available only for manual discount applications.
+     *
+     * (only exists if type === "manual")
+     */
+  title?: string;
+
+  /**
+     *  The discount_applications property includes 3 types: discount_code, manual, and script.
+     *
+     *  All 3 types share a common structure and have some type specific attributes.
+     */
+  type: 'discount_code' | 'manual' | 'script';
+
+  /**
+     *  The value of the discount application as a decimal.
+     *
+     *  This represents the intention of the discount application.
+     *  For example, if the intent was to apply a 20% discount, then the value will be "20.0". If the intent was to apply a $15 discount, then the value will be "15.0"
+     */
+  value: string;
+
+  /**
+     *  The type of the value. Valid values:
+     *
+     *   * fixed_amount: A fixed amount discount value in the currency of the order.
+     *   * percentage: A percentage discount value.
+     */
+  value_type: 'fixed_amount' | 'percentage';
+
+}

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

@@ -0,0 +1,18 @@
+import { ShopifyObject } from './base';
+
+export interface DiscountCode extends ShopifyObject {
+  /**
+     *  The amount of the discount.
+     */
+  amount?: string;
+
+  /**
+     *  The discount code.
+     */
+  code?: string;
+
+  /**
+     *  The type of discount. Known values are 'percentage', 'shipping', 'fixed_amount' and 'none'.
+     */
+  type?: 'percentage' | 'shipping' | 'fixed_amount' | string;
+}

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

@@ -0,0 +1,110 @@
+import { ShopifyObject } from './base';
+import { LineItem } from './line_item';
+
+export interface Fulfillment extends ShopifyObject {
+  /**
+     * The ID for the fulfillment
+     */
+  id: number;
+
+  /**
+     * The date and time when the fulfillment was created.
+     */
+  created_at: string;
+
+  /**
+     * A historical record of each item in the fulfillment.
+     */
+  line_items: LineItem[];
+
+  /**
+     * The unique identifier of the location that the fulfillment should be processed for. In order to find the ID of the location, use the Location API.
+     */
+  location_id: number;
+
+  /**
+     * The uniquely identifying fulfillment name, consisting of two parts separated by a '.'. The first part represents the order name and the second part represents the fulfillment number. The fulfillment number automatically increments depending on how many fulfillments are in an order (e.g. #1001.1, #1001.2).
+     */
+  name: string;
+
+  /**
+     * Whether the customer should be notified. If set to true, then an email will be sent when the fulfillment is created or updated. For orders that were initially created using the API, the default value is false. For all other orders, the default value is true.
+     *
+     * (does not exist on any order of a production store that I tested; might be a parameter that is only passed to POST method but is not retrieved on GET)
+     */
+  notify_customer?: boolean;
+
+  /**
+     * The unique numeric identifier for the order.
+     */
+  order_id: number;
+
+  /**
+     * An arbitrary object without defined interface (the Shopify documentation is wrong)
+     */
+  receipt: any;
+
+  /**
+     * The type of service used.
+     */
+  service: string;
+
+  /**
+     * The current shipment status for the order. Valid values:
+     *  * null
+     *  * "confirmed"
+     *  * "in_transit"
+     *  * "out_of_delivery"
+     *  * "delivered"
+     *  * "failure"
+     *
+     * (can be null)
+     */
+  shipment_status: null | 'confirmed' | 'in_transit' | 'out_of_delivery' | 'delivered' | 'failure';
+
+  /**
+     * The status of the fulfillment. Valid values:
+     */
+  status: 'pending' | 'open' | 'success' | 'cancelled' | 'error' | 'failure';
+
+  /**
+     * The name of the tracking company.
+     *
+     * (can be null)
+     */
+  tracking_company: null | string;
+
+  /**
+     * The shipping number, provided by the shipping company. If multiple tracking numbers
+     * exist, returns the first number. If none, null.
+     */
+  tracking_number: string | null;
+
+  /**
+     * A list of shipping numbers, provided by the shipping company. May be empty.
+     */
+  tracking_numbers: string[];
+
+  /**
+     * The tracking url, provided by the shipping company. May be null. If multiple tracking URLs
+     * exist, returns the first URL.
+     */
+  tracking_url: string | null;
+
+  /**
+     * An array of one or more tracking urls, provided by the shipping company. May be null.
+     */
+  tracking_urls: string[];
+
+  /**
+     * The date and time when the fulfillment was last modified.
+     */
+  updated_at: string;
+
+  /**
+     * The name of the inventory management service.
+     *
+     * (can be undefined)
+     */
+  variant_inventory_management?: string;
+}

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

@@ -0,0 +1,153 @@
+import { TaxLine } from './tax_line';
+import { ShopifyObject } from './base';
+import { LineItemProperty } from './line_item_property';
+import { DiscountAllocation } from './discount_allocation';
+import { Location } from './location';
+import { PriceSet } from './price_set';
+
+export interface LineItem extends ShopifyObject {
+  /**
+   * does not always exist
+   */
+  destination_location?: Location;
+
+  /**
+   *  An ordered list of amounts allocated by discount applications. Each discount allocation is associated to a particular discount application.
+   */
+  discount_allocations: DiscountAllocation[];
+
+  /**
+   *  The amount available to fulfill. This is the quantity - max(refunded_quantity, fulfilled_quantity) - pending_fulfilled_quantity.
+   */
+  fulfillable_quantity: number;
+
+  /**
+   *  Service provider who is doing the fulfillment. Valid values are either "manual" or the name of the provider. eg: "amazon", "shipwire", etc.
+   */
+  fulfillment_service: string;
+
+  /**
+   *  The fulfillment status of this line item. Known values are 'fulfilled', 'null' and 'partial'.
+   */
+  fulfillment_status: string;
+
+  /**
+   *  States whether the order used a gift card.
+   */
+  gift_card: boolean;
+
+  /**
+   *  The weight of the item in grams.
+   */
+  grams: number;
+
+  /**
+   *  The name of the product variant.
+   */
+  name: string;
+
+  /**
+   * does not always exist
+   */
+  origin_location?: Location;
+
+  /**
+   *  The price of the item before taxes have been applied.
+   */
+  pre_tax_price: string;
+
+  /**
+   *  The pre-tax price of the item in shop and presentment currencies.
+   *  (BETA)
+   */
+  pre_tax_price_set: PriceSet;
+
+  /**
+   *  The price of the item before discounts have been applied.
+   */
+  price: string | number;
+
+  /**
+   * TODO: what does this mean?
+   */
+  product_exists: boolean;
+
+  /**
+   *  The price of the item in shop and presentment currencies.
+   *  (BETA)
+   */
+  price_set: PriceSet;
+
+  /**
+   * The unique numeric identifier for the product in the fulfillment. Can be null if the original product associated with the order is deleted at a later date
+   */
+  product_id: number;
+
+  /**
+   *  An array of custom information for an item that has been added to the cart.
+   *  Often used to provide product customization options.
+   *  An array of <see cref="ShopifyTaxLine"/> objects, each of which details the taxes applicable to this <see cref="ShopifyLineItem"/>.
+   */
+  properties: LineItemProperty[];
+
+  /**
+   *  The number of products that were purchased.
+   */
+  quantity: number;
+
+  /**
+   *  States whether or not the fulfillment requires shipping.
+   */
+  requires_shipping: boolean;
+
+  /**
+   *  A unique identifier of the item in the fulfillment.
+   */
+  sku: string;
+
+  /**
+   *  States whether or not the product was taxable.
+   */
+  taxable: boolean;
+
+  /**
+   *  An array of <see cref="ShopifyTaxLine"/> objects, each of which details the taxes applicable to this <see cref="ShopifyLineItem"/>.
+   */
+  tax_lines: TaxLine[];
+
+  /**
+   *  The title of the product.
+   */
+  title: string;
+
+  /**
+   *  The total discount amount applied to this line item. This value is not subtracted in the line item price.
+   */
+  total_discount: string;
+
+  /**
+   *  The total discount amount applied to this line item in shop and presentment currencies.
+   *  (BETA)
+   */
+  total_discount_set: PriceSet;
+
+  /**
+   *  The id of the product variant. Can be null if the product purchased is not a variant.
+   */
+  variant_id: number;
+
+  /**
+   *  TODO: What is this? (known values: "shopify", null)
+   */
+  variant_inventory_management: null | string;
+
+  /**
+   *  The title of the product variant. Can be null if the product purchased is not a variant.
+   */
+  variant_title: string;
+
+  /**
+   *  The name of the supplier of the item.
+   */
+  vendor: string;
+}

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

@@ -0,0 +1,13 @@
+import { ShopifyObject } from './base';
+
+export interface LineItemProperty extends ShopifyObject {
+  /**
+     * The name of the note attribute.
+     */
+  name?: string;
+
+  /**
+     * The value of the note attribute.
+     */
+  value?: any;
+}

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

@@ -0,0 +1,69 @@
+import { ShopifyObject } from './base';
+
+export interface Location extends ShopifyObject {
+  /**
+     * The first line of the address.
+     */
+  address1?: string;
+
+  /**
+     * The second line of the address.
+     */
+  address2?: string;
+
+  /**
+     * The city the location is in.
+     */
+  city?: string;
+
+  /**
+     * The country the location is in.
+     */
+  country?: string;
+
+  /**
+     * The two-letter code (ISO 3166-1 alpha-2 format) corresponding to country the location is in.
+     */
+  country_code?: string;
+
+  /**
+     * The date and time (ISO 8601 format) when the location was created.
+     */
+  created_at?: string;
+
+  /**
+     * Whether this is a fulfillment service location. If true, then the location is a fulfillment service location.
+     * If false, then the location was created by the merchant and isn't tied to a fulfillment service.
+     */
+  legacy?: string;
+
+  /**
+     * The name of the location.
+     */
+  name?: string;
+
+  /**
+     * The phone number of the location. This value can contain special characters like - and +.
+     */
+  phone?: string;
+
+  /**
+     * The province the location is in.
+     */
+  province?: string;
+
+  /**
+     * The two-letter code corresponding to province or state the location is in.
+     */
+  province_code?: string;
+
+  /**
+     * The date and time (ISO 8601 format) when the location was last updated.
+     */
+  updated_at?: string
+
+  /**
+     * The zip or postal code.
+     */
+  zip?: string
+}

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

@@ -0,0 +1,11 @@
+export interface NoteAttribute {
+  /**
+     * The name of the note attribute.
+     */
+  name: string;
+
+  /**
+     * The value of the note attribute.
+     */
+  value: string | number;
+}

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

@@ -0,0 +1,13 @@
+import { ShopifyObject } from './base';
+
+export interface PaymentDetails extends ShopifyObject {
+  avs_result_code?: string;
+
+  credit_card_bin?: string;
+
+  cvv_result_code?: string;
+
+  credit_card_number?: string;
+
+  credit_card_company?: string;
+}

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

@@ -0,0 +1,10 @@
+export interface PriceSet {
+  shop_money: {
+    amount: string;
+    currency_code: string;
+  },
+  presentment_money: {
+    amount: string;
+    currency_code: string;
+  }
+}

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

@@ -0,0 +1,142 @@
+import { ShopifyObject } from './base';
+import { Transaction } from './transaction';
+import { LineItem } from './line_item';
+import { PriceSet } from './price_set';
+
+export interface Refund extends ShopifyObject {
+  admin_graphql_api_id: string;
+  /**
+     *  The date and time (ISO 8601 format) when the refund was created.
+     */
+  created_at: string;
+  /**
+     *  The unique identifier for the refund.
+     */
+  id: number;
+  /**
+     *  An optional note attached to a refund.
+     */
+  note: string | null;
+  /**
+     *  A list of order adjustments attached to the refund.
+     */
+  order_adjustments: OrderAdjustment[];
+  /**
+     *  The unique identifier for the order the refund belongs to.
+     */
+  order_id: number;
+  /**
+     *  The date and time (ISO 8601 format) when the refund was imported. This value can be set to a date in the past when importing from other systems. If no value is provided, then it will be auto-generated as the current time in Shopify.
+     */
+  processed_at: string;
+  /**
+     *  A list of refunded line items.
+     */
+  refund_line_items: RefundLineItem[];
+  /**
+     *  Whether to add the line items back to the store's inventory.
+     *  DEPRECATED: Provide a restock_type (on individual `refund_line_item` objects) to influence how this refund affects inventory instead.
+     */
+  restock: boolean;
+  /**
+     *  A list of transactions involved in the refund. For more information, see the Transaction resource.
+     */
+  transactions: Transaction[];
+  /**
+     *  The unique identifier of the user who performed the refund.
+     */
+  user_id: number | null;
+}
+
+export interface RefundLineItem {
+  /**
+     *  The unique identifier of the line item in the refund.
+     */
+  id: number;
+  /**
+     *  The ID of the related line item in the order.
+     */
+  line_item_id: number;
+  /**
+     *  The related line item in the order (exactly identical)
+     */
+  line_item: LineItem;
+  /**
+     *  The unique identifier of the location where the items will be restocked.
+     *  Required when restock_type has the value return or cancel.
+     */
+  location_id: number;
+  /**
+     *  The quantity of the associated line item that was returned.
+     */
+  quantity: number;
+  /**
+     *  How this refund line item affects inventory levels. Valid values:
+     *   * no_restock: Refunding these items won't affect inventory. The number of fulfillable units for this line item will remain unchanged. For example, a refund payment can be issued but no items will be returned or made available for sale again.
+     *   * cancel: The items have not yet been fulfilled. The canceled quantity will be added back to the available count. The number of fulfillable units for this line item will decrease.
+     *   * return: The items were already delivered, and will be returned to the merchant. The returned quantity will be added back to the available count. The number of fulfillable units for this line item will remain unchanged.
+     *   * legacy_restock: The deprecated restock property was used for this refund. These items were made available for sale again. This value is not accepted when creating new refunds.
+     */
+  restock_type: string;
+  /**
+     *  The subtotal of the refund line item
+     *  Attention: This field has type 'number', whereas most other money values have type 'string'
+     */
+  subtotal: number;
+  /**
+     *  The subtotal of the refund line item, in shop and presentment currencies
+     *  (BETA)
+     */
+  subtotal_set: PriceSet;
+  /**
+     *  The total tax on the refund line item.
+     */
+  total_tax: number;
+  /**
+     *  The total tax on the refund line item, in shop and presentment currencies
+     *  (BETA)
+     */
+  total_tax_set: PriceSet;
+}
+
+export interface OrderAdjustment extends ShopifyObject {
+  /**
+     * The value of the discrepancy between the calculated refund and the actual refund.
+     * If the kind property's value is shipping_refund, then amount returns the value of shipping charges refunded to the customer.
+     */
+  amount: string;
+  /**
+     * The amount of the order adjustment in shop and presentment currencies.
+     * (BETA)
+     */
+  amount_set: PriceSet;
+  /**
+     *  The unique identifier for the order adjustment.
+     */
+  id: number;
+  /**
+     *  The order adjustment type. Valid values: shipping_refund and refund_discrepancy
+     */
+  kind: string;
+  /**
+     *  The unique identifier for the order that the order adjustment is associated with.
+     */
+  order_id: number;
+  /**
+     *  The reason for the order adjustment. To set this value, include `discrepancy_reason` when you create a refund.
+     */
+  reason: string;
+  /**
+     *  The unique identifier for the refund that the order adjustment is associated with.
+     */
+  refund_id: number;
+  /**
+     *  The taxes that are added to amount, such as applicable shipping taxes added to a shipping refund.
+     */
+  tax_amount: string;
+  /**
+     *  The tax amount of the order adjustment in shop and presentment currencies.
+     *  (BETA)
+     */
+  tax_amount_set: PriceSet;
+}

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

@@ -0,0 +1,71 @@
+import { DiscountAllocation } from './discount_allocation';
+import { PriceSet } from './price_set';
+import { TaxLine } from './tax_line';
+import { ShopifyObject } from './base';
+
+export interface ShippingLine extends ShopifyObject {
+
+  /**
+     * TODO: What is this?
+     */
+  carrier_identifier: string | null;
+
+  /**
+     * A reference to the shipping method.
+     */
+  code: string;
+
+  /**
+     * not documented
+     */
+  delivery_category: null | any;
+
+  /**
+     * not documented
+     */
+  discount_allocations: DiscountAllocation[],
+
+  /**
+     * not documented
+     */
+  discounted_price: string,
+
+  /**
+     * The price of the shipping method after discounts in shop and presentment currencies.
+     */
+  discounted_price_set: PriceSet,
+
+  /**
+     * not documented
+     */
+  phone: string | null,
+  /**
+     * The price of this shipping method.
+     */
+  price: string,
+
+  /**
+     * The price of the shipping method in shop and presentment currencies.
+     */
+  price_set: PriceSet,
+
+  /**
+     * undocumented (always null in available test data)
+     */
+  requested_fulfillment_service_id: null | any;
+
+  /**
+     * The source of the shipping method.
+     */
+  source: string;
+
+  /**
+     * The title of the shipping method.
+     */
+  title: string;
+
+  /**
+     * A list of <see cref="ShopifyTaxLine"/> objects, each of which details the taxes applicable to this <see cref="ShopifyShippingLine"/>.
+     */
+  tax_lines: TaxLine[];
+}