falsify 0.1.0

data/lib/falsify/models/customer/customer.rb

@@ -0,0 +1,114 @@
+require "enumerize"
+
+module Falsify
+  # See the [API documentation](https://help.shopify.com/en/api/reference/customers/customer).
+  class Customer
+    extend Enumerize
+    # Whether the customer has consented to receive marketing material via email.
+    # @return [Boolean]
+    attr_accessor :accepts_marketing
+    # The date and time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when the customer consented or objected to receiving marketing material by email.
+    # Set this value whenever the customer consents or objects to marketing materials.
+    # @return [String]
+    attr_accessor :accepts_marketing_updated_at
+    # A list of the ten most recently updated addresses for the customer.
+    # @return [Array<Address>]
+    attr_accessor :addresses
+    # The three-letter code ([ISO 4217](https://en.wikipedia.org/wiki/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.
+    # @return [String]
+    attr_reader :currency
+    # The date and time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when the customer was created.
+    # @return [String]
+    attr_reader :created_at
+    # The default address for the customer.
+    # The default address has the following properties:
+    # @return [Address]
+    attr_reader :default_address
+    # The unique email address of the customer.
+    # Attempting to assign the same email address to multiple customers returns an error.
+    # @return [String]
+    attr_accessor :email
+    # The customer's first name.
+    # @return [String]
+    attr_accessor :first_name
+    # A unique identifier for the customer.
+    # @return [String]
+    attr_accessor :id
+    # The customer's last name.
+    # @return [String]
+    attr_accessor :last_name
+    # The ID of the customer's last order.
+    # @return [String]
+    attr_reader :last_order_id
+    # The name of the customer's last order.
+    # This is directly related to the `name` field on the Order resource.
+    # @return [String]
+    attr_reader :last_order_name
+    # Attaches additional metadata to a shop's resources.
+    # @return [Metafield]
+    attr_accessor :metafield
+    # @!attribute marketing_opt_in_level [r]
+    #   The marketing subscription opt-in level (as described by [the M<sup>3</sup>AAWG best practices guideline](https://www.m3aawg.org/sites/maawg/files/news/M3AAWG_Senders_BCP_Ver3-2015-02.pdf)) that the customer gave when they consented to receive marketing material by email.
+    #   If the customer does not accept email marketing, then this property will be set to `null`.
+    #   Valid values:
+    #   - `single_opt_in`
+    #   - `confirmed_opt_in`
+    #   - `unknown`
+    #   @return [:single_opt_in, :confirmed_opt_in, :unknown, nil]
+    enumerize :marketing_opt_in_level, in: [:single_opt_in, :confirmed_opt_in, :unknown]
+    # A unique identifier for the customer that's used with [Multipass login](https://help.shopify.com/en/api/reference/plus/multipass).
+    # @return [String]
+    attr_accessor :multipass_identifier
+    # A note about the customer.
+    # @return [String]
+    attr_accessor :note
+    # The number of orders associated with this customer.
+    # @return [String]
+    attr_reader :orders_count
+    # The unique phone number ([E.164 format](https://en.wikipedia.org/wiki/E.164)) for this customer.
+    # Attempting to assign the same phone number to multiple customers returns an error.
+    # The property can be set using different formats, but each format must represent a number that can be dialed from anywhere in the world.
+    # The following formats are all valid:
+    # - 6135551212
+    # - +16135551212
+    # - (613)555-1212
+    # - +1 613-555-1212
+    # @return [String]
+    attr_accessor :phone
+    # @!attribute state [r]
+    #   The state of the customer's account with a shop.
+    #   Default value: `disabled`.
+    #   Valid values:
+    #   - `disabled` - The customer doesn't have an active account. Customer accounts can be disabled from the Shopify admin at any time.
+    #   - `invited` - The customer has received an email invite to create an account.
+    #   - `enabled` - The customer has created an account.
+    #   - `declined` - The customer declined the email invite to create an account.
+    #   @return [String]
+    enumerize :state, in: [:disabled, :invited, :enabled, :declined], default: :disabled
+    # Tags that the shop owner has attached to the customer, formatted as a string of comma-separated values.
+    # A customer can have up to 250 tags.
+    # Each tag can have up to 255 characters.
+    # @return [String]
+    attr_accessor :tags
+    # Whether the customer is exempt from paying taxes on their order.
+    # If `true`, then taxes won't be applied to an order at checkout.
+    # If `false`, then taxes will be applied at checkout.
+    # @return [Boolean]
+    attr_accessor :tax_exempt
+    # Whether the customer is exempt from paying specific taxes on their order.
+    # Canadian taxes only.
+    # @return [String]
+    attr_accessor :tax_exemptions
+    # The total amount of money that the customer has spent across their order history.
+    # @return [String]
+    attr_reader :total_spent
+    # The date and time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when the customer information was last updated.
+    # @return [String]
+    attr_reader :updated_at
+    # Whether the customer has verified their email address.
+    # @return [Boolean]
+    attr_reader :verified_email
+  end
+end

