shopify_api 13.3.1 → 13.4.0

data/lib/shopify_api/rest/resources/2024_01/fulfillment_event.rb

@@ -0,0 +1,170 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class FulfillmentEvent < 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)
+
+    @api_call_limit = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @retry_request_after = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    sig { params(session: T.nilable(ShopifyAPI::Auth::Session), from_hash: T.nilable(T::Hash[T.untyped, T.untyped])).void }
+    def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
+
+      @address1 = T.let(nil, T.nilable(String))
+      @city = T.let(nil, T.nilable(String))
+      @country = T.let(nil, T.nilable(Country))
+      @created_at = T.let(nil, T.nilable(String))
+      @estimated_delivery_at = T.let(nil, T.nilable(String))
+      @fulfillment_id = T.let(nil, T.nilable(Integer))
+      @happened_at = T.let(nil, T.nilable(String))
+      @id = T.let(nil, T.nilable(Integer))
+      @latitude = T.let(nil, T.nilable(Float))
+      @longitude = T.let(nil, T.nilable(Float))
+      @message = T.let(nil, T.nilable(String))
+      @order_id = T.let(nil, T.nilable(Integer))
+      @province = T.let(nil, T.nilable(Province))
+      @shop_id = T.let(nil, T.nilable(Integer))
+      @status = T.let(nil, T.nilable(String))
+      @updated_at = T.let(nil, T.nilable(String))
+      @zip = T.let(nil, T.nilable(String))
+
+      super(session: session, from_hash: from_hash)
+    end
+
+    @has_one = T.let({
+      country: Country,
+      province: Province
+    }, T::Hash[Symbol, Class])
+    @has_many = T.let({}, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :delete, operation: :delete, ids: [:order_id, :fulfillment_id, :id], path: "orders/<order_id>/fulfillments/<fulfillment_id>/events/<id>.json"},
+      {http_method: :get, operation: :get, ids: [:order_id, :fulfillment_id], path: "orders/<order_id>/fulfillments/<fulfillment_id>/events.json"},
+      {http_method: :get, operation: :get, ids: [:order_id, :fulfillment_id, :id], path: "orders/<order_id>/fulfillments/<fulfillment_id>/events/<id>.json"},
+      {http_method: :post, operation: :post, ids: [:order_id, :fulfillment_id], path: "orders/<order_id>/fulfillments/<fulfillment_id>/events.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :address1
+    sig { returns(T.nilable(String)) }
+    attr_reader :city
+    sig { returns(T.nilable(Country)) }
+    attr_reader :country
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :estimated_delivery_at
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :fulfillment_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :happened_at
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(Float)) }
+    attr_reader :latitude
+    sig { returns(T.nilable(Float)) }
+    attr_reader :longitude
+    sig { returns(T.nilable(String)) }
+    attr_reader :message
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :order_id
+    sig { returns(T.nilable(Province)) }
+    attr_reader :province
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :shop_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :status
+    sig { returns(T.nilable(String)) }
+    attr_reader :updated_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :zip
+
+    class << self
+      sig do
+        returns(String)
+      end
+      def json_body_name()
+        "event"
+      end
+
+      sig do
+        params(
+          id: T.any(Integer, String),
+          order_id: T.nilable(T.any(Integer, String)),
+          fulfillment_id: T.nilable(T.any(Integer, String)),
+          event_id: T.untyped,
+          session: Auth::Session
+        ).returns(T.nilable(FulfillmentEvent))
+      end
+      def find(
+        id:,
+        order_id: nil,
+        fulfillment_id: nil,
+        event_id: nil,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {id: id, order_id: order_id, fulfillment_id: fulfillment_id},
+          params: {event_id: event_id},
+        )
+        T.cast(result[0], T.nilable(FulfillmentEvent))
+      end
+
+      sig do
+        params(
+          id: T.any(Integer, String),
+          order_id: T.nilable(T.any(Integer, String)),
+          fulfillment_id: T.nilable(T.any(Integer, String)),
+          session: Auth::Session
+        ).returns(T.untyped)
+      end
+      def delete(
+        id:,
+        order_id: nil,
+        fulfillment_id: nil,
+        session: ShopifyAPI::Context.active_session
+      )
+        request(
+          http_method: :delete,
+          operation: :delete,
+          session: session,
+          ids: {id: id, order_id: order_id, fulfillment_id: fulfillment_id},
+          params: {},
+        )
+      end
+
+      sig do
+        params(
+          order_id: T.nilable(T.any(Integer, String)),
+          fulfillment_id: T.nilable(T.any(Integer, String)),
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[FulfillmentEvent])
+      end
+      def all(
+        order_id: nil,
+        fulfillment_id: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {order_id: order_id, fulfillment_id: fulfillment_id},
+          params: {}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[FulfillmentEvent])
+      end
+
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/2024_01/fulfillment_order.rb

