falsify 0.1.0

data/lib/falsify/models/order/price_set.rb

@@ -0,0 +1,52 @@
+module Falsify
+  # A PriceSet contains a price in both *shop* and *presentment* currencies.
+  #
+  # Used for:
+  # - price_set
+  # - discounted_price_set
+  # - total_discounts_set
+  # - total_line_items_price_set
+  # - total_price_set
+  # - total_tax_set
+  # - discount_allocations.amount_set
+  class PriceSet
+    # @return [String]
+    attr_accessor :shop_money_amount
+    # @return [String]
+    attr_accessor :shop_money_currency_code
+    # @return [String]
+    attr_accessor :presentment_money_amount
+    # @return [String]
+    attr_accessor :presentment_money_currency_code
+
+    # @param hash [Hash]
+    # @return [PriceSet]
+    def self.create_from_hash(hash)
+      ps = PriceSet.new()
+
+      shop_money                  = hash[:shop_money]
+      ps.shop_money_amount        = shop_money[:amount]
+      ps.shop_money_currency_code = shop_money[:currency_code]
+
+      presentment_money                  = hash[:presentment_money]
+      ps.presentment_money_amount        = presentment_money[:amount]
+      ps.presentment_money_currency_code = presentment_money[:currency_code]
+
+      return ps
+    end
+
+    # @return [Hash]
+    def to_hash()
+      return {
+        'shop_money': {
+          "amount": @shop_money_amount,
+          "currency_code": @shop_money_currency_code,
+        },
+        'presentment_money': {
+          "amount": @presentment_money_amount,
+          "currency_code": @presentment_money_currency_code,
+        },
+      }
+    end
+  end
+end

data/lib/falsify/models/order/refund/refund.rb

@@ -0,0 +1,72 @@
+module Falsify
+  # Required Fields:
+  # - refund_line_items
+  class Refund
+    # The date and time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when the refund was created.
+    # @return [String]
+    attr_reader :created_at
+    # The unique identifier for the refund.
+    # @return [String]
+    attr_reader :id
+    # An optional note attached to a refund.
+    # @return [String]
+    attr_accessor :note
+    # @!attribute order_adjustments [r]
+    #   A list of order adjustments attached to the refund.
+    #   Order adjustments are generated to account for refunded shipping costs and differences between calculated and actual refund amounts.
+    #   Each entry has the following properties:
+    #
+    #   - **id** : The unique identifier for the order adjustment.
+    #   - **order_id** : The unique identifier for the order that the order adjustment is associated with.
+    #   - **refund_id** : The unique identifier for the refund that the order adjustment is associated with.
+    #   - **amount** : 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.
+    #   - **tax_amount** : The taxes that are added to `amount`, such as applicable shipping taxes added to a shipping refund.
+    #   - **kind** : The order adjustment type. Valid values: `shipping_refund` and `refund_discrepancy`.
+    #   - **reason** : The reason for the order adjustment. To set this value, include `discrepancy_reason` when you create a refund.
+    #   - **amount_set** : The amount of the order adjustment in shop and presentment currencies.
+    #   - **tax_amount_set** : The tax amount of the order adjustment in shop and presentment currencies.
+    #   @return [String]
+    attr_reader :order_adjustments
+    # The date and time ([ISO 8601](https://en.wikipedia.org/wiki/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.
+    # @return [String]
+    attr_accessor :processed_at
+    # @!attribute refund_line_items [rw]
+    #   A list of refunded line items.
+    #   Each entry has the following properties:
+    #
+    #   - **id** : The unique identifier of the line item in the refund.
+    #   - **line_item** : A [line item](https://help.shopify.com/en/api/reference/order#line-items-property) being returned.
+    #   - **line_item_id** : The ID of the related line item in the order.
+    #   - **quantity** : The quantity of the associated line item that was returned.
+    #   - **restock_type** : 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.
+    #   - **location_id** : The unique identifier of the [location](https://help.shopify.com/en/api/reference/inventory/location) where the items will be restocked. Required when `restock_type` has the value `return` or `cancel`.
+    #   - **subtotal** : The subtotal of the refund line item.
+    #   - **total_tax** : The total tax on the refund line item.
+    #   - **subtotal_set** : The subtotal of the refund line item in shop and presentment currencies.
+    #   - **total_tax_set** : The total tax of the line item in shop and presentment currencies.
+    #   - **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.
+    #   @return [String]
+    attr_accessor :refund_line_items
+    # Whether to add the line items back to the store's inventory.
+    # Provide a `restock_type` to influence how this refund affects inventory instead
+    # @return [Boolean]
+    attr_accessor :restock
+    # A list of transactions involved in the refund.
+    # For more information, see the [Transaction](https://help.shopify.com/en/api/reference/orders/transaction) resource.
+    # @return [Array<Transaction>]
+    attr_accessor :transactions
+    # The unique identifier of the user who performed the refund.
+    # @return [String]
+    attr_accessor :user_id
+  end
+end

