listo-delivery 0.1.1

data/lib/listo_delivery/generated/resources/connections.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# GENERATED from Listo's API definition (API 1.37.0). Do not edit by hand:
+# this file is rewritten whenever the SDK is regenerated.
+
+module ListoDelivery
+  module Resources
+    # Operations under "connections".
+    class Connections
+      # @api private
+      def initialize(client)
+        @client = client
+      end
+
+      # Exchange an approval for the store.
+      #
+      # POST /v1/connections
+      # @param body [Hash, nil] request body (also accepted as keywords)
+      # @return [Models::Store]
+      # @raise [ListoDelivery::Error]
+      def create(body = nil, **fields)
+        @client.execute(
+          "POST",
+          "/v1/connections",
+          body: Util.body(body, fields, required: "createConnection"),
+          model: Models::Store
+        )
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/resources/deliveries.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+# GENERATED from Listo's API definition (API 1.37.0). Do not edit by hand:
+# this file is rewritten whenever the SDK is regenerated.
+
+module ListoDelivery
+  module Resources
+    # Operations under "deliveries".
+    class Deliveries
+      # @api private
+      def initialize(client)
+        @client = client
+      end
+
+      # Cancel a delivery.
+      #
+      # POST /v1/deliveries/{delivery_id}/cancellations
+      # @param delivery_id [String]
+      # @param body [Hash, nil] request body (also accepted as keywords)
+      # @return [Models::Delivery]
+      # @raise [ListoDelivery::Error]
+      def cancel(delivery_id, body = nil, **fields)
+        @client.execute(
+          "POST",
+          "/v1/deliveries/#{Util.segment(delivery_id)}/cancellations",
+          body: Util.body(body, fields, required: "cancelDelivery"),
+          model: Models::Delivery
+        )
+      end
+
+      # Create a delivery.
+      #
+      # POST /v1/deliveries
+      # @param body [Hash, nil] request body (also accepted as keywords)
+      # @param idempotency_key [String, nil] your own key; a fresh UUID is sent when omitted
+      # @return [Models::Delivery]
+      # @raise [ListoDelivery::Error]
+      def create(body = nil, idempotency_key: nil, **fields)
+        @client.execute(
+          "POST",
+          "/v1/deliveries",
+          body: Util.body(body, fields, required: "createDelivery"),
+          idempotent: true,
+          idempotency_key: idempotency_key,
+          model: Models::Delivery
+        )
+      end
+
+      # List deliveries.
+      #
+      # GET /v1/deliveries
+      # @param query [Hash, nil] query parameters (also accepted as keywords)
+      # @return [Models::DeliveryList]
+      # @raise [ListoDelivery::Error]
+      def list(query = nil, **fields)
+        @client.execute(
+          "GET",
+          "/v1/deliveries",
+          query: Util.query(query, fields),
+          model: Models::DeliveryList
+        )
+      end
+
+      # Refund a delivery.
+      #
+      # POST /v1/deliveries/{delivery_id}/refunds
+      # @param delivery_id [String]
+      # @param body [Hash, nil] request body (also accepted as keywords)
+      # @param idempotency_key [String, nil] your own key; a fresh UUID is sent when omitted
+      # @return [Models::Delivery]
+      # @raise [ListoDelivery::Error]
+      def refund(delivery_id, body = nil, idempotency_key: nil, **fields)
+        @client.execute(
+          "POST",
+          "/v1/deliveries/#{Util.segment(delivery_id)}/refunds",
+          body: Util.body(body, fields),
+          idempotent: true,
+          idempotency_key: idempotency_key,
+          model: Models::Delivery
+        )
+      end
+
+      # Update a delivery.
+      #
+      # PATCH /v1/deliveries/{id}
+      # @param id [String]
+      # @param body [Hash, nil] request body (also accepted as keywords)
+      # @return [Models::Delivery]
+      # @raise [ListoDelivery::Error]
+      def reschedule(id, body = nil, **fields)
+        @client.execute(
+          "PATCH",
+          "/v1/deliveries/#{Util.segment(id)}",
+          body: Util.body(body, fields, required: "rescheduleDelivery"),
+          model: Models::Delivery
+        )
+      end
+
+      # Fetch a delivery.
+      #
+      # GET /v1/deliveries/{id}
+      # @param id [String]
+      # @return [Models::Delivery]
+      # @raise [ListoDelivery::Error]
+      def retrieve(id)
+        @client.execute(
+          "GET",
+          "/v1/deliveries/#{Util.segment(id)}",
+          model: Models::Delivery
+        )
+      end
+
+      # Retry a failed dispatch.
+      #
+      # POST /v1/deliveries/{delivery_id}/retries
+      # @param delivery_id [String]
+      # @return [Models::Delivery]
+      # @raise [ListoDelivery::Error]
+      def retry(delivery_id)
+        @client.execute(
+          "POST",
+          "/v1/deliveries/#{Util.segment(delivery_id)}/retries",
+          model: Models::Delivery
+        )
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/resources/events.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# GENERATED from Listo's API definition (API 1.37.0). Do not edit by hand:
+# this file is rewritten whenever the SDK is regenerated.
+
+module ListoDelivery
+  module Resources
+    # Operations under "events".
+    class Events
+      # @api private
+      def initialize(client)
+        @client = client
+      end
+
+      # List your webhook events.
+      #
+      # GET /v1/events
+      # @param query [Hash, nil] query parameters (also accepted as keywords)
+      # @return [Models::EventList]
+      # @raise [ListoDelivery::Error]
+      def list(query = nil, **fields)
+        @client.execute(
+          "GET",
+          "/v1/events",
+          query: Util.query(query, fields),
+          model: Models::EventList
+        )
+      end
+
+      # Send a webhook event again.
+      #
+      # POST /v1/events/{event_id}/resend
+      # @param event_id [String]
+      # @return [Models::WebhookEvent]
+      # @raise [ListoDelivery::Error]
+      def resend(event_id)
+        @client.execute(
+          "POST",
+          "/v1/events/#{Util.segment(event_id)}/resend",
+          model: Models::WebhookEvent
+        )
+      end
+
+      # Retrieve a webhook event.
+      #
+      # GET /v1/events/{id}
+      # @param id [String]
+      # @return [Models::WebhookEvent]
+      # @raise [ListoDelivery::Error]
+      def retrieve(id)
+        @client.execute(
+          "GET",
+          "/v1/events/#{Util.segment(id)}",
+          model: Models::WebhookEvent
+        )
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/resources/ledger.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# GENERATED from Listo's API definition (API 1.37.0). Do not edit by hand:
+# this file is rewritten whenever the SDK is regenerated.
+
+module ListoDelivery
+  module Resources
+    # Operations under "ledger".
+    class Ledger
+      # @api private
+      def initialize(client)
+        @client = client
+      end
+
+      # List your ledger entries.
+      #
+      # GET /v1/ledger
+      # @param query [Hash, nil] query parameters (also accepted as keywords)
+      # @return [Models::LedgerEntryList]
+      # @raise [ListoDelivery::Error]
+      def list(query = nil, **fields)
+        @client.execute(
+          "GET",
+          "/v1/ledger",
+          query: Util.query(query, fields),
+          model: Models::LedgerEntryList
+        )
+      end
+
+      # List a store's ledger entries.
+      #
+      # GET /v1/stores/{store_id}/ledger
+      # @param store_id [String]
+      # @param query [Hash, nil] query parameters (also accepted as keywords)
+      # @return [Models::LedgerEntryList]
+      # @raise [ListoDelivery::Error]
+      def list_for_store(store_id, query = nil, **fields)
+        @client.execute(
+          "GET",
+          "/v1/stores/#{Util.segment(store_id)}/ledger",
+          query: Util.query(query, fields),
+          model: Models::LedgerEntryList
+        )
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/resources/quotes.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# GENERATED from Listo's API definition (API 1.37.0). Do not edit by hand:
+# this file is rewritten whenever the SDK is regenerated.
+
+module ListoDelivery
+  module Resources
+    # Operations under "quotes".
+    class Quotes
+      # @api private
+      def initialize(client)
+        @client = client
+      end
+
+      # Price a delivery.
+      #
+      # POST /v1/quotes
+      # @param body [Hash, nil] request body (also accepted as keywords)
+      # @return [Models::Quote]
+      # @raise [ListoDelivery::Error]
+      def create(body = nil, **fields)
+        @client.execute(
+          "POST",
+          "/v1/quotes",
+          body: Util.body(body, fields, required: "createQuote"),
+          model: Models::Quote
+        )
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/resources/request_logs.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# GENERATED from Listo's API definition (API 1.37.0). Do not edit by hand:
+# this file is rewritten whenever the SDK is regenerated.
+
+module ListoDelivery
+  module Resources
+    # Operations under "request_logs".
+    class RequestLogs
+      # @api private
+      def initialize(client)
+        @client = client
+      end
+
+      # List your request log.
+      #
+      # GET /v1/request_logs
+      # @param query [Hash, nil] query parameters (also accepted as keywords)
+      # @return [Models::RequestLogList]
+      # @raise [ListoDelivery::Error]
+      def list(query = nil, **fields)
+        @client.execute(
+          "GET",
+          "/v1/request_logs",
+          query: Util.query(query, fields),
+          model: Models::RequestLogList
+        )
+      end
+
+      # Retrieve a request log entry.
+      #
+      # GET /v1/request_logs/{id}
+      # @param id [String]
+      # @return [Models::RequestLogDetail]
+      # @raise [ListoDelivery::Error]
+      def retrieve(id)
+        @client.execute(
+          "GET",
+          "/v1/request_logs/#{Util.segment(id)}",
+          model: Models::RequestLogDetail
+        )
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/resources/stores.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+# GENERATED from Listo's API definition (API 1.37.0). Do not edit by hand:
+# this file is rewritten whenever the SDK is regenerated.
+
+module ListoDelivery
+  module Resources
+    # Operations under "stores".
+    class Stores
+      # @api private
+      def initialize(client)
+        @client = client
+      end
+
+      # Cancel a store's plan.
+      #
+      # POST /v1/stores/{store_id}/plan_cancellation
+      # @param store_id [String]
+      # @param idempotency_key [String, nil] your own key; a fresh UUID is sent when omitted
+      # @return [Models::Store]
+      # @raise [ListoDelivery::Error]
+      def cancel_plan(store_id, idempotency_key: nil)
+        @client.execute(
+          "POST",
+          "/v1/stores/#{Util.segment(store_id)}/plan_cancellation",
+          idempotent: true,
+          idempotency_key: idempotency_key,
+          model: Models::Store
+        )
+      end
+
+      # Create a store.
+      #
+      # POST /v1/stores
+      # @param body [Hash, nil] request body (also accepted as keywords)
+      # @param idempotency_key [String, nil] your own key; a fresh UUID is sent when omitted
+      # @return [Models::Store]
+      # @raise [ListoDelivery::Error]
+      def create(body = nil, idempotency_key: nil, **fields)
+        @client.execute(
+          "POST",
+          "/v1/stores",
+          body: Util.body(body, fields, required: "createStore"),
+          idempotent: true,
+          idempotency_key: idempotency_key,
+          model: Models::Store
+        )
+      end
+
+      # Invite a store owner.
+      #
+      # POST /v1/stores/{store_id}/owner
+      # @param store_id [String]
+      # @param body [Hash, nil] request body (also accepted as keywords)
+      # @return [Models::OwnerInvitation]
+      # @raise [ListoDelivery::Error]
+      def create_owner(store_id, body = nil, **fields)
+        @client.execute(
+          "POST",
+          "/v1/stores/#{Util.segment(store_id)}/owner",
+          body: Util.body(body, fields, required: "createStoreOwner"),
+          model: Models::OwnerInvitation
+        )
+      end
+
+      # List your stores.
+      #
+      # GET /v1/stores
+      # @param query [Hash, nil] query parameters (also accepted as keywords)
+      # @return [Models::StoreList]
+      # @raise [ListoDelivery::Error]
+      def list(query = nil, **fields)
+        @client.execute(
+          "GET",
+          "/v1/stores",
+          query: Util.query(query, fields),
+          model: Models::StoreList
+        )
+      end
+
+      # Reactivate a store's plan.
+      #
+      # POST /v1/stores/{store_id}/plan
+      # @param store_id [String]
+      # @param idempotency_key [String, nil] your own key; a fresh UUID is sent when omitted
+      # @return [Models::Store]
+      # @raise [ListoDelivery::Error]
+      def reactivate_plan(store_id, idempotency_key: nil)
+        @client.execute(
+          "POST",
+          "/v1/stores/#{Util.segment(store_id)}/plan",
+          idempotent: true,
+          idempotency_key: idempotency_key,
+          model: Models::Store
+        )
+      end
+
+      # Fetch a store.
+      #
+      # GET /v1/stores/{id}
+      # @param id [String]
+      # @return [Models::Store]
+      # @raise [ListoDelivery::Error]
+      def retrieve(id)
+        @client.execute(
+          "GET",
+          "/v1/stores/#{Util.segment(id)}",
+          model: Models::Store
+        )
+      end
+
+      # Undo a store's plan cancellation.
+      #
+      # DELETE /v1/stores/{store_id}/plan_cancellation
+      # @param store_id [String]
+      # @return [Models::Store]
+      # @raise [ListoDelivery::Error]
+      def undo_plan_cancellation(store_id)
+        @client.execute(
+          "DELETE",
+          "/v1/stores/#{Util.segment(store_id)}/plan_cancellation",
+          model: Models::Store
+        )
+      end
+
+      # Update a store.
+      #
+      # PATCH /v1/stores/{id}
+      # @param id [String]
+      # @param body [Hash, nil] request body (also accepted as keywords)
+      # @return [Models::Store]
+      # @raise [ListoDelivery::Error]
+      def update(id, body = nil, **fields)
+        @client.execute(
+          "PATCH",
+          "/v1/stores/#{Util.segment(id)}",
+          body: Util.body(body, fields),
+          model: Models::Store
+        )
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/resources/webhooks.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# GENERATED from Listo's API definition (API 1.37.0). Do not edit by hand:
+# this file is rewritten whenever the SDK is regenerated.
+
+module ListoDelivery
+  module Resources
+    # Operations under "webhooks".
+    class Webhooks
+      # @api private
+      def initialize(client)
+        @client = client
+      end
+
+      # List webhook delivery attempts.
+      #
+      # GET /v1/webhook_deliveries
+      # @param query [Hash, nil] query parameters (also accepted as keywords)
+      # @return [Models::WebhookDeliveryList]
+      # @raise [ListoDelivery::Error]
+      def list_deliveries(query = nil, **fields)
+        @client.execute(
+          "GET",
+          "/v1/webhook_deliveries",
+          query: Util.query(query, fields),
+          model: Models::WebhookDeliveryList
+        )
+      end
+
+      # Send a test webhook.
+      #
+      # POST /v1/test_webhooks
+      # @param body [Hash, nil] request body (also accepted as keywords)
+      # @return [Models::WebhookEvent]
+      # @raise [ListoDelivery::Error]
+      def send_test(body = nil, **fields)
+        @client.execute(
+          "POST",
+          "/v1/test_webhooks",
+          body: Util.body(body, fields, required: "sendTestWebhook"),
+          model: Models::WebhookEvent
+        )
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/resources/withdrawals.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# GENERATED from Listo's API definition (API 1.37.0). Do not edit by hand:
+# this file is rewritten whenever the SDK is regenerated.
+
+module ListoDelivery
+  module Resources
+    # Operations under "withdrawals".
+    class Withdrawals
+      # @api private
+      def initialize(client)
+        @client = client
+      end
+
+      # Request a withdrawal.
+      #
+      # POST /v1/withdrawals
+      # @param body [Hash, nil] request body (also accepted as keywords)
+      # @return [Models::Withdrawal]
+      # @raise [ListoDelivery::Error]
+      def create(body = nil, **fields)
+        @client.execute(
+          "POST",
+          "/v1/withdrawals",
+          body: Util.body(body, fields, required: "createWithdrawal"),
+          model: Models::Withdrawal
+        )
+      end
+
+      # List your withdrawals.
+      #
+      # GET /v1/withdrawals
+      # @param query [Hash, nil] query parameters (also accepted as keywords)
+      # @return [Models::WithdrawalList]
+      # @raise [ListoDelivery::Error]
+      def list(query = nil, **fields)
+        @client.execute(
+          "GET",
+          "/v1/withdrawals",
+          query: Util.query(query, fields),
+          model: Models::WithdrawalList
+        )
+      end
+
+      # Fetch a withdrawal.
+      #
+      # GET /v1/withdrawals/{id}
+      # @param id [String]
+      # @return [Models::Withdrawal]
+      # @raise [ListoDelivery::Error]
+      def retrieve(id)
+        @client.execute(
+          "GET",
+          "/v1/withdrawals/#{Util.segment(id)}",
+          model: Models::Withdrawal
+        )
+      end
+    end
+  end
+end

