shopify_api 9.0.3 → 12.5.0

data/lib/shopify_api/resources/fulfillment_request.rb

@@ -1,15 +0,0 @@
-module ShopifyAPI
-  class FulfillmentRequest < Base
-    init_prefix :order
-
-    def order_id
-      @prefix_options[:order_id]
-    end
-
-    def mark_as_failed
-      options = {}
-      options[:message] = failure_message if failure_message
-      load_attributes_from_response(put(:mark_as_failed, options))
-    end
-  end
-end

data/lib/shopify_api/resources/fulfillment_service.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class FulfillmentService < Base
-  end
-end

data/lib/shopify_api/resources/fulfillment_v2.rb

@@ -1,20 +0,0 @@
-module ShopifyAPI
-  class FulfillmentV2 < Base
-    self.element_name = 'fulfillment'
-
-    def initialize(attributes = {}, persisted = false)
-      ShopifyAPI::Base.version_validation!(FulfillmentOrder::MINIMUM_VERSION)
-      super(attributes, persisted)
-    end
-
-    def update_tracking(tracking_info:, notify_customer:)
-      body = {
-        fulfillment: {
-          tracking_info: tracking_info,
-          notify_customer: notify_customer
-        }
-      }
-      load_attributes_from_response(post(:update_tracking, {}, body.to_json))
-    end
-  end
-end

data/lib/shopify_api/resources/gift_card.rb

@@ -1,7 +0,0 @@
-module ShopifyAPI
-  class GiftCard < Base
-    def disable
-      load_attributes_from_response(post(:disable))
-    end
-  end
-end

data/lib/shopify_api/resources/image.rb

@@ -1,16 +0,0 @@
-module ShopifyAPI
-  class Image < Base
-    init_prefix :product
-
-    # generate a method for each possible image variant
-    [:pico, :icon, :thumb, :small, :compact, :medium, :large, :grande, :original].each do |m|
-      reg_exp_match = "/\\1_#{m}.\\2"
-      define_method(m) { src.gsub(/\/(.*)\.(\w{2,4})/, reg_exp_match) }
-    end
-
-    def attach_image(data, filename = nil)
-      attributes['attachment'] = Base64.encode64(data)
-      attributes['filename'] = filename unless filename.nil?
-    end
-  end
-end

data/lib/shopify_api/resources/inventory_item.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  class InventoryItem < Base
-  end
-end

data/lib/shopify_api/resources/inventory_level.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  class InventoryLevel < Base
-
-    # The default path structure in ActiveResource for delete would result in:
-    # /admin/api/<version>/inventory_levels/#{ inventory_level.id }.json?#{ params }, but since
-    # InventroyLevels are a second class resource made up of a Where and a What
-    # (Location and InventoryItem), it does not have a resource ID. Here we
-    # redefine element_path to remove the id so HTTP DELETE requests go to
-    # /admin/api/<version>/inventory_levels.json?#{ params } instead.
-    #
-    def self.element_path(prefix_options = {}, query_options = nil)
-      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
-      "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"
-    end
-
-    def destroy
-      load_attributes_from_response(
-        self.class.delete('/', location_id: location_id, inventory_item_id: inventory_item_id)
-      )
-    end
-
-    def connect(relocate_if_necessary: nil)
-      body = { location_id: location_id, inventory_item_id: inventory_item_id }
-      body[:relocate_if_necessary] = relocate_if_necessary unless relocate_if_necessary.nil?
-      load_attributes_from_response(
-        self.class.post(:connect, {}, body.to_json)
-      )
-    end
-
-    def set(new_available, disconnect_if_necessary: nil)
-      body = {
-        location_id: location_id,
-        inventory_item_id: inventory_item_id,
-        available: new_available
-      }
-      body[:disconnect_if_necessary] = disconnect_if_necessary unless disconnect_if_necessary.nil?
-      load_attributes_from_response(
-        self.class.post(:set, {}, body.to_json)
-      )
-    end
-
-    def adjust(available_adjustment)
-      body = {
-        location_id: location_id,
-        inventory_item_id: inventory_item_id,
-        available_adjustment: available_adjustment
-      }
-      load_attributes_from_response(
-        self.class.post(:adjust, {}, body.to_json)
-      )
-    end
-  end
-end

data/lib/shopify_api/resources/line_item.rb