@@ -0,0 +1,326 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class FulfillmentOrder < 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)
+
+    @api_call_limit = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @retry_request_after = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    sig { params(session: T.nilable(ShopifyAPI::Auth::Session), from_hash: T.nilable(T::Hash[T.untyped, T.untyped])).void }
+    def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
+
+      @assigned_location = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @assigned_location_id = T.let(nil, T.nilable(Integer))
+      @created_at = T.let(nil, T.nilable(String))
+      @delivery_method = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @destination = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @fulfill_at = T.let(nil, T.nilable(String))
+      @fulfill_by = T.let(nil, T.nilable(String))
+      @fulfillment_holds = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @id = T.let(nil, T.nilable(Integer))
+      @international_duties = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @line_items = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @merchant_requests = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @order_id = T.let(nil, T.nilable(Integer))
+      @request_status = T.let(nil, T.nilable(String))
+      @shop_id = T.let(nil, T.nilable(Integer))
+      @status = T.let(nil, T.nilable(String))
+      @supported_actions = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @updated_at = T.let(nil, T.nilable(String))
+
+      super(session: session, from_hash: from_hash)
+    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: [:id], path: "fulfillment_orders/<id>.json"},
+      {http_method: :get, operation: :get, ids: [:order_id], path: "orders/<order_id>/fulfillment_orders.json"},
+      {http_method: :post, operation: :cancel, ids: [:id], path: "fulfillment_orders/<id>/cancel.json"},
+      {http_method: :post, operation: :close, ids: [:id], path: "fulfillment_orders/<id>/close.json"},
+      {http_method: :post, operation: :hold, ids: [:id], path: "fulfillment_orders/<id>/hold.json"},
+      {http_method: :post, operation: :move, ids: [:id], path: "fulfillment_orders/<id>/move.json"},
+      {http_method: :post, operation: :open, ids: [:id], path: "fulfillment_orders/<id>/open.json"},
+      {http_method: :post, operation: :release_hold, ids: [:id], path: "fulfillment_orders/<id>/release_hold.json"},
+      {http_method: :post, operation: :reschedule, ids: [:id], path: "fulfillment_orders/<id>/reschedule.json"},
+      {http_method: :post, operation: :set_fulfillment_orders_deadline, ids: [], path: "fulfillment_orders/set_fulfillment_orders_deadline.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 :assigned_location
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :assigned_location_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :delivery_method
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :destination
+    sig { returns(T.nilable(String)) }
+    attr_reader :fulfill_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :fulfill_by
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :fulfillment_holds
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :international_duties
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :line_items
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :merchant_requests
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :order_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :request_status
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :shop_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :status
+    sig { returns(T.nilable(T::Array[String])) }
+    attr_reader :supported_actions
+    sig { returns(T.nilable(String)) }
+    attr_reader :updated_at
+
+    class << self
+      sig do
+        params(
+          id: T.any(Integer, String),
+          include_financial_summaries: T.untyped,
+          include_order_reference_fields: T.untyped,
+          session: Auth::Session
+        ).returns(T.nilable(FulfillmentOrder))
+      end
+      def find(
+        id:,
+        include_financial_summaries: nil,
+        include_order_reference_fields: nil,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {id: id},
+          params: {include_financial_summaries: include_financial_summaries, include_order_reference_fields: include_order_reference_fields},
+        )
+        T.cast(result[0], T.nilable(FulfillmentOrder))
+      end
+
+      sig do
+        params(
+          order_id: T.nilable(T.any(Integer, String)),
+          include_financial_summaries: T.untyped,
+          include_order_reference_fields: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[FulfillmentOrder])
+      end
+      def all(
+        order_id: nil,
+        include_financial_summaries: nil,
+        include_order_reference_fields: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {order_id: order_id},
+          params: {include_financial_summaries: include_financial_summaries, include_order_reference_fields: include_order_reference_fields}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[FulfillmentOrder])
+      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(
+        message: T.untyped,
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def close(
+      message: nil,
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :close,
+        session: @session,
+        ids: {id: @id},
+        params: {message: message}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+    sig do
+      params(
+        fulfillment_hold: T.untyped,
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def hold(
+      fulfillment_hold: nil,
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :hold,
+        session: @session,
+        ids: {id: @id},
+        params: {fulfillment_hold: fulfillment_hold}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+    sig do
+      params(
+        fulfillment_order: T.untyped,
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def move(
+      fulfillment_order: nil,
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :move,
+        session: @session,
+        ids: {id: @id},
+        params: {fulfillment_order: fulfillment_order}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+    sig do
+      params(
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def open(
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :open,
+        session: @session,
+        ids: {id: @id},
+        params: {}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+    sig do
+      params(
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def release_hold(
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :release_hold,
+        session: @session,
+        ids: {id: @id},
+        params: {}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+    sig do
+      params(
+        new_fulfill_at: T.untyped,
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def reschedule(
+      new_fulfill_at: nil,
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :reschedule,
+        session: @session,
+        ids: {id: @id},
+        params: {new_fulfill_at: new_fulfill_at}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+    sig do
+      params(
+        fulfillment_order_ids: T.untyped,
+        fulfillment_deadline: T.untyped,
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def set_fulfillment_orders_deadline(
+      fulfillment_order_ids: nil,
+      fulfillment_deadline: nil,
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :set_fulfillment_orders_deadline,
+        session: @session,
+        ids: {},
+        params: {fulfillment_order_ids: fulfillment_order_ids, fulfillment_deadline: fulfillment_deadline}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/2024_01/fulfillment_request.rb

@@ -0,0 +1,101 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class FulfillmentRequest < 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)
+
+    @api_call_limit = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @retry_request_after = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    sig { params(session: T.nilable(ShopifyAPI::Auth::Session), from_hash: T.nilable(T::Hash[T.untyped, T.untyped])).void }
+    def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
+
+      @fulfillment_order_id = T.let(nil, T.nilable(Integer))
+
+      super(session: session, from_hash: from_hash)
+    end
+
+    @has_one = T.let({}, T::Hash[Symbol, Class])
+    @has_many = T.let({}, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :post, operation: :accept, ids: [:fulfillment_order_id], path: "fulfillment_orders/<fulfillment_order_id>/fulfillment_request/accept.json"},
+      {http_method: :post, operation: :post, ids: [:fulfillment_order_id], path: "fulfillment_orders/<fulfillment_order_id>/fulfillment_request.json"},
+      {http_method: :post, operation: :reject, ids: [:fulfillment_order_id], path: "fulfillment_orders/<fulfillment_order_id>/fulfillment_request/reject.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :fulfillment_order_id
+
+    class << self
+      sig do
+        returns(T::Array[String])
+      end
+      def json_response_body_names()
+        [
+          "submitted_fulfillment_order",
+          "fulfillment_order"
+        ]
+      end
+
+    end
+
+    sig do
+      params(
+        message: T.untyped,
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def accept(
+      message: nil,
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :accept,
+        session: @session,
+        ids: {fulfillment_order_id: @fulfillment_order_id},
+        params: {message: message}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+    sig do
+      params(
+        message: T.untyped,
+        reason: T.untyped,
+        line_items: T.untyped,
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def reject(
+      message: nil,
+      reason: nil,
+      line_items: nil,
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :reject,
+        session: @session,
+        ids: {fulfillment_order_id: @fulfillment_order_id},
+        params: {message: message, reason: reason, line_items: line_items}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+  end
+end