data/lib/falsify/models/customer/metafield.rb

@@ -0,0 +1,36 @@
+module Falsify
+  # Attaches additional metadata to a shop's resources
+  class Metafield
+    # An identifier for the metafield (maximum of 30 characters, required)
+    # @return [Boolean]
+    attr_accessor :key
+    # A container for a set of metadata (maximum of 20 characters, required)
+    # Namespaces help distinguish between metadata that you created and metadata created by another individual with a similar namespace.
+    # @return [String]
+    attr_accessor :namespace
+    # Information to be stored as metadata (required)
+    # @return [String,Integer]
+    attr_accessor :value
+    # The value type (required)
+    # Valid values: `string` and `integer`.
+    # @return [String]
+    attr_accessor :value_type
+    # Additional information about the metafield (optional)
+    # @return [String,nil]
+    attr_accessor :description
+
+    # @param key [String]
+    # @param namespace [String]
+    # @param value [String,Integer]
+    # @param value_type [String]
+    # @param description [String]
+    # @return [void]
+    def initialize(key:, namespace:, value:, value_type:, description: nil)
+      self.key = key
+      self.namespace = namespace
+      self.value = value
+      self.value_type = value_type
+      self.description = description
+    end
+  end
+end

data/lib/falsify/models/fulfillment/fulfillment.rb