@@ -1,14 +0,0 @@
-module ShopifyAPI
-  class LineItem < Base
-    class Property < Base
-      def initialize(*args)
-        attributes = args[0] || {}
-        persisted = args[1] || false
-        super
-      rescue NameError
-        attributes = attributes.to_hash
-        self
-      end
-    end
-  end
-end

data/lib/shopify_api/resources/location.rb

@@ -1,8 +0,0 @@
-module ShopifyAPI
-  class Location < Base
-
-    def inventory_levels
-      ShopifyAPI::InventoryLevel.find(:all, from: "#{self.class.prefix}locations/#{id}/inventory_levels.json")
-    end
-  end
-end

data/lib/shopify_api/resources/marketing_event.rb

@@ -1,10 +0,0 @@
-module ShopifyAPI
-  class MarketingEvent < Base
-    include Countable
-
-    def add_engagements(engagements)
-      engagements = { engagements: Array.wrap(engagements) }
-      post(:engagements, {}, engagements.to_json)
-    end
-  end
-end

data/lib/shopify_api/resources/metafield.rb

@@ -1,13 +0,0 @@
-module ShopifyAPI
-  class Metafield < Base
-    include DisablePrefixCheck
-
-    conditional_prefix :resource, true
-    early_july_pagination_release!
-
-    def value
-      return if attributes["value"].nil?
-      attributes["value_type"] == "integer" ? attributes["value"].to_i : attributes["value"]
-    end
-  end
-end

data/lib/shopify_api/resources/note_attribute.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class NoteAttribute < Base
-  end
-end

data/lib/shopify_api/resources/option.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class Option < Base
-  end
-end

data/lib/shopify_api/resources/order.rb

@@ -1,43 +0,0 @@
-module ShopifyAPI
-  class Order < Base
-    include Events
-    include Metafields
-
-    def close
-      load_attributes_from_response(post(:close, {}, only_id))
-    end
-
-    def open
-      load_attributes_from_response(post(:open, {}, only_id))
-    end
-
-    def cancel(options = {})
-      load_attributes_from_response(post(:cancel, {}, options.to_json))
-    end
-
-    def transactions
-      Transaction.find(:all, :params => { :order_id => id })
-    end
-
-    def capture(amount = "", currency: nil)
-      capture_transaction = {
-        amount: amount,
-        kind: "capture",
-        order_id: id,
-      }
-      capture_transaction[:currency] = currency if currency
-
-      Transaction.create(capture_transaction)
-    end
-
-    def fulfillment_orders(options = {})
-      ShopifyAPI::Base.version_validation!(FulfillmentOrder::MINIMUM_VERSION)
-
-      fulfillment_order_hashes = get(:fulfillment_orders, options)
-      fulfillment_order_hashes.map { |fulfillment_order_hash| FulfillmentOrder.new(fulfillment_order_hash) }
-    end
-
-    class ClientDetails < Base
-    end
-  end
-end

data/lib/shopify_api/resources/order_risk.rb

@@ -1,8 +0,0 @@
-module ShopifyAPI
-  class OrderRisk < Base
-    init_prefix :order
-
-    self.collection_name = "risks"
-    self.element_name = "risk"
-  end
-end

data/lib/shopify_api/resources/page.rb

@@ -1,6 +0,0 @@
-module ShopifyAPI
-  class Page < Base
-    include Events
-    include Metafields
-  end
-end

data/lib/shopify_api/resources/payment.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  class Payment < Base
-    self.resource_prefix = "checkouts/:checkout_id/"
-  end
-end

data/lib/shopify_api/resources/payment_details.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class PaymentDetails < Base
-  end
-end

data/lib/shopify_api/resources/ping.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-Dir.glob("#{File.dirname(__FILE__)}/ping/*").each { |file| require file }

data/lib/shopify_api/resources/policy.rb

@@ -1,7 +0,0 @@
-module ShopifyAPI
-  class Policy < Base
-    def self.all
-      find(:all)
-    end
-  end
-end

data/lib/shopify_api/resources/price_rule.rb

@@ -1,8 +0,0 @@
-module ShopifyAPI
-  class PriceRule < Base
-
-    def discount_codes
-      DiscountCode.find(:all, params: { price_rule_id: id })
-    end
-  end
-end

data/lib/shopify_api/resources/product.rb

