listo-delivery 0.1.1

data/lib/listo_delivery/generated/models/delivery_courier_location_event.rb

@@ -0,0 +1,23 @@
+# 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 Models
+    class DeliveryCourierLocationEvent < WebhookEvent
+      TYPES = {
+        "id" => nil,
+        "created_at" => nil,
+        "test" => nil,
+        "type" => nil,
+        "data" => ["model", "CourierPing"]
+      }.freeze
+
+      # @return [Models::CourierPing]
+      def data
+        read("data")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/delivery_list.rb

@@ -0,0 +1,34 @@
+# 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 Models
+    # One page of deliveries, newest first.
+    class DeliveryList < Model
+      TYPES = {
+        "data" => ["array", ["model", "Delivery"]],
+        "has_more" => nil,
+        "cursor" => nil
+      }.freeze
+
+      # @return [Array<Models::Delivery>]
+      def data
+        read("data")
+      end
+
+      # True when a further page exists.
+      # @return [Boolean]
+      def has_more
+        read("has_more")
+      end
+
+      # Pass as `cursor` to read the next page.
+      # @return [String, nil]
+      def cursor
+        read("cursor")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/delivery_message_skipped.rb

@@ -0,0 +1,37 @@
+# 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 Models
+    # The body of a `delivery.message_skipped` event.
+    class DeliveryMessageSkipped < Model
+      TYPES = {
+        "delivery_id" => nil,
+        "moment" => nil,
+        "reason" => nil
+      }.freeze
+
+      # The `dlv_` id of the delivery whose message was not sent.
+      # @return [String]
+      def delivery_id
+        read("delivery_id")
+      end
+
+      # Which message was skipped.
+      # One of: "courier_assigned", "en_route", "arriving", "delivered", "not_delivered", "pickup_time_changed", "location_request", "payment_request", "dropoff_code".
+      # @return [String]
+      def moment
+        read("moment")
+      end
+
+      # Why it was skipped.
+      # One of: "not_a_team_phone", "daily_test_limit".
+      # @return [String]
+      def reason
+        read("reason")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/delivery_message_skipped_event.rb

@@ -0,0 +1,23 @@
+# 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 Models
+    class DeliveryMessageSkippedEvent < WebhookEvent
+      TYPES = {
+        "id" => nil,
+        "created_at" => nil,
+        "test" => nil,
+        "type" => nil,
+        "data" => ["model", "DeliveryMessageSkipped"]
+      }.freeze
+
+      # @return [Models::DeliveryMessageSkipped]
+      def data
+        read("data")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/delivery_status_changed_event.rb

@@ -0,0 +1,23 @@
+# 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 Models
+    class DeliveryStatusChangedEvent < WebhookEvent
+      TYPES = {
+        "id" => nil,
+        "created_at" => nil,
+        "test" => nil,
+        "type" => nil,
+        "data" => ["model", "Delivery"]
+      }.freeze
+
+      # @return [Models::Delivery]
+      def data
+        read("data")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/delivery_updated_event.rb

@@ -0,0 +1,23 @@
+# 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 Models
+    class DeliveryUpdatedEvent < WebhookEvent
+      TYPES = {
+        "id" => nil,
+        "created_at" => nil,
+        "test" => nil,
+        "type" => nil,
+        "data" => ["model", "Delivery"]
+      }.freeze
+
+      # @return [Models::Delivery]
+      def data
+        read("data")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/error.rb

@@ -0,0 +1,56 @@
+# 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 Models
+    # What every refusal and every failure looks like.
+    class Error < Model
+      TYPES = {
+        "code" => nil,
+        "message" => nil,
+        "param" => nil,
+        "retryable" => nil,
+        "doc_url" => nil,
+        "request_id" => nil
+      }.freeze
+
+      # A stable, machine-readable name for what went wrong, such as `validation_failed`, `not_found` or `insufficient_balance`.
+      # @return [String]
+      def code
+        read("code")
+      end
+
+      # A sentence for the person debugging.
+      # @return [String]
+      def message
+        read("message")
+      end
+
+      # The request field the refusal is about, when one applies, spelled as you sent it (`dropoff.street`, `manifest.items`).
+      # @return [String, nil]
+      def param
+        read("param")
+      end
+
+      # Whether sending the identical request again could succeed.
+      # @return [Boolean]
+      def retryable
+        read("retryable")
+      end
+
+      # The documentation page for this `code`.
+      # @return [String]
+      def doc_url
+        read("doc_url")
+      end
+
+      # Our id for this request, the same value as the `X-Request-Id` response header.
+      # @return [String]
+      def request_id
+        read("request_id")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/error_response.rb