@@ -0,0 +1,96 @@
+require "enumerize"
+
+module Falsify
+  # In Shopify, a fulfillment represents a shipment of one or more items in an order.
+  # You can use the Fulfillment resource to view, create, modify, or delete an order's fulfillments.
+  # See the [API documentation](https://help.shopify.com/en/api/reference/shipping-and-fulfillment/fulfillment).
+  class Fulfillment
+    extend Enumerize
+    # The date and time when the fulfillment was created.
+    # The API returns this value in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+    # @return [String]
+    attr_accessor :created_at
+    # The ID for the fulfillment.
+    # @return [String]
+    attr_accessor :id
+    # A historical record of each item in the fulfillment.
+    # @return [Array<LineItem>]
+    attr_accessor :line_items
+    # The unique identifier of the location that the fulfillment should be processed for.
+    # To find the ID of the location, use the [Location resource](https://help.shopify.com/en/api/reference/inventory/location).
+    # @return [String]
+    attr_accessor :location_id
+    # 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`).
+    # @return [String]
+    attr_accessor :name
+    # 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`.
+    # @return [Boolean]
+    attr_accessor :notify_customer
+    # The unique numeric identifier for the order.
+    # @return [String]
+    attr_accessor :order_id
+    # A text field that provides information about the receipt:
+    # - **testcase** : Whether the fulfillment was a testcase.
+    # - **authorization** : The authorization code.
+    # @return [String]
+    attr_accessor :receipt
+    # The type of service used.
+    # @return [Hash]
+    attr_accessor :service
+    # @!attribute shipment_status [rw]
+    #   The current shipment status of the fulfillment.
+    #   Valid values:
+    #   - `label_printed` - A label for the shipment was purchased and printed.
+    #   - `label_purchased` - A label for the shipment was purchased, but not printed.
+    #   - `attempted_delivery` - Delivery of the shipment was attempted, but unable to be completed.
+    #   - `ready_for_pickup` - The shipment is ready for pickup at a shipping depot.
+    #   - `confirmed` - The carrier is aware of the shipment, but hasn't received it yet.
+    #   - `in_transit` - The shipment is being transported between shipping facilities on the way to its destination.
+    #   - `out_for_delivery` - The shipment is being delivered to its final destination.
+    #   - `delivered` - The shipment was succesfully delivered.
+    #   - `failure` - Something went wrong when pulling tracking information for the shipment, such as the tracking number was invalid or the shipment was canceled.
+    #   @return [:label_printed, :label_purchased, :attempted_delivery, :ready_for_pickup, :confirmed, :in_transit, :out_for_delivery, :delivered, :failure]
+    enumerize :shipment_status, in: [:label_printed, :label_purchased, :attempted_delivery, :ready_for_pickup, :confirmed, :in_transit, :out_for_delivery, :delivered, :failure]
+    # @!attribute status [rw]
+    #   The status of the fulfillment.
+    #   Valid values:
+    #   - `pending` - The fulfillment is pending.
+    #   - `open` - The fulfillment has been acknowledged by the service and is in processing.
+    #   - `success` - The fulfillment was successful.
+    #   - `cancelled` - The fulfillment was cancelled.
+    #   - `error` - There was an error with the fulfillment request.
+    #   - `failure` - The fulfillment request failed.
+    #   @return [:pending, :open, :success, :cancelled, :error, :failure]
+    enumerize :status, in: [:pending, :open, :success, :cancelled, :error, :failure]
+    # The name of the tracking company.
+    # When creating a fulfillment for a supported carrier, send the `tracking_company` exactly as written in the list above.
+    # If the tracking company doesn't match one of the supported entries, then the shipping status might not be updated properly during the fulfillment process.
+    # @return [String]
+    attr_accessor :tracking_company
+    # A list of tracking numbers, provided by the shipping company.
+    #
+    # It is highly recommended that you send the tracking company and the tracking URL as well.
+    # If neither one of these is sent, then the tracking company will be determined automatically.
+    # This can result in an invalid tracking URL.
+    #
+    # The tracking URL is displayed in the shipping confirmation email, which can optionally be sent to the customer.
+    # When accounts are enabled, it is also displayed in the customer's order history.
+    #
+    # @return [Array<String>]
+    attr_accessor :tracking_numbers
+    # The URLs of tracking pages for the fulfillment.
+    # @return [Array<String>]
+    attr_accessor :tracking_urls
+    # The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the fulfillment was last modified..
+    # @return [String]
+    attr_accessor :updated_at
+    # The name of the inventory management service.
+    # @return [String]
+    attr_accessor :variant_inventory_management
+  end
+end

data/lib/falsify/models/fulfillment/fulfillment_event.rb