data/lib/listo_delivery/model.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module ListoDelivery
+  # Base of every generated model. A model wraps the JSON object as received:
+  # a reader per documented field (by wire name), `#to_h` and `#[]`, and any
+  # field the server adds later stays in `#to_h` instead of breaking parsing.
+  class Model
+    # Field name => how to convert it (nil for a plain JSON value). Each
+    # generated class replaces this.
+    TYPES = {}.freeze
+
+    # Turns a parsed JSON value into this model; anything that is not an
+    # object comes back untouched.
+    def self.build(value)
+      value.is_a?(Hash) ? new(value) : value
+    end
+
+    # @param data [Hash] the JSON object, string or symbol keys
+    def initialize(data = {})
+      @raw = Util.plain(data)
+      @cache = {}
+    end
+
+    # The JSON object, unknown keys included. A copy: changing it changes nothing here.
+    def to_h
+      Util.plain(@raw)
+    end
+
+    # The field named as on the wire, converted like its reader.
+    def [](key)
+      read(key.to_s)
+    end
+
+    def ==(other)
+      other.class == self.class && other.to_h == to_h
+    end
+    alias_method :eql?, :==
+
+    def hash
+      [self.class, @raw].hash
+    end
+
+    def inspect
+      "#<#{self.class.name} #{@raw.inspect}>"
+    end
+
+    def to_json(*args)
+      @raw.to_json(*args)
+    end
+
+    private
+
+    def read(name)
+      return @cache[name] if @cache.key?(name)
+
+      @cache[name] = convert(self.class::TYPES[name], @raw[name])
+    end
+
+    def convert(descriptor, value)
+      return value if descriptor.nil? || value.nil?
+
+      case descriptor.first
+      when "model" then Models.const_get(descriptor.last).build(value)
+      when "array" then value.is_a?(Array) ? value.map { |v| convert(descriptor.last, v) } : value
+      else value
+      end
+    end
+  end
+end