@@ -0,0 +1,20 @@
+# 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 Models
+    # The body of every 4xx and 5xx answer on this API.
+    class ErrorResponse < Model
+      TYPES = {
+        "error" => ["model", "Error"]
+      }.freeze
+
+      # @return [Models::Error]
+      def error
+        read("error")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/event_list.rb

@@ -0,0 +1,34 @@
+# 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 Models
+    # One page of events, newest first.
+    class EventList < Model
+      TYPES = {
+        "data" => ["array", ["model", "WebhookEvent"]],
+        "has_more" => nil,
+        "cursor" => nil
+      }.freeze
+
+      # @return [Array<Models::WebhookEvent>]
+      def data
+        read("data")
+      end
+
+      # True when a further page exists.
+      # @return [Boolean]
+      def has_more
+        read("has_more")
+      end
+
+      # Pass as `cursor` to read the next page.
+      # @return [String, nil]
+      def cursor
+        read("cursor")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/ledger_entry.rb

@@ -0,0 +1,62 @@
+# 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 Models
+    # One movement on a balance.
+    class LedgerEntry < Model
+      TYPES = {
+        "id" => nil,
+        "type" => nil,
+        "amount_cents" => nil,
+        "delivery_id" => nil,
+        "store_id" => nil,
+        "test" => nil,
+        "occurred_at" => nil
+      }.freeze
+
+      # The entry id, `le_` prefixed.
+      # @return [String]
+      def id
+        read("id")
+      end
+
+      # Where the movement came from, such as `provider_charge`, `provider_charge_reversal`, `plan_charge` or `requote_adjustment`.
+      # @return [String]
+      def type
+        read("type")
+      end
+
+      # Signed centavos.
+      # @return [Integer]
+      def amount_cents
+        read("amount_cents")
+      end
+
+      # The `dlv_` id the movement stems from.
+      # @return [String, nil]
+      def delivery_id
+        read("delivery_id")
+      end
+
+      # The `st_` id of the store the movement belongs to.
+      # @return [String, nil]
+      def store_id
+        read("store_id")
+      end
+
+      # @return [Boolean]
+      def test
+        read("test")
+      end
+
+      # When the money moved.
+      # @return [String]
+      def occurred_at
+        read("occurred_at")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/ledger_entry_list.rb

@@ -0,0 +1,34 @@
+# 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 Models
+    # One page of ledger entries, newest first.
+    class LedgerEntryList < Model
+      TYPES = {
+        "data" => ["array", ["model", "LedgerEntry"]],
+        "has_more" => nil,
+        "cursor" => nil
+      }.freeze
+
+      # @return [Array<Models::LedgerEntry>]
+      def data
+        read("data")
+      end
+
+      # True when a further page exists.
+      # @return [Boolean]
+      def has_more
+        read("has_more")
+      end
+
+      # Pass as `cursor` to read the next page.
+      # @return [String, nil]
+      def cursor
+        read("cursor")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/manifest.rb

@@ -0,0 +1,20 @@
+# 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 Models
+    # The descriptive item list for the courier.
+    class Manifest < Model
+      TYPES = {
+        "items" => ["array", ["model", "ManifestItem"]]
+      }.freeze
+
+      # @return [Array<Models::ManifestItem>, nil]
+      def items
+        read("items")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/manifest_item.rb

@@ -0,0 +1,36 @@
+# 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 Models
+    # One line of the descriptive item list sent to the courier.
+    class ManifestItem < Model
+      TYPES = {
+        "name" => nil,
+        "quantity" => nil,
+        "size" => nil
+      }.freeze
+
+      # What the item is.
+      # @return [String]
+      def name
+        read("name")
+      end
+
+      # How many of it.
+      # @return [Integer]
+      def quantity
+        read("quantity")
+      end
+
+      # How big the item is.
+      # One of: "small", "medium", "large", "xlarge", nil.
+      # @return [String, nil]
+      def size
+        read("size")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/owner_invitation.rb

