shopify_api 11.1.0 → 12.4.0

data/lib/shopify_api/rest/resources/2023_01/product_listing.rb

@@ -0,0 +1,196 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class ProductListing < 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)
+
+    sig { params(session: T.nilable(ShopifyAPI::Auth::Session)).void }
+    def initialize(session: ShopifyAPI::Context.active_session)
+      super(session: session)
+
+      @body_html = T.let(nil, T.nilable(String))
+      @created_at = T.let(nil, T.nilable(String))
+      @handle = T.let(nil, T.nilable(String))
+      @images = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @options = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @product_id = T.let(nil, T.nilable(Integer))
+      @product_type = T.let(nil, T.nilable(String))
+      @published_at = T.let(nil, T.nilable(String))
+      @tags = T.let(nil, T.nilable(String))
+      @title = T.let(nil, T.nilable(String))
+      @updated_at = T.let(nil, T.nilable(String))
+      @variants = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @vendor = T.let(nil, T.nilable(String))
+    end
+
+    @has_one = T.let({}, T::Hash[Symbol, Class])
+    @has_many = T.let({
+      images: Image,
+      variants: Variant
+    }, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :delete, operation: :delete, ids: [:product_id], path: "product_listings/<product_id>.json"},
+      {http_method: :get, operation: :count, ids: [], path: "product_listings/count.json"},
+      {http_method: :get, operation: :get, ids: [], path: "product_listings.json"},
+      {http_method: :get, operation: :get, ids: [:product_id], path: "product_listings/<product_id>.json"},
+      {http_method: :get, operation: :product_ids, ids: [], path: "product_listings/product_ids.json"},
+      {http_method: :put, operation: :put, ids: [:product_id], path: "product_listings/<product_id>.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :body_html
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :handle
+    sig { returns(T.nilable(T::Array[Image])) }
+    attr_reader :images
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :options
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :product_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :product_type
+    sig { returns(T.nilable(String)) }
+    attr_reader :published_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :tags
+    sig { returns(T.nilable(String)) }
+    attr_reader :title
+    sig { returns(T.nilable(String)) }
+    attr_reader :updated_at
+    sig { returns(T.nilable(T::Array[Variant])) }
+    attr_reader :variants
+    sig { returns(T.nilable(String)) }
+    attr_reader :vendor
+
+    class << self
+      sig do
+        returns(String)
+      end
+      def primary_key()
+        "product_id"
+      end
+
+      sig do
+        params(
+          product_id: T.any(Integer, String),
+          session: Auth::Session
+        ).returns(T.nilable(ProductListing))
+      end
+      def find(
+        product_id:,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {product_id: product_id},
+          params: {},
+        )
+        T.cast(result[0], T.nilable(ProductListing))
+      end
+
+      sig do
+        params(
+          product_id: T.any(Integer, String),
+          session: Auth::Session
+        ).returns(T.untyped)
+      end
+      def delete(
+        product_id:,
+        session: ShopifyAPI::Context.active_session
+      )
+        request(
+          http_method: :delete,
+          operation: :delete,
+          session: session,
+          ids: {product_id: product_id},
+          params: {},
+        )
+      end
+
+      sig do
+        params(
+          product_ids: T.untyped,
+          limit: T.untyped,
+          collection_id: T.untyped,
+          updated_at_min: T.untyped,
+          handle: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[ProductListing])
+      end
+      def all(
+        product_ids: nil,
+        limit: nil,
+        collection_id: nil,
+        updated_at_min: nil,
+        handle: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {product_ids: product_ids, limit: limit, collection_id: collection_id, updated_at_min: updated_at_min, handle: handle}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[ProductListing])
+      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(
+          limit: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def product_ids(
+        limit: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :product_ids,
+          session: session,
+          ids: {},
+          params: {limit: limit}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/2023_01/product_resource_feedback.rb

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

data/lib/shopify_api/rest/resources/2023_01/province.rb

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

data/lib/shopify_api/rest/resources/2023_01/recurring_application_charge.rb

@@ -0,0 +1,167 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class RecurringApplicationCharge < 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)
+
+    sig { params(session: T.nilable(ShopifyAPI::Auth::Session)).void }
+    def initialize(session: ShopifyAPI::Context.active_session)
+      super(session: session)
+
+      @activated_on = T.let(nil, T.nilable(String))
+      @billing_on = T.let(nil, T.nilable(String))
+      @cancelled_on = T.let(nil, T.nilable(String))
+      @capped_amount = T.let(nil, T.nilable(T.any(String, Integer)))
+      @confirmation_url = T.let(nil, T.nilable(String))
+      @created_at = T.let(nil, T.nilable(String))
+      @id = T.let(nil, T.nilable(Integer))
+      @name = T.let(nil, T.nilable(String))
+      @price = T.let(nil, T.nilable(T.any(String, Float)))
+      @return_url = T.let(nil, T.nilable(String))
+      @status = T.let(nil, T.nilable(String))
+      @terms = T.let(nil, T.nilable(String))
+      @test = T.let(nil, T.nilable(T::Boolean))
+      @trial_days = T.let(nil, T.nilable(Integer))
+      @trial_ends_on = T.let(nil, T.nilable(String))
+      @updated_at = T.let(nil, T.nilable(String))
+    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: "recurring_application_charges/<id>.json"},
+      {http_method: :get, operation: :get, ids: [], path: "recurring_application_charges.json"},
+      {http_method: :get, operation: :get, ids: [:id], path: "recurring_application_charges/<id>.json"},
+      {http_method: :post, operation: :post, ids: [], path: "recurring_application_charges.json"},
+      {http_method: :put, operation: :customize, ids: [:id], path: "recurring_application_charges/<id>/customize.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :activated_on
+    sig { returns(T.nilable(String)) }
+    attr_reader :billing_on
+    sig { returns(T.nilable(String)) }
+    attr_reader :cancelled_on
+    sig { returns(T.nilable(T.any(String, Integer))) }
+    attr_reader :capped_amount
+    sig { returns(T.nilable(String)) }
+    attr_reader :confirmation_url
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(String)) }
+    attr_reader :name
+    sig { returns(T.nilable(T.any(String, Float))) }
+    attr_reader :price
+    sig { returns(T.nilable(String)) }
+    attr_reader :return_url
+    sig { returns(T.nilable(String)) }
+    attr_reader :status
+    sig { returns(T.nilable(String)) }
+    attr_reader :terms
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :test
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :trial_days
+    sig { returns(T.nilable(String)) }
+    attr_reader :trial_ends_on
+    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(RecurringApplicationCharge))
+      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(RecurringApplicationCharge))
+      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(
+          since_id: T.untyped,
+          fields: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[RecurringApplicationCharge])
+      end
+      def all(
+        since_id: nil,
+        fields: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {since_id: since_id, fields: fields}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[RecurringApplicationCharge])
+      end
+
+    end
+
+    sig do
+      params(
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def customize(
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :put,
+        operation: :customize,
+        session: @session,
+        ids: {id: @id},
+        params: {}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+  end
+end