shopify_api 9.5.1 → 10.0.0

data/lib/shopify_api/rest/resources/2022_04/smart_collection.rb

@@ -0,0 +1,212 @@
+# typed: false
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class SmartCollection < 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)
+
+      @rules = T.let(nil, T.nilable(T.any(T::Hash[T.untyped, T.untyped], T::Array[T.untyped])))
+      @title = T.let(nil, T.nilable(String))
+      @body_html = T.let(nil, T.nilable(String))
+      @disjunctive = T.let(nil, T.nilable(T::Boolean))
+      @handle = T.let(nil, T.nilable(String))
+      @id = T.let(nil, T.nilable(Integer))
+      @image = T.let(nil, T.nilable(T.any(String, T::Hash[T.untyped, T.untyped])))
+      @published_at = T.let(nil, T.nilable(String))
+      @published_scope = T.let(nil, T.nilable(String))
+      @sort_order = T.let(nil, T.nilable(String))
+      @template_suffix = 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: "smart_collections/<id>.json"},
+      {http_method: :get, operation: :count, ids: [], path: "smart_collections/count.json"},
+      {http_method: :get, operation: :get, ids: [], path: "smart_collections.json"},
+      {http_method: :get, operation: :get, ids: [:id], path: "smart_collections/<id>.json"},
+      {http_method: :post, operation: :post, ids: [], path: "smart_collections.json"},
+      {http_method: :put, operation: :order, ids: [:id], path: "smart_collections/<id>/order.json"},
+      {http_method: :put, operation: :put, ids: [:id], path: "smart_collections/<id>.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(T.any(T::Hash[T.untyped, T.untyped], T::Array[T::Hash[T.untyped, T.untyped]]))) }
+    attr_reader :rules
+    sig { returns(T.nilable(String)) }
+    attr_reader :title
+    sig { returns(T.nilable(String)) }
+    attr_reader :body_html
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :disjunctive
+    sig { returns(T.nilable(String)) }
+    attr_reader :handle
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(T.any(String, T::Hash[T.untyped, T.untyped]))) }
+    attr_reader :image
+    sig { returns(T.nilable(String)) }
+    attr_reader :published_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :published_scope
+    sig { returns(T.nilable(String)) }
+    attr_reader :sort_order
+    sig { returns(T.nilable(String)) }
+    attr_reader :template_suffix
+    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(SmartCollection))
+      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(SmartCollection))
+      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,
+          ids: T.untyped,
+          since_id: T.untyped,
+          title: T.untyped,
+          product_id: T.untyped,
+          handle: T.untyped,
+          updated_at_min: T.untyped,
+          updated_at_max: T.untyped,
+          published_at_min: T.untyped,
+          published_at_max: T.untyped,
+          published_status: T.untyped,
+          fields: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[SmartCollection])
+      end
+      def all(
+        limit: nil,
+        ids: nil,
+        since_id: nil,
+        title: nil,
+        product_id: nil,
+        handle: nil,
+        updated_at_min: nil,
+        updated_at_max: nil,
+        published_at_min: nil,
+        published_at_max: nil,
+        published_status: nil,
+        fields: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {limit: limit, ids: ids, since_id: since_id, title: title, product_id: product_id, handle: handle, updated_at_min: updated_at_min, updated_at_max: updated_at_max, published_at_min: published_at_min, published_at_max: published_at_max, published_status: published_status, fields: fields}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[SmartCollection])
+      end
+
+      sig do
+        params(
+          title: T.untyped,
+          product_id: T.untyped,
+          updated_at_min: T.untyped,
+          updated_at_max: T.untyped,
+          published_at_min: T.untyped,
+          published_at_max: T.untyped,
+          published_status: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def count(
+        title: nil,
+        product_id: nil,
+        updated_at_min: nil,
+        updated_at_max: nil,
+        published_at_min: nil,
+        published_at_max: nil,
+        published_status: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :count,
+          session: session,
+          ids: {},
+          params: {title: title, product_id: product_id, updated_at_min: updated_at_min, updated_at_max: updated_at_max, published_at_min: published_at_min, published_at_max: published_at_max, published_status: published_status}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+    end
+
+    sig do
+      params(
+        products: T.untyped,
+        sort_order: T.untyped,
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def order(
+      products: nil,
+      sort_order: nil,
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :put,
+        operation: :order,
+        session: @session,
+        ids: {id: @id},
+        params: {products: products, sort_order: sort_order}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/2022_04/storefront_access_token.rb

@@ -0,0 +1,83 @@
+# typed: false
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class StorefrontAccessToken < 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)
+
+      @title = T.let(nil, T.nilable(String))
+      @access_scope = T.let(nil, T.nilable(String))
+      @access_token = T.let(nil, T.nilable(String))
+      @created_at = T.let(nil, T.nilable(String))
+      @id = T.let(nil, T.nilable(Integer))
+    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: "storefront_access_tokens/<id>.json"},
+      {http_method: :get, operation: :get, ids: [], path: "storefront_access_tokens.json"},
+      {http_method: :post, operation: :post, ids: [], path: "storefront_access_tokens.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :title
+    sig { returns(T.nilable(String)) }
+    attr_reader :access_scope
+    sig { returns(T.nilable(String)) }
+    attr_reader :access_token
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+
+    class << self
+      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(
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[StorefrontAccessToken])
+      end
+      def all(
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[StorefrontAccessToken])
+      end
+
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/2022_04/tender_transaction.rb

@@ -0,0 +1,89 @@
+# typed: false
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class TenderTransaction < 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)
+
+      @amount = T.let(nil, T.nilable(String))
+      @currency = T.let(nil, T.nilable(String))
+      @id = T.let(nil, T.nilable(Integer))
+      @order_id = T.let(nil, T.nilable(Integer))
+      @payment_details = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @payment_method = T.let(nil, T.nilable(String))
+      @processed_at = T.let(nil, T.nilable(String))
+      @remote_reference = T.let(nil, T.nilable(String))
+      @test = T.let(nil, T.nilable(T::Boolean))
+      @user_id = T.let(nil, T.nilable(Integer))
+    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: "tender_transactions.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :amount
+    sig { returns(T.nilable(String)) }
+    attr_reader :currency
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :order_id
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :payment_details
+    sig { returns(T.nilable(String)) }
+    attr_reader :payment_method
+    sig { returns(T.nilable(String)) }
+    attr_reader :processed_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :remote_reference
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :test
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :user_id
+
+    class << self
+      sig do
+        params(
+          limit: T.untyped,
+          since_id: T.untyped,
+          processed_at_min: T.untyped,
+          processed_at_max: T.untyped,
+          processed_at: T.untyped,
+          order: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[TenderTransaction])
+      end
+      def all(
+        limit: nil,
+        since_id: nil,
+        processed_at_min: nil,
+        processed_at_max: nil,
+        processed_at: nil,
+        order: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {limit: limit, since_id: since_id, processed_at_min: processed_at_min, processed_at_max: processed_at_max, processed_at: processed_at, order: order}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[TenderTransaction])
+      end
+
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/2022_04/theme.rb

@@ -0,0 +1,116 @@
+# typed: false
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class Theme < 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))
+      @id = T.let(nil, T.nilable(Integer))
+      @name = T.let(nil, T.nilable(String))
+      @previewable = T.let(nil, T.nilable(T::Boolean))
+      @processing = T.let(nil, T.nilable(T::Boolean))
+      @role = T.let(nil, T.nilable(String))
+      @theme_store_id = T.let(nil, T.nilable(Integer))
+      @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: "themes/<id>.json"},
+      {http_method: :get, operation: :get, ids: [], path: "themes.json"},
+      {http_method: :get, operation: :get, ids: [:id], path: "themes/<id>.json"},
+      {http_method: :post, operation: :post, ids: [], path: "themes.json"},
+      {http_method: :put, operation: :put, ids: [:id], path: "themes/<id>.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(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(String)) }
+    attr_reader :name
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :previewable
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :processing
+    sig { returns(T.nilable(String)) }
+    attr_reader :role
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :theme_store_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(Theme))
+      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(Theme))
+      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(
+          fields: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[Theme])
+      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[Theme])
+      end
+
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/2022_04/transaction.rb

