shopify_api 14.3.0 → 14.4.0

data/lib/shopify_api/rest/resources/2024_07/inventory_level.rb

@@ -0,0 +1,183 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class InventoryLevel < ShopifyAPI::Rest::Base
+    extend T::Sig
+
+    @prev_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @next_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    @api_call_limit = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @retry_request_after = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    sig { params(session: T.nilable(ShopifyAPI::Auth::Session), from_hash: T.nilable(T::Hash[T.untyped, T.untyped])).void }
+    def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
+
+      @available = T.let(nil, T.nilable(Integer))
+      @inventory_item_id = T.let(nil, T.nilable(Integer))
+      @location_id = T.let(nil, T.nilable(Integer))
+      @updated_at = T.let(nil, T.nilable(String))
+
+      super(session: session, from_hash: from_hash)
+    end
+
+    @has_one = T.let({}, T::Hash[Symbol, Class])
+    @has_many = T.let({}, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :delete, operation: :delete, ids: [], path: "inventory_levels.json"},
+      {http_method: :get, operation: :get, ids: [], path: "inventory_levels.json"},
+      {http_method: :post, operation: :adjust, ids: [], path: "inventory_levels/adjust.json"},
+      {http_method: :post, operation: :connect, ids: [], path: "inventory_levels/connect.json"},
+      {http_method: :post, operation: :set, ids: [], path: "inventory_levels/set.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :available
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :inventory_item_id
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :location_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :updated_at
+
+    class << self
+      sig do
+        params(
+          inventory_item_id: T.untyped,
+          location_id: T.untyped,
+          session: Auth::Session
+        ).returns(T.untyped)
+      end
+      def delete(
+        inventory_item_id: nil,
+        location_id: nil,
+        session: ShopifyAPI::Context.active_session
+      )
+        request(
+          http_method: :delete,
+          operation: :delete,
+          session: session,
+          ids: {},
+          params: {inventory_item_id: inventory_item_id, location_id: location_id},
+        )
+      end
+
+      sig do
+        params(
+          inventory_item_ids: T.untyped,
+          location_ids: T.untyped,
+          limit: T.untyped,
+          updated_at_min: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[InventoryLevel])
+      end
+      def all(
+        inventory_item_ids: nil,
+        location_ids: nil,
+        limit: nil,
+        updated_at_min: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {inventory_item_ids: inventory_item_ids, location_ids: location_ids, limit: limit, updated_at_min: updated_at_min}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[InventoryLevel])
+      end
+
+    end
+
+    sig do
+      params(
+        inventory_item_id: T.untyped,
+        location_id: T.untyped,
+        available_adjustment: T.untyped,
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def adjust(
+      inventory_item_id: nil,
+      location_id: nil,
+      available_adjustment: nil,
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :adjust,
+        session: @session,
+        ids: {},
+        params: {inventory_item_id: inventory_item_id, location_id: location_id, available_adjustment: available_adjustment}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+    sig do
+      params(
+        inventory_item_id: T.untyped,
+        location_id: T.untyped,
+        relocate_if_necessary: T.untyped,
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def connect(
+      inventory_item_id: nil,
+      location_id: nil,
+      relocate_if_necessary: nil,
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :connect,
+        session: @session,
+        ids: {},
+        params: {inventory_item_id: inventory_item_id, location_id: location_id, relocate_if_necessary: relocate_if_necessary}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+    sig do
+      params(
+        inventory_item_id: T.untyped,
+        location_id: T.untyped,
+        available: T.untyped,
+        disconnect_if_necessary: T.untyped,
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def set(
+      inventory_item_id: nil,
+      location_id: nil,
+      available: nil,
+      disconnect_if_necessary: nil,
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :set,
+        session: @session,
+        ids: {},
+        params: {inventory_item_id: inventory_item_id, location_id: location_id, available: available, disconnect_if_necessary: disconnect_if_necessary}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/2024_07/location.rb

@@ -0,0 +1,171 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class Location < ShopifyAPI::Rest::Base
+    extend T::Sig
+
+    @prev_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @next_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    @api_call_limit = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @retry_request_after = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    sig { params(session: T.nilable(ShopifyAPI::Auth::Session), from_hash: T.nilable(T::Hash[T.untyped, T.untyped])).void }
+    def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
+
+      @active = T.let(nil, T.nilable(T::Boolean))
+      @address1 = T.let(nil, T.nilable(String))
+      @address2 = T.let(nil, T.nilable(String))
+      @city = T.let(nil, T.nilable(String))
+      @country = T.let(nil, T.nilable(String))
+      @country_code = T.let(nil, T.nilable(String))
+      @created_at = T.let(nil, T.nilable(String))
+      @id = T.let(nil, T.nilable(Integer))
+      @legacy = T.let(nil, T.nilable(T::Boolean))
+      @localized_country_name = T.let(nil, T.nilable(String))
+      @localized_province_name = T.let(nil, T.nilable(String))
+      @name = T.let(nil, T.nilable(String))
+      @phone = T.let(nil, T.nilable(String))
+      @province = T.let(nil, T.nilable(String))
+      @province_code = T.let(nil, T.nilable(String))
+      @updated_at = T.let(nil, T.nilable(String))
+      @zip = T.let(nil, T.nilable(String))
+
+      super(session: session, from_hash: from_hash)
+    end
+
+    @has_one = T.let({}, T::Hash[Symbol, Class])
+    @has_many = T.let({}, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :get, operation: :count, ids: [], path: "locations/count.json"},
+      {http_method: :get, operation: :get, ids: [], path: "locations.json"},
+      {http_method: :get, operation: :get, ids: [:id], path: "locations/<id>.json"},
+      {http_method: :get, operation: :inventory_levels, ids: [:id], path: "locations/<id>/inventory_levels.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :active
+    sig { returns(T.nilable(String)) }
+    attr_reader :address1
+    sig { returns(T.nilable(String)) }
+    attr_reader :address2
+    sig { returns(T.nilable(String)) }
+    attr_reader :city
+    sig { returns(T.nilable(String)) }
+    attr_reader :country
+    sig { returns(T.nilable(String)) }
+    attr_reader :country_code
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :legacy
+    sig { returns(T.nilable(String)) }
+    attr_reader :localized_country_name
+    sig { returns(T.nilable(String)) }
+    attr_reader :localized_province_name
+    sig { returns(T.nilable(String)) }
+    attr_reader :name
+    sig { returns(T.nilable(String)) }
+    attr_reader :phone
+    sig { returns(T.nilable(String)) }
+    attr_reader :province
+    sig { returns(T.nilable(String)) }
+    attr_reader :province_code
+    sig { returns(T.nilable(String)) }
+    attr_reader :updated_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :zip
+
+    class << self
+      sig do
+        params(
+          id: T.any(Integer, String),
+          session: Auth::Session
+        ).returns(T.nilable(Location))
+      end
+      def find(
+        id:,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {id: id},
+          params: {},
+        )
+        T.cast(result[0], T.nilable(Location))
+      end
+
+      sig do
+        params(
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[Location])
+      end
+      def all(
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[Location])
+      end
+
+      sig do
+        params(
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def count(
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :count,
+          session: session,
+          ids: {},
+          params: {}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+      sig do
+        params(
+          id: T.any(Integer, String),
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def inventory_levels(
+        id:,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :inventory_levels,
+          session: session,
+          ids: {id: id},
+          params: {}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/2024_07/locations_for_move.rb

@@ -0,0 +1,60 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class LocationsForMove < ShopifyAPI::Rest::Base
+    extend T::Sig
+
+    @prev_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @next_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    @api_call_limit = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @retry_request_after = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    sig { params(session: T.nilable(ShopifyAPI::Auth::Session), from_hash: T.nilable(T::Hash[T.untyped, T.untyped])).void }
+    def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
+
+      @locations_for_move = T.let(nil, T.nilable(T::Array[T.untyped]))
+
+      super(session: session, from_hash: from_hash)
+    end
+
+    @has_one = T.let({}, T::Hash[Symbol, Class])
+    @has_many = T.let({}, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :get, operation: :get, ids: [:fulfillment_order_id], path: "fulfillment_orders/<fulfillment_order_id>/locations_for_move.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :locations_for_move
+
+    class << self
+      sig do
+        params(
+          fulfillment_order_id: T.nilable(T.any(Integer, String)),
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[LocationsForMove])
+      end
+      def all(
+        fulfillment_order_id: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {fulfillment_order_id: fulfillment_order_id},
+          params: {}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[LocationsForMove])
+      end
+
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/2024_07/marketing_event.rb

@@ -0,0 +1,213 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class MarketingEvent < ShopifyAPI::Rest::Base
+    extend T::Sig
+
+    @prev_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @next_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    @api_call_limit = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @retry_request_after = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    sig { params(session: T.nilable(ShopifyAPI::Auth::Session), from_hash: T.nilable(T::Hash[T.untyped, T.untyped])).void }
+    def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
+
+      @event_type = T.let(nil, T.nilable(String))
+      @marketing_channel = T.let(nil, T.nilable(String))
+      @paid = T.let(nil, T.nilable(T::Boolean))
+      @started_at = T.let(nil, T.nilable(String))
+      @UTM_parameters = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @budget = T.let(nil, T.nilable(String))
+      @budget_type = T.let(nil, T.nilable(String))
+      @currency = T.let(nil, T.nilable(String))
+      @description = T.let(nil, T.nilable(String))
+      @ended_at = T.let(nil, T.nilable(String))
+      @id = T.let(nil, T.nilable(Integer))
+      @manage_url = T.let(nil, T.nilable(String))
+      @marketed_resources = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @preview_url = T.let(nil, T.nilable(String))
+      @referring_domain = T.let(nil, T.nilable(String))
+      @remote_id = T.let(nil, T.nilable(String))
+      @scheduled_to_end_at = T.let(nil, T.nilable(String))
+
+      super(session: session, from_hash: from_hash)
+    end
+
+    @has_one = T.let({}, T::Hash[Symbol, Class])
+    @has_many = T.let({}, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :delete, operation: :delete, ids: [:id], path: "marketing_events/<id>.json"},
+      {http_method: :get, operation: :count, ids: [], path: "marketing_events/count.json"},
+      {http_method: :get, operation: :get, ids: [], path: "marketing_events.json"},
+      {http_method: :get, operation: :get, ids: [:id], path: "marketing_events/<id>.json"},
+      {http_method: :post, operation: :engagements, ids: [:id], path: "marketing_events/<id>/engagements.json"},
+      {http_method: :post, operation: :post, ids: [], path: "marketing_events.json"},
+      {http_method: :put, operation: :put, ids: [:id], path: "marketing_events/<id>.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :event_type
+    sig { returns(T.nilable(String)) }
+    attr_reader :marketing_channel
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :paid
+    sig { returns(T.nilable(String)) }
+    attr_reader :started_at
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :UTM_parameters
+    sig { returns(T.nilable(String)) }
+    attr_reader :budget
+    sig { returns(T.nilable(String)) }
+    attr_reader :budget_type
+    sig { returns(T.nilable(String)) }
+    attr_reader :currency
+    sig { returns(T.nilable(String)) }
+    attr_reader :description
+    sig { returns(T.nilable(String)) }
+    attr_reader :ended_at
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(String)) }
+    attr_reader :manage_url
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :marketed_resources
+    sig { returns(T.nilable(String)) }
+    attr_reader :preview_url
+    sig { returns(T.nilable(String)) }
+    attr_reader :referring_domain
+    sig { returns(T.nilable(String)) }
+    attr_reader :remote_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :scheduled_to_end_at
+
+    class << self
+      sig do
+        params(
+          id: T.any(Integer, String),
+          session: Auth::Session
+        ).returns(T.nilable(MarketingEvent))
+      end
+      def find(
+        id:,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {id: id},
+          params: {},
+        )
+        T.cast(result[0], T.nilable(MarketingEvent))
+      end
+
+      sig do
+        params(
+          id: T.any(Integer, String),
+          session: Auth::Session
+        ).returns(T.untyped)
+      end
+      def delete(
+        id:,
+        session: ShopifyAPI::Context.active_session
+      )
+        request(
+          http_method: :delete,
+          operation: :delete,
+          session: session,
+          ids: {id: id},
+          params: {},
+        )
+      end
+
+      sig do
+        params(
+          limit: T.untyped,
+          offset: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[MarketingEvent])
+      end
+      def all(
+        limit: nil,
+        offset: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {limit: limit, offset: offset}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[MarketingEvent])
+      end
+
+      sig do
+        params(
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def count(
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :count,
+          session: session,
+          ids: {},
+          params: {}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+    end
+
+    sig do
+      params(
+        occurred_on: T.untyped,
+        impressions_count: T.untyped,
+        views_count: T.untyped,
+        clicks_count: T.untyped,
+        shares_count: T.untyped,
+        favorites_count: T.untyped,
+        comments_count: T.untyped,
+        ad_spend: T.untyped,
+        is_cumulative: T.untyped,
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def engagements(
+      occurred_on: nil,
+      impressions_count: nil,
+      views_count: nil,
+      clicks_count: nil,
+      shares_count: nil,
+      favorites_count: nil,
+      comments_count: nil,
+      ad_spend: nil,
+      is_cumulative: nil,
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :engagements,
+        session: @session,
+        ids: {id: @id},
+        params: {occurred_on: occurred_on, impressions_count: impressions_count, views_count: views_count, clicks_count: clicks_count, shares_count: shares_count, favorites_count: favorites_count, comments_count: comments_count, ad_spend: ad_spend, is_cumulative: is_cumulative}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+  end
+end