@@ -0,0 +1,75 @@
+require "enumerize"
+
+module Falsify
+  # The FulfillmentEvent resource represents tracking events that belong to a {Fulfillment} of one or more items in an {Order}.
+  # Fulfillment events are displayed on the [order status page](https://help.shopify.com/en/manual/orders/status-tracking/customize-status-tracking) to update customers on the status of their shipment.
+  # See the [API documentation](https://help.shopify.com/en/api/reference/shipping-and-fulfillment/fulfillmentevent).
+  class FulfillmentEvent
+    extend Enumerize
+    # The street address where the fulfillment event occurred.
+    # @return [String]
+    attr_accessor :address1
+    # The city where the fulfillment event occurred.
+    # @return [String]
+    attr_accessor :city
+    # The country where the fulfillment event occurred.
+    # @return [String]
+    attr_accessor :country
+    # The date and time ([ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format) when the fulfillment event was created.
+    # @return [String]
+    attr_accessor :created_at
+    # The estimated delivery date based on the fulfillment's tracking number, as long as it's provided by one of the following carriers: USPS, FedEx, UPS, or Canada Post (Canada only).
+    # Value is `null` if no tracking number is available or if the tracking number is from an unsupported carrier.
+    # This property is available only when [carrier calculated rates](/manual/shipping/rates-and-methods/custom-calculated-rates) are in use.'
+    # @return [String,nil]
+    attr_accessor :estimated_delivery_at
+    # An ID for the fulfillment that's associated with the fulfillment event.
+    # @return [String]
+    attr_accessor :fulfillment_id
+    # The date and time ([ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format) when the fulfillment event occurred.
+    # @return [String]
+    attr_accessor :happened_at
+    # An ID for the fulfillment event.
+    # @return [String]
+    attr_accessor :id
+    # A geographic coordinate specifying the latitude of the fulfillment event.
+    # @return [String]
+    attr_accessor :latitude
+    # A geographic coordinate specifying the longitude of the fulfillment event.
+    # @return [String]
+    attr_accessor :longitude
+    # An arbitrary message describing the status.
+    # Can be provided by a shipping carrier.
+    # @return [String]
+    attr_accessor :message
+    # The ID of the order that's associated with the fulfillment event.
+    # @return [String]
+    attr_accessor :order_id
+    # The province where the fulfillment event occurred.
+    # @return [String]
+    attr_accessor :province
+    # An ID for the shop that's associated with the fulfillment event.
+    # @return [String]
+    attr_accessor :shop_id
+    # @!attribute status [rw]
+    #   The status of the fulfillment event.
+    #   Valid values:
+    #   - `label_printed` - A label for the shipment was purchased and printed.
+    #   - `label_purchased` - A label for the shipment was purchased, but not printed.
+    #   - `attempted_delivery` - Delivery of the shipment was attempted, but unable to be completed.
+    #   - `ready_for_pickup` - The shipment is ready for pickup at a shipping depot.
+    #   - `confirmed` - The carrier is aware of the shipment, but hasn't received it yet.
+    #   - `in_transit` - The shipment is being transported between shipping facilities on the way to its destination.
+    #   - `out_for_delivery` - The shipment is being delivered to its final destination.
+    #   - `delivered` - The shipment was succesfully delivered.
+    #   - `failure` - Something went wrong when pulling tracking information for the shipment, such as the tracking number was invalid or the shipment was canceled.
+    #   @return [:label_printed, :label_purchased, :attempted_delivery, :ready_for_pickup, :confirmed, :in_transit, :out_for_delivery, :delivered, :failure]
+    enumerize :status, in: [:label_printed, :label_purchased, :attempted_delivery, :ready_for_pickup, :confirmed, :in_transit, :out_for_delivery, :delivered, :failure]
+    # The date and time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when the fulfillment event was updated.
+    # @return [String]
+    attr_accessor :updated_at
+    # The zip code of the location where the fulfillment event occurred.
+    # @return [String]
+    attr_accessor :zip
+  end
+end

data/lib/falsify/models/fulfillment/fulfillment_line_item.rb