data/lib/falsify/models/order/shipping_line.rb

@@ -0,0 +1,39 @@
+module Falsify
+  # An individual shipping method used to fulfill an order.
+  class ShippingLine
+    # A reference to the shipping method.
+    # @return [String]
+    attr_accessor :code
+    # The price of the shipping method after line-level discounts have been applied.
+    # Doesn't reflect cart-level or order-level discounts.
+    # @return [String]
+    attr_accessor :discounted_price
+    # The price of the shipping method in both shop and presentment currencies after line-level discounts have been applied.
+    # @return [PriceSet]
+    attr_accessor :discounted_price_set
+    # The price of this shipping method in the shop currency.
+    # Can't be negative.
+    # @return [String]
+    attr_accessor :price
+    # The price of the shipping method in shop and presentment currencies.
+    # @return [PriceSet]
+    attr_accessor :price_set
+    # The source of the shipping method.
+    # @return [String]
+    attr_accessor :source
+    # The title of the shipping method.
+    # @return [String]
+    attr_accessor :title
+    # A list of tax line objects, each of which details a tax applicable to this shipping line.
+    # @return [Array<TaxLine>]
+    attr_accessor :tax_lines
+    # A reference to the carrier service that provided the rate.
+    # Present when the rate was computed by a third-party carrier service.
+    # @return [String]
+    attr_accessor :carrier_identifier
+    # A reference to the fulfillment service that is being requested for the shipping method.
+    # Present if the shipping method requires processing by a third party fulfillment service; null otherwise.
+    # @return [String,nil]
+    attr_accessor :requested_fulfillment_service_id
+  end
+end

data/lib/falsify/models/order/tax_line.rb

@@ -0,0 +1,14 @@
+module Falsify
+  # Details a tax applied to a LineItem.
+  class TaxLine
+    # The name of the tax.
+    # @return [String]
+    attr_accessor :title
+    # The amount added to the order for this tax in the shop currency.
+    # @return [String]
+    attr_accessor :price
+    # The tax rate applied to the order to calculate the tax price.
+    # @return [String]
+    attr_accessor :rate
+  end
+end

data/lib/falsify/models/product/collection/collect.rb

@@ -0,0 +1,29 @@
+module Falsify
+  # See the [API documentation](https://help.shopify.com/en/api/reference/products/collect).
+  class Collect
+    # The ID of the custom collection containing the product.
+    # @return [String]
+    attr_accessor :collection_id
+    # The date and time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when the collect was created.
+    # @return [String]
+    attr_accessor :created_at
+    # A unique numeric identifier for the collect.
+    # @return [String]
+    attr_accessor :id
+    # The position of this product in a manually sorted custom collection.
+    # The first position is 1.
+    # This value is applied only when the custom collection is sorted manually.
+    # @return [Integer]
+    attr_accessor :position
+    # The unique numeric identifier for the product in the custom collection.
+    # @return [String]
+    attr_accessor :product_id
+    # This is the same value as `position` but padded with leading zeroes to make it alphanumeric-sortable.
+    # This value is applied only when the custom collection is sorted manually.
+    # @return [String]
+    attr_accessor :sort_value
+    # The date and time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when the collect was last updated.
+    # @return [String]
+    attr_accessor :updated_at
+  end
+end

data/lib/falsify/models/product/collection/custom_collection.rb