@@ -1,56 +0,0 @@
-module ShopifyAPI
-  class Product < Base
-    include Events
-    include Metafields
-
-    early_july_pagination_release!
-
-    # compute the price range
-    def price_range
-      prices = variants.collect(&:price).collect(&:to_f)
-      format =  "%0.2f"
-      if prices.min != prices.max
-        "#{format % prices.min} - #{format % prices.max}"
-      else
-        format % prices.min
-      end
-    end
-
-    def total_inventory=(new_value)
-      raise_deprecated_inventory_call('total_inventory') unless allow_inventory_params?
-      super
-    end
-
-    def serializable_hash(options = {})
-      allow_inventory_params? ? super(options) : super(options).except('total_inventory')
-    end
-
-    def collections
-      CustomCollection.find(:all, :params => {:product_id => self.id})
-    end
-
-    def smart_collections
-      SmartCollection.find(:all, :params => {:product_id => self.id})
-    end
-
-    def add_to_collection(collection)
-      collection.add_product(self)
-    end
-
-    def remove_from_collection(collection)
-      collection.remove_product(self)
-    end
-
-    private
-
-    def raise_deprecated_inventory_call(parameter)
-      raise(ShopifyAPI::ValidationException,
-        "'#{parameter}' is deprecated - see https://help.shopify.com/en/api/guides/inventory-migration-guide",
-        )
-    end
-
-    def allow_inventory_params?
-      Base.api_version < ApiVersion.find_version('2019-10')
-    end
-  end
-end

data/lib/shopify_api/resources/product_listing.rb

@@ -1,16 +0,0 @@
-module ShopifyAPI
-  class ProductListing < Base
-    self.primary_key = :product_id
-
-    early_july_pagination_release!
-
-    def self.product_ids
-      ProductId.all
-    end
-
-    class ProductId < ArrayBase
-      self.resource_prefix = 'product_listings/'
-    end
-    private_constant :ProductId
-  end
-end

data/lib/shopify_api/resources/product_publication.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-module ShopifyAPI
-  class ProductPublication < Base
-    init_prefix :publication
-
-    def publication_id
-      @prefix_options[:publication_id]
-    end
-  end
-end

data/lib/shopify_api/resources/province.rb

@@ -1,5 +0,0 @@
-module ShopifyAPI
-  class Province < Base
-    init_prefix :country
-  end
-end

data/lib/shopify_api/resources/publication.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-module ShopifyAPI
-  class Publication < Base
-  end
-end

data/lib/shopify_api/resources/receipt.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class Receipt < Base
-  end
-end

data/lib/shopify_api/resources/recurring_application_charge.rb

@@ -1,31 +0,0 @@
-module ShopifyAPI
-  class RecurringApplicationCharge < Base
-    undef_method :test
-
-    class << self
-      def current
-        (all || []).find { |c| c.status == 'active' }
-      end
-
-      [:pending, :cancelled, :accepted, :declined].each do |status|
-        define_method(status) { (all || []).select { |c| c.status == status.to_s } }
-      end
-    end
-
-    def usage_charges
-      UsageCharge.find(:all, params: { recurring_application_charge_id: id })
-    end
-
-    def cancel
-      load_attributes_from_response(self.destroy)
-    end
-
-    def activate
-      load_attributes_from_response(post(:activate))
-    end
-
-    def customize(customize_recurring_app_charge_params = {})
-      load_attributes_from_response(put(:customize, recurring_application_charge: customize_recurring_app_charge_params ))
-    end
-  end
-end

data/lib/shopify_api/resources/redirect.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class Redirect < Base
-  end
-end

data/lib/shopify_api/resources/refund.rb

@@ -1,14 +0,0 @@
-module ShopifyAPI
-  class Refund < Base
-    init_prefix :order
-
-    def self.calculate(*args)
-      options = { :refund => args[0] }
-      params = {}
-      params = args[1][:params] if args[1] && args[1][:params]
-
-      resource = post(:calculate, params, options.to_json)
-      instantiate_record(format.decode(resource.body), {})
-    end
-  end
-end

data/lib/shopify_api/resources/report.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class Report < Base
-  end
-end

data/lib/shopify_api/resources/resource_feedback.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  class ResourceFeedback < Base
-    class ExistingFeedbackSaved < StandardError; end
-    include DisablePrefixCheck
-
-    self.collection_name = 'resource_feedback'
-    conditional_prefix :product, false
-
-    EXISTING_FEEDBACK_SAVED_ERROR_MESSAGE = 'WARNING: Attempted call to ShopifyAPI::ResourceFeedback#save' \
-      'after it was already persisted. Updating an existing ShopifyAPI::ResourceFeedback is not supported.'
-
-    def save
-      return super unless persisted?
-      raise ExistingFeedbackSaved.new(EXISTING_FEEDBACK_SAVED_ERROR_MESSAGE)
-    end
-  end
-end