@@ -0,0 +1,27 @@
+# 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 Models
+    # The invitation sent to a store's owner.
+    class OwnerInvitation < Model
+      TYPES = {
+        "email" => nil,
+        "invited_at" => nil
+      }.freeze
+
+      # The address the invitation went to.
+      # @return [String]
+      def email
+        read("email")
+      end
+
+      # @return [String]
+      def invited_at
+        read("invited_at")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/ping.rb

@@ -0,0 +1,56 @@
+# 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 Models
+    # Proof that your key works, and which world it acts in.
+    class Ping < Model
+      TYPES = {
+        "partner" => ["model", "Ping::Partner"],
+        "mode" => nil,
+        "test" => nil
+      }.freeze
+
+      # The company the key belongs to.
+      # @return [Models::Ping::Partner]
+      def partner
+        read("partner")
+      end
+
+      # The world the key acts in.
+      # One of: "live", "test".
+      # @return [String]
+      def mode
+        read("mode")
+      end
+
+      # True when `mode` is `test`.
+      # @return [Boolean]
+      def test
+        read("test")
+      end
+
+      # The company the key belongs to.
+      class Partner < Model
+        TYPES = {
+          "slug" => nil,
+          "name" => nil
+        }.freeze
+
+        # Your company's short handle.
+        # @return [String]
+        def slug
+          read("slug")
+        end
+
+        # Your company's name.
+        # @return [String]
+        def name
+          read("name")
+        end
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/quote.rb

@@ -0,0 +1,99 @@
+# 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 Models
+    # A delivery priced and held for a short while.
+    class Quote < Model
+      TYPES = {
+        "id" => nil,
+        "fee_cents" => nil,
+        "business_fee_cents" => nil,
+        "customer_fee_cents" => nil,
+        "cash_to_collect_cents" => nil,
+        "currency" => nil,
+        "pickup_duration_min" => nil,
+        "dropoff_eta_at" => nil,
+        "expires_at" => nil,
+        "test" => nil,
+        "created_at" => nil,
+        "vehicle" => nil
+      }.freeze
+
+      # The quote id, `qt_` prefixed.
+      # @return [String]
+      def id
+        read("id")
+      end
+
+      # The total delivery fee, in centavos, and the number a booking against this quote is held to.
+      # @return [Integer]
+      def fee_cents
+        read("fee_cents")
+      end
+
+      # The part of the fee the store pays.
+      # @return [Integer]
+      def business_fee_cents
+        read("business_fee_cents")
+      end
+
+      # The part of the fee the customer pays.
+      # @return [Integer]
+      def customer_fee_cents
+        read("customer_fee_cents")
+      end
+
+      # What the courier collects at the door on a cash order: the order value plus the customer's share of the fee.
+      # @return [Integer, nil]
+      def cash_to_collect_cents
+        read("cash_to_collect_cents")
+      end
+
+      # Always `MXN`; money is integer centavos.
+      # One of: "MXN".
+      # @return [String]
+      def currency
+        read("currency")
+      end
+
+      # Minutes until a courier is expected at the store, when the quote came back with an estimate.
+      # @return [Integer, nil]
+      def pickup_duration_min
+        read("pickup_duration_min")
+      end
+
+      # When the order is expected at the door, when the quote came back with an estimate.
+      # @return [String, nil]
+      def dropoff_eta_at
+        read("dropoff_eta_at")
+      end
+
+      # The deadline for booking this price.
+      # @return [String]
+      def expires_at
+        read("expires_at")
+      end
+
+      # Whether the quote belongs to the sandbox world.
+      # @return [Boolean]
+      def test
+        read("test")
+      end
+
+      # @return [String]
+      def created_at
+        read("created_at")
+      end
+
+      # What this price was built for: `car` when you asked for one or an item was sized `xlarge`, `moto` otherwise.
+      # One of: "moto", "car".
+      # @return [String]
+      def vehicle
+        read("vehicle")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/refund_delivery_request.rb

@@ -0,0 +1,28 @@
+# 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 Models
+    # How much of the order to refund.
+    class RefundDeliveryRequest < Model
+      TYPES = {
+        "amount_cents" => nil,
+        "reason" => nil
+      }.freeze
+
+      # A smaller amount than the whole, in centavos.
+      # @return [Integer, nil]
+      def amount_cents
+        read("amount_cents")
+      end
+
+      # Why the refund is being made, up to 500 characters.
+      # @return [String, nil]
+      def reason
+        read("reason")
+      end
+    end
+  end
+end