@@ -0,0 +1,72 @@
+require "enumerize"
+
+module Falsify
+  # See the [API documentation](https://help.shopify.com/en/api/reference/products/customcollection).
+  #
+  # Required Fields:
+  # -   title
+  class Customcollection
+    extend Enumerize
+    # The description of the custom collection, complete with HTML markup.
+    # Many templates display this on their custom collection pages.
+    # @return [String]
+    attr_accessor :body_html
+    # A human-friendly unique string for the custom collection automatically generated from its title.
+    # This is used in shop themes by the Liquid templating language to refer to the custom collection.
+    # (limit: 255 characters)
+    # @return [String]
+    attr_accessor :handle
+    # Image associated with the custom collection.
+    # Valid values are:
+    # - **attachment** : An image attached to a custom collection returned as Base64-encoded binary data.
+    # - **src** : The source URL that specifies the location of the image.
+    # - **alt** : Alternative text that describes the collection image.
+    # - **created_at** : The time and date ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when the image was added to the collection.
+    # - **width** : The width of the image in pixels.
+    # - **height** : The height of the image in pixels.
+    # @return [Hash]
+    attr_accessor :image
+    # The ID for the custom collection.
+    # @return [String]
+    attr_reader :id
+    # Whether the custom collection is published to the Online Store channel.
+    # @return [String]
+    attr_accessor :published
+    # The time and date ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when the collection was made visible.
+    # Returns `null` for a hidden custom collection.
+    # @return [String,nil]
+    attr_reader :published_at
+    # @!attribute published_scope [r]
+    #   Whether the collection is published to the Point of Sale channel.
+    #   Valid values:
+    #   - `web`: The custom collection is published to the Online Store channel but not published to the Point of Sale channel.
+    #   - `global`: The custom collection is published to both the Online Store channel and the Point of Sale channel.
+    #   @return [:web, :global]
+    enumerize :published_scope, in: [:web, :global]
+    # The order in which products in the custom collection appear.
+    # Valid values:
+    # - **alpha-asc** : Alphabetically, in ascending order (A - Z).
+    # - **alpha-desc** : Alphabetically, in descending order (Z - A).
+    # - **best-selling** : By best-selling products.
+    # - **created** : By date created, in ascending order (oldest - newest).
+    # - **created-desc** : By date created, in descending order (newest - oldest).
+    # - **manual** : Order created by the shop owner.
+    # - **price-asc** : By price, in ascending order (lowest - highest).
+    # - **price-desc** : By price, in descending order (highest - lowest).
+    # # @return [String]
+    # @return ["alpha-asc", "alpha-desc", "best-selling", "created", "created-desc", "manual", "price-asc", "price-desc"]
+    attr_accessor :sort_order
+    # The suffix of the liquid template being used.
+    # For example, if the value is `custom`, then the collection is using the `collection.custom.liquid` template.
+    # If the value is `null`, then the collection is using the default `collection.liquid`.
+    # @return [String,nil]
+    attr_accessor :template_suffix
+    # The name of the custom collection.
+    # (limit: 255 characters)
+    # @return [String]
+    attr_accessor :title
+    # The date and time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when the custom collection was last modified.
+    # @return [String]
+    attr_reader :updated_at
+  end
+end

data/lib/falsify/models/product/collection/smart_collection.rb