@@ -0,0 +1,75 @@
+require "enumerize"
+
+module Falsify
+  # A historical record of an individual item in a fulfillment.
+  class FulfillmentLineItem
+    extend Enumerize
+    # The ID of the line item within the fulfillment.
+    # @return [String]
+    attr_accessor :id
+    # The ID of the product variant being fulfilled.
+    # @return [String]
+    attr_accessor :variant_id
+    # The title of the product.
+    # @return [String]
+    attr_accessor :title
+    # The number of items in the fulfillment.
+    # @return [Integer]
+    attr_accessor :quantity
+    # The price of the item.
+    # @return [String]
+    attr_accessor :price
+    # The weight of the item in grams.
+    # @return [String]
+    attr_accessor :grams
+    # The unique identifier of the item in the fulfillment.
+    # @return [String]
+    attr_accessor :sku
+    # The title of the product variant being fulfilled.
+    # @return [String]
+    attr_accessor :variant_title
+    # The name of the supplier of the item.
+    # @return [String]
+    attr_accessor :vendor
+    # The service provider who is doing the fulfillment.
+    # @return [String]
+    attr_accessor :fulfillment_service
+    # The unique numeric identifier for the product in the fulfillment.
+    # @return [String]
+    attr_accessor :product_id
+    # Whether a customer needs to provide a shipping address when placing an order for this product variant.
+    # @return [Boolean]
+    attr_accessor :requires_shipping
+    # Whether the line item is taxable.
+    # @return [Boolean]
+    attr_accessor :taxable
+    # Whether the line item is a [gift card](https://help.shopify.com/manual/products/gift-card-products).
+    # @return [Boolean]
+    attr_accessor :gift_card
+    # The name of the product variant.
+    # @return [String]
+    attr_accessor :name
+    # The name of the inventory management system.
+    # @return [String]
+    attr_accessor :variant_inventory_management
+    # Any additional properties associated with the line item.
+    # @return [Array<String>]
+    attr_accessor :properties
+    # Whether the product exists.
+    # @return [String]
+    attr_accessor :product_exists
+    # The amount available to fulfill. This is the `quantity - max (refunded_quantity, fulfilled_quantity) - pending_fulfilled_quantity - open_fulfilled_quantity`.
+    # @return [String]
+    attr_accessor :fulfillable_quantity
+    # The total of any discounts applied to the line item.
+    # @return [String]
+    attr_accessor :total_discount
+    # @!attribute fulfillment_status [rw]
+    #   The status of an order in terms of the line items being fulfilled. Valid values: `fulfilled`, `null`, or `partial`.
+    #   @return [:fulfilled, :null, :partial]
+    enumerize :fulfillment_status, in: [:fulfilled, :null, :partial]
+    # The `title`, `price`, and `rate` of any taxes applied to the line item.
+    # @return [Array<TaxLine>]
+    attr_accessor :tax_lines
+  end
+end

data/lib/falsify/models/fulfillment/supported_tracking_companies.rb

@@ -0,0 +1,51 @@
+module Falsify
+  # Valid values for the `tracking_company` field of a {Fulfillment}.
+  # @return [Array<String>]
+  def self.supported_tracking_companies
+    return [
+      "4PX",
+      "APC",
+      "Amazon Logistics UK",
+      "Amazon Logistics US",
+      "Australia Post",
+      "Bluedart",
+      "Canada Post",
+      "China Post",
+      "Chukou1",
+      "Correios",
+      "DHL Express",
+      "DHL eCommerce",
+      "DHL eCommerce Asia",
+      "DPD",
+      "DPD Local",
+      "DPD UK",
+      "Delhivery",
+      "Eagle",
+      "FSC",
+      "FedEx",
+      "FedEx UK",
+      "GLS",
+      "Globegistics",
+      "Japan Post (EN)",
+      "Japan Post (JA)",
+      "La Poste",
+      "New Zealand Post",
+      "Newgistics",
+      "PostNL",
+      "PostNord",
+      "Purolator",
+      "Royal Mail",
+      "SF Express",
+      "Sagawa (EN)",
+      "Sagawa (JA)",
+      "Singapore Post",
+      "TNT",
+      "UPS",
+      "USPS",
+      "Whistl",
+      "Yamato (EN)",
+      "Yamato (JA)",
+      "YunExpress",
+    ]
+  end
+end