shopify_api 14.3.0 → 14.4.0

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

@@ -0,0 +1,143 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class Redirect < 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)
+
+      @id = T.let(nil, T.nilable(Integer))
+      @path = T.let(nil, T.nilable(String))
+      @target = 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: "redirects/<id>.json"},
+      {http_method: :get, operation: :count, ids: [], path: "redirects/count.json"},
+      {http_method: :get, operation: :get, ids: [], path: "redirects.json"},
+      {http_method: :get, operation: :get, ids: [:id], path: "redirects/<id>.json"},
+      {http_method: :post, operation: :post, ids: [], path: "redirects.json"},
+      {http_method: :put, operation: :put, ids: [:id], path: "redirects/<id>.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(String)) }
+    attr_reader :path
+    sig { returns(T.nilable(String)) }
+    attr_reader :target
+
+    class << self
+      sig do
+        params(
+          id: T.any(Integer, String),
+          fields: T.untyped,
+          session: Auth::Session
+        ).returns(T.nilable(Redirect))
+      end
+      def find(
+        id:,
+        fields: nil,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {id: id},
+          params: {fields: fields},
+        )
+        T.cast(result[0], T.nilable(Redirect))
+      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,
+          since_id: T.untyped,
+          path: T.untyped,
+          target: T.untyped,
+          fields: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[Redirect])
+      end
+      def all(
+        limit: nil,
+        since_id: nil,
+        path: nil,
+        target: nil,
+        fields: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {limit: limit, since_id: since_id, path: path, target: target, fields: fields}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[Redirect])
+      end
+
+      sig do
+        params(
+          path: T.untyped,
+          target: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def count(
+        path: nil,
+        target: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :count,
+          session: session,
+          ids: {},
+          params: {path: path, target: target}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,155 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class Refund < 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)
+
+      @created_at = T.let(nil, T.nilable(String))
+      @duties = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @id = T.let(nil, T.nilable(Integer))
+      @note = T.let(nil, T.nilable(String))
+      @order_adjustments = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @order_id = T.let(nil, T.nilable(Integer))
+      @processed_at = T.let(nil, T.nilable(String))
+      @refund_duties = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @refund_line_items = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @restock = T.let(nil, T.nilable(T::Boolean))
+      @transactions = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @user_id = T.let(nil, T.nilable(Integer))
+
+      super(session: session, from_hash: from_hash)
+    end
+
+    @has_one = T.let({}, T::Hash[Symbol, Class])
+    @has_many = T.let({
+      transactions: Transaction
+    }, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :get, operation: :get, ids: [:order_id], path: "orders/<order_id>/refunds.json"},
+      {http_method: :get, operation: :get, ids: [:order_id, :id], path: "orders/<order_id>/refunds/<id>.json"},
+      {http_method: :post, operation: :calculate, ids: [:order_id], path: "orders/<order_id>/refunds/calculate.json"},
+      {http_method: :post, operation: :post, ids: [:order_id], path: "orders/<order_id>/refunds.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :duties
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(String)) }
+    attr_reader :note
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :order_adjustments
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :order_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :processed_at
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :refund_duties
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :refund_line_items
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :restock
+    sig { returns(T.nilable(T::Array[Transaction])) }
+    attr_reader :transactions
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :user_id
+
+    class << self
+      sig do
+        params(
+          id: T.any(Integer, String),
+          order_id: T.nilable(T.any(Integer, String)),
+          fields: T.untyped,
+          in_shop_currency: T.untyped,
+          session: Auth::Session
+        ).returns(T.nilable(Refund))
+      end
+      def find(
+        id:,
+        order_id: nil,
+        fields: nil,
+        in_shop_currency: nil,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {id: id, order_id: order_id},
+          params: {fields: fields, in_shop_currency: in_shop_currency},
+        )
+        T.cast(result[0], T.nilable(Refund))
+      end
+
+      sig do
+        params(
+          order_id: T.nilable(T.any(Integer, String)),
+          limit: T.untyped,
+          fields: T.untyped,
+          in_shop_currency: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[Refund])
+      end
+      def all(
+        order_id: nil,
+        limit: nil,
+        fields: nil,
+        in_shop_currency: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {order_id: order_id},
+          params: {limit: limit, fields: fields, in_shop_currency: in_shop_currency}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[Refund])
+      end
+
+    end
+
+    sig do
+      params(
+        shipping: T.untyped,
+        refund_line_items: T.untyped,
+        currency: T.untyped,
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def calculate(
+      shipping: nil,
+      refund_line_items: nil,
+      currency: nil,
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :calculate,
+        session: @session,
+        ids: {order_id: @order_id},
+        params: {shipping: shipping, refund_line_items: refund_line_items, currency: currency}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+  end
+end

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

@@ -0,0 +1,77 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class ResourceFeedback < 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)
+
+      @created_at = T.let(nil, T.nilable(String))
+      @feedback_generated_at = T.let(nil, T.nilable(String))
+      @messages = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @resource_id = T.let(nil, T.nilable(Integer))
+      @resource_type = T.let(nil, T.nilable(String))
+      @state = T.let(nil, T.nilable(String))
+      @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: :get, operation: :get, ids: [], path: "resource_feedback.json"},
+      {http_method: :post, operation: :post, ids: [], path: "resource_feedback.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :feedback_generated_at
+    sig { returns(T.nilable(T::Array[String])) }
+    attr_reader :messages
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :resource_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :resource_type
+    sig { returns(T.nilable(String)) }
+    attr_reader :state
+    sig { returns(T.nilable(String)) }
+    attr_reader :updated_at
+
+    class << self
+      sig do
+        params(
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[ResourceFeedback])
+      end
+      def all(
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[ResourceFeedback])
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,159 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class ScriptTag < 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 = T.let(nil, T.nilable(String))
+      @src = T.let(nil, T.nilable(String))
+      @cache = T.let(nil, T.nilable(T::Boolean))
+      @created_at = T.let(nil, T.nilable(String))
+      @display_scope = T.let(nil, T.nilable(String))
+      @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: [:id], path: "script_tags/<id>.json"},
+      {http_method: :get, operation: :count, ids: [], path: "script_tags/count.json"},
+      {http_method: :get, operation: :get, ids: [], path: "script_tags.json"},
+      {http_method: :get, operation: :get, ids: [:id], path: "script_tags/<id>.json"},
+      {http_method: :post, operation: :post, ids: [], path: "script_tags.json"},
+      {http_method: :put, operation: :put, ids: [:id], path: "script_tags/<id>.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :event
+    sig { returns(T.nilable(String)) }
+    attr_reader :src
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :cache
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :display_scope
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(String)) }
+    attr_reader :updated_at
+
+    class << self
+      sig do
+        params(
+          id: T.any(Integer, String),
+          fields: T.untyped,
+          session: Auth::Session
+        ).returns(T.nilable(ScriptTag))
+      end
+      def find(
+        id:,
+        fields: nil,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {id: id},
+          params: {fields: fields},
+        )
+        T.cast(result[0], T.nilable(ScriptTag))
+      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,
+          since_id: T.untyped,
+          created_at_min: T.untyped,
+          created_at_max: T.untyped,
+          updated_at_min: T.untyped,
+          updated_at_max: T.untyped,
+          src: T.untyped,
+          fields: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[ScriptTag])
+      end
+      def all(
+        limit: nil,
+        since_id: nil,
+        created_at_min: nil,
+        created_at_max: nil,
+        updated_at_min: nil,
+        updated_at_max: nil,
+        src: nil,
+        fields: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {limit: limit, since_id: since_id, created_at_min: created_at_min, created_at_max: created_at_max, updated_at_min: updated_at_min, updated_at_max: updated_at_max, src: src, fields: fields}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[ScriptTag])
+      end
+
+      sig do
+        params(
+          src: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def count(
+        src: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :count,
+          session: session,
+          ids: {},
+          params: {src: src}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,87 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class ShippingZone < 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)
+
+      @carrier_shipping_rate_providers = T.let(nil, T.untyped)
+      @countries = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @id = T.let(nil, T.nilable(Integer))
+      @location_group_id = T.let(nil, T.nilable(String))
+      @name = T.let(nil, T.nilable(String))
+      @price_based_shipping_rates = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @profile_id = T.let(nil, T.nilable(String))
+      @provinces = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @weight_based_shipping_rates = 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({
+      countries: Country,
+      provinces: Province
+    }, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :get, operation: :get, ids: [], path: "shipping_zones.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.untyped) }
+    attr_reader :carrier_shipping_rate_providers
+    sig { returns(T.nilable(T::Array[Country])) }
+    attr_reader :countries
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(String)) }
+    attr_reader :location_group_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :name
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :price_based_shipping_rates
+    sig { returns(T.nilable(String)) }
+    attr_reader :profile_id
+    sig { returns(T.nilable(T::Array[Province])) }
+    attr_reader :provinces
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :weight_based_shipping_rates
+
+    class << self
+      sig do
+        params(
+          fields: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[ShippingZone])
+      end
+      def all(
+        fields: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {fields: fields}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[ShippingZone])
+      end
+
+    end
+
+  end
+end