shopify_api 4.13.0 → 12.2.1

data/lib/shopify_api/rest/resources/2022_01/checkout.rb

@@ -0,0 +1,209 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class Checkout < 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)
+
+      @billing_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @line_items = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @applied_discount = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @buyer_accepts_marketing = T.let(nil, T.nilable(T::Boolean))
+      @created_at = T.let(nil, T.nilable(String))
+      @currency = T.let(nil, T.nilable(String))
+      @customer_id = T.let(nil, T.nilable(Integer))
+      @discount_code = T.let(nil, T.nilable(DiscountCode))
+      @email = T.let(nil, T.nilable(String))
+      @gift_cards = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @order = T.let(nil, T.nilable(Order))
+      @payment_due = T.let(nil, T.nilable(String))
+      @payment_url = T.let(nil, T.nilable(String))
+      @phone = T.let(nil, T.nilable(String))
+      @presentment_currency = T.let(nil, T.nilable(String))
+      @requires_shipping = T.let(nil, T.nilable(T::Boolean))
+      @reservation_time = T.let(nil, T.nilable(String))
+      @reservation_time_left = T.let(nil, T.nilable(Integer))
+      @shipping_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @shipping_line = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @shipping_rate = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @source_identifier = T.let(nil, T.nilable(String))
+      @source_name = T.let(nil, T.nilable(String))
+      @source_url = T.let(nil, T.nilable(String))
+      @subtotal_price = T.let(nil, T.nilable(String))
+      @tax_lines = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @taxes_included = T.let(nil, T.nilable(T::Boolean))
+      @token = T.let(nil, T.nilable(String))
+      @total_price = T.let(nil, T.nilable(String))
+      @total_tax = T.let(nil, T.nilable(String))
+      @updated_at = T.let(nil, T.nilable(String))
+      @user_id = T.let(nil, T.nilable(Integer))
+      @web_url = T.let(nil, T.nilable(String))
+    end
+
+    @has_one = T.let({
+      discount_code: DiscountCode,
+      order: Order
+    }, T::Hash[Symbol, Class])
+    @has_many = T.let({
+      gift_cards: GiftCard
+    }, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :get, operation: :get, ids: [:token], path: "checkouts/<token>.json"},
+      {http_method: :get, operation: :shipping_rates, ids: [:token], path: "checkouts/<token>/shipping_rates.json"},
+      {http_method: :post, operation: :complete, ids: [:token], path: "checkouts/<token>/complete.json"},
+      {http_method: :post, operation: :post, ids: [], path: "checkouts.json"},
+      {http_method: :put, operation: :put, ids: [:token], path: "checkouts/<token>.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :billing_address
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :line_items
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :applied_discount
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :buyer_accepts_marketing
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :currency
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :customer_id
+    sig { returns(T.nilable(DiscountCode)) }
+    attr_reader :discount_code
+    sig { returns(T.nilable(String)) }
+    attr_reader :email
+    sig { returns(T.nilable(T::Array[GiftCard])) }
+    attr_reader :gift_cards
+    sig { returns(T.nilable(Order)) }
+    attr_reader :order
+    sig { returns(T.nilable(String)) }
+    attr_reader :payment_due
+    sig { returns(T.nilable(String)) }
+    attr_reader :payment_url
+    sig { returns(T.nilable(String)) }
+    attr_reader :phone
+    sig { returns(T.nilable(String)) }
+    attr_reader :presentment_currency
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :requires_shipping
+    sig { returns(T.nilable(String)) }
+    attr_reader :reservation_time
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :reservation_time_left
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :shipping_address
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :shipping_line
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :shipping_rate
+    sig { returns(T.nilable(String)) }
+    attr_reader :source_identifier
+    sig { returns(T.nilable(String)) }
+    attr_reader :source_name
+    sig { returns(T.nilable(String)) }
+    attr_reader :source_url
+    sig { returns(T.nilable(String)) }
+    attr_reader :subtotal_price
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :tax_lines
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :taxes_included
+    sig { returns(T.nilable(String)) }
+    attr_reader :token
+    sig { returns(T.nilable(String)) }
+    attr_reader :total_price
+    sig { returns(T.nilable(String)) }
+    attr_reader :total_tax
+    sig { returns(T.nilable(String)) }
+    attr_reader :updated_at
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :user_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :web_url
+
+    class << self
+      sig do
+        returns(String)
+      end
+      def primary_key()
+        "token"
+      end
+
+      sig do
+        params(
+          token: T.any(Integer, String),
+          session: Auth::Session
+        ).returns(T.nilable(Checkout))
+      end
+      def find(
+        token:,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {token: token},
+          params: {},
+        )
+        T.cast(result[0], T.nilable(Checkout))
+      end
+
+      sig do
+        params(
+          token: T.any(Integer, String),
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def shipping_rates(
+        token:,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :shipping_rates,
+          session: session,
+          ids: {token: token},
+          params: {}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+    end
+
+    sig do
+      params(
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def complete(
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :complete,
+        session: @session,
+        ids: {token: @token},
+        params: {}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/2022_01/collect.rb

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

data/lib/shopify_api/rest/resources/2022_01/collection.rb

@@ -0,0 +1,110 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class Collection < 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))
+      @body_html = T.let(nil, T.nilable(String))
+      @handle = T.let(nil, T.nilable(String))
+      @id = T.let(nil, T.nilable(Integer))
+      @image = T.let(nil, T.nilable(Image))
+      @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({
+      image: Image
+    }, T::Hash[Symbol, Class])
+    @has_many = T.let({}, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :get, operation: :get, ids: [:id], path: "collections/<id>.json"},
+      {http_method: :get, operation: :products, ids: [:id], path: "collections/<id>/products.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 :body_html
+    sig { returns(T.nilable(String)) }
+    attr_reader :handle
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(Image)) }
+    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(Collection))
+      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(Collection))
+      end
+
+      sig do
+        params(
+          id: T.any(Integer, String),
+          limit: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def products(
+        id:,
+        limit: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :products,
+          session: session,
+          ids: {id: id},
+          params: {limit: limit}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/2022_01/collection_listing.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 CollectionListing < 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))
+      @collection_id = T.let(nil, T.nilable(Integer))
+      @default_product_image = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @handle = T.let(nil, T.nilable(String))
+      @image = T.let(nil, T.nilable(Image))
+      @published_at = T.let(nil, T.nilable(String))
+      @sort_order = T.let(nil, T.nilable(String))
+      @title = T.let(nil, T.nilable(String))
+      @updated_at = T.let(nil, T.nilable(String))
+    end
+
+    @has_one = T.let({
+      image: Image
+    }, T::Hash[Symbol, Class])
+    @has_many = T.let({}, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :delete, operation: :delete, ids: [:collection_id], path: "collection_listings/<collection_id>.json"},
+      {http_method: :get, operation: :get, ids: [], path: "collection_listings.json"},
+      {http_method: :get, operation: :get, ids: [:collection_id], path: "collection_listings/<collection_id>.json"},
+      {http_method: :get, operation: :product_ids, ids: [:collection_id], path: "collection_listings/<collection_id>/product_ids.json"},
+      {http_method: :put, operation: :put, ids: [:collection_id], path: "collection_listings/<collection_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(Integer)) }
+    attr_reader :collection_id
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :default_product_image
+    sig { returns(T.nilable(String)) }
+    attr_reader :handle
+    sig { returns(T.nilable(Image)) }
+    attr_reader :image
+    sig { returns(T.nilable(String)) }
+    attr_reader :published_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :sort_order
+    sig { returns(T.nilable(String)) }
+    attr_reader :title
+    sig { returns(T.nilable(String)) }
+    attr_reader :updated_at
+
+    class << self
+      sig do
+        returns(String)
+      end
+      def primary_key()
+        "collection_id"
+      end
+
+      sig do
+        params(
+          collection_id: T.any(Integer, String),
+          session: Auth::Session
+        ).returns(T.nilable(CollectionListing))
+      end
+      def find(
+        collection_id:,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {collection_id: collection_id},
+          params: {},
+        )
+        T.cast(result[0], T.nilable(CollectionListing))
+      end
+
+      sig do
+        params(
+          collection_id: T.any(Integer, String),
+          session: Auth::Session
+        ).returns(T.untyped)
+      end
+      def delete(
+        collection_id:,
+        session: ShopifyAPI::Context.active_session
+      )
+        request(
+          http_method: :delete,
+          operation: :delete,
+          session: session,
+          ids: {collection_id: collection_id},
+          params: {},
+        )
+      end
+
+      sig do
+        params(
+          limit: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[CollectionListing])
+      end
+      def all(
+        limit: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {limit: limit}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[CollectionListing])
+      end
+
+      sig do
+        params(
+          collection_id: T.any(Integer, String),
+          limit: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def product_ids(
+        collection_id:,
+        limit: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :product_ids,
+          session: session,
+          ids: {collection_id: collection_id},
+          params: {limit: limit}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+    end
+
+  end
+end