@@ -0,0 +1,177 @@
+# typed: false
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class Transaction < 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)
+
+      @kind = T.let(nil, T.nilable(String))
+      @amount = T.let(nil, T.nilable(String))
+      @authorization = T.let(nil, T.nilable(String))
+      @authorization_expires_at = T.let(nil, T.nilable(String))
+      @created_at = T.let(nil, T.nilable(String))
+      @currency = T.let(nil, T.nilable(String))
+      @currency_exchange_adjustment = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @device_id = T.let(nil, T.nilable(Integer))
+      @error_code = T.let(nil, T.nilable(String))
+      @extended_authorization_attributes = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @gateway = T.let(nil, T.nilable(String))
+      @id = T.let(nil, T.nilable(Integer))
+      @location_id = T.let(nil, T.nilable(Integer))
+      @message = T.let(nil, T.nilable(String))
+      @order_id = T.let(nil, T.nilable(Integer))
+      @parent_id = T.let(nil, T.nilable(Integer))
+      @payment_details = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @payments_refund_attributes = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @processed_at = T.let(nil, T.nilable(String))
+      @receipt = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @source_name = T.let(nil, T.nilable(String))
+      @status = T.let(nil, T.nilable(String))
+      @test = T.let(nil, T.nilable(T::Boolean))
+      @user_id = T.let(nil, T.nilable(Integer))
+    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: [:order_id], path: "orders/<order_id>/transactions/count.json"},
+      {http_method: :get, operation: :get, ids: [:order_id], path: "orders/<order_id>/transactions.json"},
+      {http_method: :get, operation: :get, ids: [:order_id, :id], path: "orders/<order_id>/transactions/<id>.json"},
+      {http_method: :post, operation: :post, ids: [:order_id], path: "orders/<order_id>/transactions.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :kind
+    sig { returns(T.nilable(String)) }
+    attr_reader :amount
+    sig { returns(T.nilable(String)) }
+    attr_reader :authorization
+    sig { returns(T.nilable(String)) }
+    attr_reader :authorization_expires_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :currency
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :currency_exchange_adjustment
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :device_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :error_code
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :extended_authorization_attributes
+    sig { returns(T.nilable(String)) }
+    attr_reader :gateway
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :location_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :message
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :order_id
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :parent_id
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :payment_details
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :payments_refund_attributes
+    sig { returns(T.nilable(String)) }
+    attr_reader :processed_at
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :receipt
+    sig { returns(T.nilable(String)) }
+    attr_reader :source_name
+    sig { returns(T.nilable(String)) }
+    attr_reader :status
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :test
+    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(Transaction))
+      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(Transaction))
+      end
+
+      sig do
+        params(
+          order_id: T.nilable(T.any(Integer, String)),
+          since_id: T.untyped,
+          fields: T.untyped,
+          in_shop_currency: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[Transaction])
+      end
+      def all(
+        order_id: nil,
+        since_id: nil,
+        fields: nil,
+        in_shop_currency: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {order_id: order_id},
+          params: {since_id: since_id, fields: fields, in_shop_currency: in_shop_currency}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[Transaction])
+      end
+
+      sig do
+        params(
+          order_id: T.nilable(T.any(Integer, String)),
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def count(
+        order_id: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :count,
+          session: session,
+          ids: {order_id: order_id},
+          params: {}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+    end
+
+  end
+end