@@ -0,0 +1,181 @@
+require "enumerize"
+
+module Falsify
+  # See the [API documentation](https://help.shopify.com/en/api/reference/products/smartcollection).
+  #
+  # Required Fields:
+  # - rules
+  # - title
+  class Smartcollection
+    extend Enumerize
+    # @!attribute body_html [rw]
+    #   The description of the smart collection.
+    #   Includes HTML markup.
+    #   Many shop themes display this on the smart collection page.
+    #   @return [String]
+    attr_accessor :body_html
+    # @!attribute handle [rw]
+    #   A human-friendly unique string for the smart collection.
+    #   Automatically generated from the `title`.
+    #   Used in shop themes by the Liquid templating language to refer to the smart collection.
+    #   (maximum: 255 characters)
+    #   @return [String]
+    attr_accessor :handle
+    # @!attribute id [rw]
+    #   The ID of the smart collection.
+    #   @return [String]
+    attr_accessor :id
+    # @!attribute image [rw]
+    #   The image associated with the smart collection.
+    #   Valid values:
+    #   - `attachment`: An image attached to a smart collection returned as Base64-encoded binary data.
+    #   - `src`: A URL that specifies the location of the image.
+    #   - `alt`: Alternative text that describes the collection image.
+    #   @return [Hash]
+    attr_accessor :image
+    # @!attribute published_at [rw]
+    #   The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) that the smart collection was published.
+    #   Returns `null` when the collection is hidden.
+    #   @return [String,nil]
+    attr_accessor :published_at
+    # @!attribute published_scope [rw]
+    #   Whether the smart collection is published to the Point of Sale channel.
+    #   Valid values:
+    #   - `web`: The smart collection is published to the Online Store channel but not published to the Point of Sale channel.
+    #   - `global`: The smart collection is published to both the Online Store channel and the Point of Sale channel.
+    #   @return [:web, :global]
+    enumerize :published_scope, in: [:web, :global]
+    # @!attribute rules [rw]
+    #   The list of rules that define what products go into the smart collection.
+    #   Each rule has the following properties:
+    #
+    #   -
+    #
+    #   **column** : The property of a product being used to populate the smart collection.
+    #
+    #   Valid values for text relations:
+    #
+    #     - `title`: The product title.
+    #     - `type`: The product type.
+    #     - `vendor`: The name of the product vendor.
+    #     - `variant_title`: The title of a product variant.
+    #
+    #   Valid values for number relations:
+    #
+    #     - `variant_compare_at_price`: The compare price.
+    #     - `variant_weight`: The weight of the product.
+    #     - `variant_inventory`: The inventory stock.
+    #   Note: `not_equals` does not work with this property.
+    #     - `variant_price`: product price.
+    #
+    #   Valid values for an `equals` relation:
+    #
+    #     - `tag`: A tag associated with the product.
+    #   -
+    #
+    #   **relation** : The relationship between the **column** choice, and the **condition**.
+    #
+    #   Valid values for number relations:
+    #
+    #     - `greater_than` The column value is greater than the condition.
+    #     - `less_than` The column value is less than the condition.
+    #     - `equals` The column value is equal to the condition.
+    #     - `not_equals` The column value is not equal to the condition.
+    #
+    #   Valid values for text relations:
+    #
+    #     - `equals`: Checks if the **column** value is equal to the **condition** value.
+    #     - `not_equals`: Checks if the **column** value is not equal to the **condition** value.
+    #     - `starts_with`: Checks if the **column** value starts with the **condition** value.
+    #     - `ends_with`: Checks if the **column** value ends with the **condition** value.
+    #     - `contains`: Checks if the **column** value contains the **condition** value.
+    #     - `not_contains`: Checks if the **column** value does not contain the **condition** value.
+    #   -
+    #
+    #   **condition** : Select products for a smart collection using a condition.
+    #   Values are either strings or numbers, depending on the **relation** value.
+    #
+    #   **column** : The property of a product being used to populate the smart collection.
+    #
+    #   Valid values for text relations:
+    #
+    #   - `title`: The product title.
+    #   - `type`: The product type.
+    #   - `vendor`: The name of the product vendor.
+    #   - `variant_title`: The title of a product variant.
+    #
+    #   Valid values for number relations:
+    #
+    #   - `variant_compare_at_price`: The compare price.
+    #   - `variant_weight`: The weight of the product.
+    #   - `variant_inventory`: The inventory stock. Note: `not_equals` does not work with this property.
+    #   - `variant_price`: product price.
+    #
+    #   Valid values for an `equals` relation:
+    #
+    #   - `tag`: A tag associated with the product.
+    #
+    #   **relation** : The relationship between the **column** choice, and the **condition**.
+    #
+    #   Valid values for number relations:
+    #
+    #   - `greater_than` The column value is greater than the condition.
+    #   - `less_than` The column value is less than the condition.
+    #   - `equals` The column value is equal to the condition.
+    #   - `not_equals` The column value is not equal to the condition.
+    #
+    #   Valid values for text relations:
+    #
+    #   - `equals`: Checks if the **column** value is equal to the **condition** value.
+    #   - `not_equals`: Checks if the **column** value is not equal to the **condition** value.
+    #   - `starts_with`: Checks if the **column** value starts with the **condition** value.
+    #   - `ends_with`: Checks if the **column** value ends with the **condition** value.
+    #   - `contains`: Checks if the **column** value contains the **condition** value.
+    #   - `not_contains`: Checks if the **column** value does not contain the **condition** value.
+    #
+    #   **condition** : Select products for a smart collection using a condition.
+    #   Values are either strings or numbers, depending on the **relation** value.
+    #   @return [String]
+    attr_accessor :rules
+    # @!attribute disjunctive [rw]
+    #   Whether the product must match all the rules to be included in the smart collection.
+    #   Valid values:
+    #
+    #   - `true`: Products only need to match one or more of the rules to be included in the smart collection.
+    #   - `false`: Products must match all of the rules to be included in the smart collection.
+    #   @return [String]
+    attr_accessor :disjunctive
+    # @!attribute sort_order [rw]
+    #   The order of the products in the smart collection.
+    #   Valid values:
+    #
+    #   - `alpha-asc`: The products are sorted alphabetically from A to Z.
+    #   - `alpha-des`: The products are sorted alphabetically from Z to A.
+    #   - `best-selling`: The products are sorted by number of sales.
+    #   - `created`: The products are sorted by the date they were created, from oldest to newest.
+    #   - `created-desc`: The products are sorted by the date they were created, from newest to oldest.
+    #   - `manual`: The products are manually sorted by the shop owner. **Deprecation will begin in 2019.**
+    #   - `price-asc`: The products are sorted by price from lowest to highest.
+    #   - `price-desc`: The products are sorted by price from highest to lowest.
+    #   @return [String]
+    attr_accessor :sort_order
+    # @!attribute template_suffix [rw]
+    #   The suffix of the Liquid template that the shop uses.
+    #   By default, the original template is called product.liquid, and additional templates are called product.`suffix`.liquid.
+    #   @return [String]
+    attr_accessor :template_suffix
+    # @!attribute title [rw]
+    #   The name of the smart collection.
+    #   Maximum length: 255 characters.
+    #   @return [String]
+    attr_accessor :title
+    # @!attribute updated_at [r]
+    #   The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the smart collection was last modified.
+    #   @return [String]
+    attr_reader :updated_at
+    # @!attribute products_manually_sorted_count [r]
+    #   The number of manually-sorted products in the smart collection.
+    #   @return [String]
+    attr_reader :products_manually_sorted_count
+  end
+end