shopify_api 12.2.1 → 12.4.0

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

@@ -0,0 +1,275 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class DraftOrder < 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)
+
+      @applied_discount = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @billing_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @completed_at = T.let(nil, T.nilable(String))
+      @created_at = T.let(nil, T.nilable(String))
+      @currency = T.let(nil, T.nilable(String))
+      @customer = T.let(nil, T.nilable(Customer))
+      @email = T.let(nil, T.nilable(String))
+      @id = T.let(nil, T.nilable(Integer))
+      @invoice_sent_at = T.let(nil, T.nilable(String))
+      @invoice_url = T.let(nil, T.nilable(String))
+      @line_items = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @name = T.let(nil, T.nilable(String))
+      @note = T.let(nil, T.nilable(String))
+      @note_attributes = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @order_id = T.let(nil, T.nilable(Integer))
+      @payment_terms = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @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]))
+      @source_name = T.let(nil, T.nilable(String))
+      @status = T.let(nil, T.nilable(String))
+      @subtotal_price = T.let(nil, T.nilable(Float))
+      @tags = T.let(nil, T.nilable(String))
+      @tax_exempt = T.let(nil, T.nilable(T::Boolean))
+      @tax_exemptions = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @tax_lines = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @taxes_included = T.let(nil, T.nilable(T::Boolean))
+      @total_price = T.let(nil, T.nilable(String))
+      @total_tax = T.let(nil, T.nilable(String))
+      @updated_at = T.let(nil, T.nilable(String))
+    end
+
+    @has_one = T.let({
+      customer: Customer
+    }, T::Hash[Symbol, Class])
+    @has_many = T.let({}, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :delete, operation: :delete, ids: [:id], path: "draft_orders/<id>.json"},
+      {http_method: :get, operation: :count, ids: [], path: "draft_orders/count.json"},
+      {http_method: :get, operation: :get, ids: [], path: "draft_orders.json"},
+      {http_method: :get, operation: :get, ids: [:id], path: "draft_orders/<id>.json"},
+      {http_method: :post, operation: :post, ids: [], path: "draft_orders.json"},
+      {http_method: :post, operation: :send_invoice, ids: [:id], path: "draft_orders/<id>/send_invoice.json"},
+      {http_method: :put, operation: :complete, ids: [:id], path: "draft_orders/<id>/complete.json"},
+      {http_method: :put, operation: :put, ids: [:id], path: "draft_orders/<id>.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 :applied_discount
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :billing_address
+    sig { returns(T.nilable(String)) }
+    attr_reader :completed_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :currency
+    sig { returns(T.nilable(Customer)) }
+    attr_reader :customer
+    sig { returns(T.nilable(String)) }
+    attr_reader :email
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(String)) }
+    attr_reader :invoice_sent_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :invoice_url
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :line_items
+    sig { returns(T.nilable(String)) }
+    attr_reader :name
+    sig { returns(T.nilable(String)) }
+    attr_reader :note
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :note_attributes
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :order_id
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :payment_terms
+    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(String)) }
+    attr_reader :source_name
+    sig { returns(T.nilable(String)) }
+    attr_reader :status
+    sig { returns(T.nilable(Float)) }
+    attr_reader :subtotal_price
+    sig { returns(T.nilable(String)) }
+    attr_reader :tags
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :tax_exempt
+    sig { returns(T.nilable(T::Array[String])) }
+    attr_reader :tax_exemptions
+    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 :total_price
+    sig { returns(T.nilable(String)) }
+    attr_reader :total_tax
+    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(DraftOrder))
+      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(DraftOrder))
+      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,
+          limit: T.untyped,
+          since_id: T.untyped,
+          updated_at_min: T.untyped,
+          updated_at_max: T.untyped,
+          ids: T.untyped,
+          status: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[DraftOrder])
+      end
+      def all(
+        fields: nil,
+        limit: nil,
+        since_id: nil,
+        updated_at_min: nil,
+        updated_at_max: nil,
+        ids: nil,
+        status: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {fields: fields, limit: limit, since_id: since_id, updated_at_min: updated_at_min, updated_at_max: updated_at_max, ids: ids, status: status}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[DraftOrder])
+      end
+
+      sig do
+        params(
+          since_id: T.untyped,
+          status: T.untyped,
+          updated_at_max: T.untyped,
+          updated_at_min: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def count(
+        since_id: nil,
+        status: nil,
+        updated_at_max: nil,
+        updated_at_min: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :count,
+          session: session,
+          ids: {},
+          params: {since_id: since_id, status: status, updated_at_max: updated_at_max, updated_at_min: updated_at_min}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+    end
+
+    sig do
+      params(
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def send_invoice(
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :send_invoice,
+        session: @session,
+        ids: {id: @id},
+        params: {}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+    sig do
+      params(
+        payment_gateway_id: T.untyped,
+        payment_pending: T.untyped,
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def complete(
+      payment_gateway_id: nil,
+      payment_pending: nil,
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :put,
+        operation: :complete,
+        session: @session,
+        ids: {id: @id},
+        params: {payment_gateway_id: payment_gateway_id, payment_pending: payment_pending}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+  end
+end

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

@@ -0,0 +1,148 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class Event < 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)
+
+      @arguments = T.let(nil, T.nilable(String))
+      @body = T.let(nil, T.nilable(String))
+      @created_at = T.let(nil, T.nilable(String))
+      @description = T.let(nil, T.nilable(String))
+      @id = T.let(nil, T.nilable(Integer))
+      @message = T.let(nil, T.nilable(String))
+      @path = T.let(nil, T.nilable(String))
+      @subject_id = T.let(nil, T.nilable(Integer))
+      @subject_type = T.let(nil, T.nilable(String))
+      @verb = 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: [], path: "events/count.json"},
+      {http_method: :get, operation: :get, ids: [], path: "events.json"},
+      {http_method: :get, operation: :get, ids: [:id], path: "events/<id>.json"},
+      {http_method: :get, operation: :get, ids: [:order_id], path: "orders/<order_id>/events.json"},
+      {http_method: :get, operation: :get, ids: [:product_id], path: "products/<product_id>/events.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :arguments
+    sig { returns(T.nilable(String)) }
+    attr_reader :body
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :description
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(String)) }
+    attr_reader :message
+    sig { returns(T.nilable(String)) }
+    attr_reader :path
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :subject_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :subject_type
+    sig { returns(T.nilable(String)) }
+    attr_reader :verb
+
+    class << self
+      sig do
+        params(
+          id: T.any(Integer, String),
+          fields: T.untyped,
+          session: Auth::Session
+        ).returns(T.nilable(Event))
+      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(Event))
+      end
+
+      sig do
+        params(
+          order_id: T.nilable(T.any(Integer, String)),
+          product_id: T.nilable(T.any(Integer, String)),
+          limit: T.untyped,
+          since_id: T.untyped,
+          created_at_min: T.untyped,
+          created_at_max: T.untyped,
+          filter: T.untyped,
+          verb: T.untyped,
+          fields: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[Event])
+      end
+      def all(
+        order_id: nil,
+        product_id: nil,
+        limit: nil,
+        since_id: nil,
+        created_at_min: nil,
+        created_at_max: nil,
+        filter: nil,
+        verb: nil,
+        fields: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {order_id: order_id, product_id: product_id},
+          params: {limit: limit, since_id: since_id, created_at_min: created_at_min, created_at_max: created_at_max, filter: filter, verb: verb, fields: fields}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[Event])
+      end
+
+      sig do
+        params(
+          created_at_min: T.untyped,
+          created_at_max: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def count(
+        created_at_min: nil,
+        created_at_max: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :count,
+          session: session,
+          ids: {},
+          params: {created_at_min: created_at_min, created_at_max: created_at_max}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,225 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class Fulfillment < 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))
+      @line_items = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @location_id = T.let(nil, T.nilable(Integer))
+      @name = T.let(nil, T.nilable(String))
+      @notify_customer = T.let(nil, T.nilable(T::Boolean))
+      @order_id = T.let(nil, T.nilable(Integer))
+      @origin_address = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @receipt = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @service = T.let(nil, T.nilable(String))
+      @shipment_status = T.let(nil, T.nilable(String))
+      @status = T.let(nil, T.nilable(String))
+      @tracking_company = T.let(nil, T.nilable(String))
+      @tracking_numbers = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @tracking_urls = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @updated_at = T.let(nil, T.nilable(String))
+      @variant_inventory_management = 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: [:order_id], path: "orders/<order_id>/fulfillments/count.json"},
+      {http_method: :get, operation: :get, ids: [:fulfillment_order_id], path: "fulfillment_orders/<fulfillment_order_id>/fulfillments.json"},
+      {http_method: :get, operation: :get, ids: [:order_id], path: "orders/<order_id>/fulfillments.json"},
+      {http_method: :get, operation: :get, ids: [:order_id, :id], path: "orders/<order_id>/fulfillments/<id>.json"},
+      {http_method: :post, operation: :cancel, ids: [:id], path: "fulfillments/<id>/cancel.json"},
+      {http_method: :post, operation: :post, ids: [], path: "fulfillments.json"},
+      {http_method: :post, operation: :update_tracking, ids: [:id], path: "fulfillments/<id>/update_tracking.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(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :line_items
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :location_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :name
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :notify_customer
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :order_id
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :origin_address
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :receipt
+    sig { returns(T.nilable(String)) }
+    attr_reader :service
+    sig { returns(T.nilable(String)) }
+    attr_reader :shipment_status
+    sig { returns(T.nilable(String)) }
+    attr_reader :status
+    sig { returns(T.nilable(String)) }
+    attr_reader :tracking_company
+    sig { returns(T.nilable(T::Array[String])) }
+    attr_reader :tracking_numbers
+    sig { returns(T.nilable(T::Array[String])) }
+    attr_reader :tracking_urls
+    sig { returns(T.nilable(String)) }
+    attr_reader :updated_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :variant_inventory_management
+
+    class << self
+      sig do
+        params(
+          id: T.any(Integer, String),
+          order_id: T.nilable(T.any(Integer, String)),
+          fields: T.untyped,
+          session: Auth::Session
+        ).returns(T.nilable(Fulfillment))
+      end
+      def find(
+        id:,
+        order_id: nil,
+        fields: nil,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {id: id, order_id: order_id},
+          params: {fields: fields},
+        )
+        T.cast(result[0], T.nilable(Fulfillment))
+      end
+
+      sig do
+        params(
+          fulfillment_order_id: T.nilable(T.any(Integer, String)),
+          order_id: T.nilable(T.any(Integer, String)),
+          created_at_max: T.untyped,
+          created_at_min: T.untyped,
+          fields: T.untyped,
+          limit: T.untyped,
+          since_id: T.untyped,
+          updated_at_max: T.untyped,
+          updated_at_min: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[Fulfillment])
+      end
+      def all(
+        fulfillment_order_id: nil,
+        order_id: nil,
+        created_at_max: nil,
+        created_at_min: nil,
+        fields: nil,
+        limit: nil,
+        since_id: nil,
+        updated_at_max: nil,
+        updated_at_min: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {fulfillment_order_id: fulfillment_order_id, order_id: order_id},
+          params: {created_at_max: created_at_max, created_at_min: created_at_min, fields: fields, limit: limit, since_id: since_id, updated_at_max: updated_at_max, updated_at_min: updated_at_min}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[Fulfillment])
+      end
+
+      sig do
+        params(
+          order_id: T.nilable(T.any(Integer, String)),
+          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 count(
+        order_id: 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: :count,
+          session: session,
+          ids: {order_id: order_id},
+          params: {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 cancel(
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :cancel,
+        session: @session,
+        ids: {id: @id},
+        params: {}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+    sig do
+      params(
+        notify_customer: T.untyped,
+        tracking_info: T.untyped,
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def update_tracking(
+      notify_customer: nil,
+      tracking_info: nil,
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :update_tracking,
+        session: @session,
+        ids: {id: @id},
+        params: {notify_customer: notify_customer, tracking_info: tracking_info}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+  end
+end