shopify_api 13.0.0 → 13.1.0

data/lib/shopify_api/rest/resources/2023_07/gift_card.rb

@@ -0,0 +1,218 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class GiftCard < 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)
+
+      @api_client_id = T.let(nil, T.nilable(Integer))
+      @balance = T.let(nil, T.nilable(Balance))
+      @code = T.let(nil, T.nilable(String))
+      @created_at = T.let(nil, T.nilable(String))
+      @currency = T.let(nil, T.nilable(Currency))
+      @customer_id = T.let(nil, T.nilable(Integer))
+      @disabled_at = T.let(nil, T.nilable(String))
+      @expires_on = T.let(nil, T.nilable(String))
+      @id = T.let(nil, T.nilable(Integer))
+      @initial_value = T.let(nil, T.nilable(String))
+      @last_characters = T.let(nil, T.nilable(String))
+      @line_item_id = T.let(nil, T.nilable(Integer))
+      @note = T.let(nil, T.nilable(String))
+      @order_id = T.let(nil, T.nilable(Integer))
+      @template_suffix = T.let(nil, T.nilable(String))
+      @updated_at = T.let(nil, T.nilable(String))
+      @user_id = T.let(nil, T.nilable(Integer))
+    end
+
+    @has_one = T.let({
+      balance: Balance,
+      currency: Currency
+    }, T::Hash[Symbol, Class])
+    @has_many = T.let({}, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :get, operation: :count, ids: [], path: "gift_cards/count.json"},
+      {http_method: :get, operation: :get, ids: [], path: "gift_cards.json"},
+      {http_method: :get, operation: :get, ids: [:id], path: "gift_cards/<id>.json"},
+      {http_method: :get, operation: :search, ids: [], path: "gift_cards/search.json"},
+      {http_method: :post, operation: :disable, ids: [:id], path: "gift_cards/<id>/disable.json"},
+      {http_method: :post, operation: :post, ids: [], path: "gift_cards.json"},
+      {http_method: :put, operation: :put, ids: [:id], path: "gift_cards/<id>.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :api_client_id
+    sig { returns(T.nilable(Balance)) }
+    attr_reader :balance
+    sig { returns(T.nilable(String)) }
+    attr_reader :code
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(Currency)) }
+    attr_reader :currency
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :customer_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :disabled_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :expires_on
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(String)) }
+    attr_reader :initial_value
+    sig { returns(T.nilable(String)) }
+    attr_reader :last_characters
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :line_item_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :note
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :order_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :template_suffix
+    sig { returns(T.nilable(String)) }
+    attr_reader :updated_at
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :user_id
+
+    class << self
+      sig do
+        params(
+          id: T.any(Integer, String),
+          session: Auth::Session
+        ).returns(T.nilable(GiftCard))
+      end
+      def find(
+        id:,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {id: id},
+          params: {},
+        )
+        T.cast(result[0], T.nilable(GiftCard))
+      end
+
+      sig do
+        params(
+          status: T.untyped,
+          limit: T.untyped,
+          since_id: T.untyped,
+          fields: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[GiftCard])
+      end
+      def all(
+        status: nil,
+        limit: nil,
+        since_id: nil,
+        fields: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {status: status, limit: limit, since_id: since_id, fields: fields}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[GiftCard])
+      end
+
+      sig do
+        params(
+          status: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def count(
+        status: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :count,
+          session: session,
+          ids: {},
+          params: {status: status}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+      sig do
+        params(
+          order: T.untyped,
+          query: T.untyped,
+          limit: T.untyped,
+          fields: T.untyped,
+          created_at_min: T.untyped,
+          created_at_max: T.untyped,
+          updated_at_min: T.untyped,
+          updated_at_max: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def search(
+        order: nil,
+        query: nil,
+        limit: nil,
+        fields: nil,
+        created_at_min: nil,
+        created_at_max: nil,
+        updated_at_min: nil,
+        updated_at_max: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :search,
+          session: session,
+          ids: {},
+          params: {order: order, query: query, limit: limit, fields: fields, created_at_min: created_at_min, created_at_max: created_at_max, updated_at_min: updated_at_min, updated_at_max: updated_at_max}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+    end
+
+    sig do
+      params(
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def disable(
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :disable,
+        session: @session,
+        ids: {id: @id},
+        params: {}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/2023_07/gift_card_adjustment.rb

@@ -0,0 +1,118 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class GiftCardAdjustment < 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(Float))
+      @api_client_id = T.let(nil, T.nilable(Integer))
+      @created_at = T.let(nil, T.nilable(String))
+      @gift_card_id = T.let(nil, T.nilable(Integer))
+      @id = T.let(nil, T.nilable(Integer))
+      @note = T.let(nil, T.nilable(String))
+      @number = T.let(nil, T.nilable(Integer))
+      @order_transaction_id = T.let(nil, T.nilable(Integer))
+      @processed_at = T.let(nil, T.nilable(String))
+      @remote_transaction_ref = T.let(nil, T.nilable(String))
+      @remote_transaction_url = T.let(nil, T.nilable(String))
+      @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: [:gift_card_id], path: "gift_cards/<gift_card_id>/adjustments.json"},
+      {http_method: :get, operation: :get, ids: [:gift_card_id, :id], path: "gift_cards/<gift_card_id>/adjustments/<id>.json"},
+      {http_method: :post, operation: :post, ids: [:gift_card_id], path: "gift_cards/<gift_card_id>/adjustments.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(Float)) }
+    attr_reader :amount
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :api_client_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :gift_card_id
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(String)) }
+    attr_reader :note
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :number
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :order_transaction_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :processed_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :remote_transaction_ref
+    sig { returns(T.nilable(String)) }
+    attr_reader :remote_transaction_url
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :user_id
+
+    class << self
+      sig do
+        returns(String)
+      end
+      def json_body_name()
+        "adjustment"
+      end
+
+      sig do
+        params(
+          id: T.any(Integer, String),
+          gift_card_id: T.nilable(T.any(Integer, String)),
+          session: Auth::Session
+        ).returns(T.nilable(GiftCardAdjustment))
+      end
+      def find(
+        id:,
+        gift_card_id: nil,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {id: id, gift_card_id: gift_card_id},
+          params: {},
+        )
+        T.cast(result[0], T.nilable(GiftCardAdjustment))
+      end
+
+      sig do
+        params(
+          gift_card_id: T.nilable(T.any(Integer, String)),
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[GiftCardAdjustment])
+      end
+      def all(
+        gift_card_id: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {gift_card_id: gift_card_id},
+          params: {}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[GiftCardAdjustment])
+      end
+
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/2023_07/image.rb

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

data/lib/shopify_api/rest/resources/2023_07/inventory_item.rb

@@ -0,0 +1,108 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class InventoryItem < 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)
+
+      @cost = T.let(nil, T.nilable(String))
+      @country_code_of_origin = T.let(nil, T.nilable(String))
+      @country_harmonized_system_codes = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @created_at = T.let(nil, T.nilable(String))
+      @harmonized_system_code = T.let(nil, T.nilable(Integer))
+      @id = T.let(nil, T.nilable(Integer))
+      @province_code_of_origin = T.let(nil, T.nilable(String))
+      @requires_shipping = T.let(nil, T.nilable(T::Boolean))
+      @sku = T.let(nil, T.nilable(String))
+      @tracked = T.let(nil, T.nilable(T::Boolean))
+      @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: [], path: "inventory_items.json"},
+      {http_method: :get, operation: :get, ids: [:id], path: "inventory_items/<id>.json"},
+      {http_method: :put, operation: :put, ids: [:id], path: "inventory_items/<id>.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :cost
+    sig { returns(T.nilable(String)) }
+    attr_reader :country_code_of_origin
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :country_harmonized_system_codes
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :harmonized_system_code
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(String)) }
+    attr_reader :province_code_of_origin
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :requires_shipping
+    sig { returns(T.nilable(String)) }
+    attr_reader :sku
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :tracked
+    sig { returns(T.nilable(String)) }
+    attr_reader :updated_at
+
+    class << self
+      sig do
+        params(
+          id: T.any(Integer, String),
+          session: Auth::Session
+        ).returns(T.nilable(InventoryItem))
+      end
+      def find(
+        id:,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {id: id},
+          params: {},
+        )
+        T.cast(result[0], T.nilable(InventoryItem))
+      end
+
+      sig do
+        params(
+          ids: T.untyped,
+          limit: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[InventoryItem])
+      end
+      def all(
+        ids: nil,
+        limit: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {ids: ids, limit: limit}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[InventoryItem])
+      end
+
+    end
+
+  end
+end