data/lib/shopify_api/resources/rule.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class Rule < Base
-  end
-end

data/lib/shopify_api/resources/script_tag.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class ScriptTag < Base
-  end
-end

data/lib/shopify_api/resources/shipping_address.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class ShippingAddress < Base
-  end
-end

data/lib/shopify_api/resources/shipping_line.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class ShippingLine < Base
-  end
-end

data/lib/shopify_api/resources/shipping_rate.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  class ShippingRate < Base
-    self.resource_prefix = "checkouts/:checkout_id/"
-  end
-end

data/lib/shopify_api/resources/shipping_zone.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class ShippingZone < Base
-  end
-end

data/lib/shopify_api/resources/shop.rb

@@ -1,25 +0,0 @@
-module ShopifyAPI
-  # Shop object. Use Shop.current to receive
-  # the shop.
-  class Shop < Base
-    include ActiveResource::Singleton
-
-    def self.current(options = {})
-      find(options)
-    end
-
-    def metafields(**options)
-      Metafield.find :all, params: options
-    end
-
-    def add_metafield(metafield)
-      raise ArgumentError, "You can only add metafields to resource that has been saved" if new?
-      metafield.save
-      metafield
-    end
-
-    def events
-      Event.find(:all)
-    end
-  end
-end

data/lib/shopify_api/resources/smart_collection.rb

@@ -1,19 +0,0 @@
-module ShopifyAPI
-  class SmartCollection < Base
-    include Events
-    include Metafields
-
-    def products(options = {})
-      if options.present?
-        Product.find(:all, from: "#{self.class.prefix}smart_collections/#{id}/products.json", params: options)
-      else
-        Product.find(:all, params: { collection_id: id })
-      end
-    end
-
-    def order(options={})
-      load_attributes_from_response(put(:order, options, only_id))
-    end
-
-  end
-end

data/lib/shopify_api/resources/storefront_access_token.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class StorefrontAccessToken < Base
-  end
-end

data/lib/shopify_api/resources/tax_line.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class TaxLine < Base
-  end
-end

data/lib/shopify_api/resources/tax_service.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class TaxService < Base
-  end
-end

data/lib/shopify_api/resources/tender_transaction.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyAPI
-  class TenderTransaction < Base
-  end
-end

data/lib/shopify_api/resources/theme.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class Theme < Base
-  end
-end

data/lib/shopify_api/resources/transaction.rb

@@ -1,5 +0,0 @@
-module ShopifyAPI
-  class Transaction < Base
-    init_prefix :order
-  end
-end

data/lib/shopify_api/resources/usage_charge.rb

@@ -1,5 +0,0 @@
-module ShopifyAPI
-  class UsageCharge < Base
-    init_prefix :recurring_application_charge
-  end
-end

data/lib/shopify_api/resources/user.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class User < Base
-  end
-end

data/lib/shopify_api/resources/variant.rb

@@ -1,39 +0,0 @@
-module ShopifyAPI
-  class Variant < Base
-    include Metafields
-    include DisablePrefixCheck
-
-    conditional_prefix :product
-
-    def inventory_quantity_adjustment=(new_value)
-      raise_deprecated_inventory_call('inventory_quantity_adjustment') unless allow_inventory_params?
-      super
-    end
-
-    def inventory_quantity=(new_value)
-      raise_deprecated_inventory_call('inventory_quantity') unless allow_inventory_params?
-      super
-    end
-
-    def old_inventory_quantity=(new_value)
-      raise_deprecated_inventory_call('old_inventory_quantity') unless allow_inventory_params?
-      super
-    end
-
-    def serializable_hash(options = {})
-      allow_inventory_params? ? super(options) : super(options).except('inventory_quantity', 'old_inventory_quantity')
-    end
-
-    private
-
-    def raise_deprecated_inventory_call(parameter)
-      raise(ShopifyAPI::ValidationException,
-        "'#{parameter}' is deprecated - see https://help.shopify.com/en/api/guides/inventory-migration-guide",
-        )
-    end
-
-    def allow_inventory_params?
-      Base.api_version < ApiVersion.find_version('2019-10')
-    end
-  end
-end

data/lib/shopify_api/resources/webhook.rb

@@ -1,4 +0,0 @@
-module ShopifyAPI
-  class Webhook < Base
-  end
-end