listo-delivery 0.1.1

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

@@ -0,0 +1,22 @@
+# 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
+    # Whether card payments can be taken yet.
+    class CardStatus < Model
+      TYPES = {
+        "status" => nil
+      }.freeze
+
+      # `not_started` means onboarding has not been opened, `verifying` that the details are in and under review, `action_required` that more...
+      # One of: "not_started", "verifying", "action_required", "connected".
+      # @return [String]
+      def status
+        read("status")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/connect_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
+    # A connection request waiting for the restaurant owner to approve it.
+    class ConnectRequest < Model
+      TYPES = {
+        "url" => nil,
+        "expires_at" => nil
+      }.freeze
+
+      # The consent page to send the owner to.
+      # @return [String]
+      def url
+        read("url")
+      end
+
+      # When the link stops working.
+      # @return [String]
+      def expires_at
+        read("expires_at")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# 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 reduced body of a `delivery.courier_location` event.
+    class CourierPing < Model
+      TYPES = {
+        "delivery_id" => nil,
+        "external_id" => nil,
+        "location" => ["model", "CourierPing::Location"],
+        "updated_at" => nil
+      }.freeze
+
+      # The `dlv_` id of the delivery the courier is carrying.
+      # @return [String]
+      def delivery_id
+        read("delivery_id")
+      end
+
+      # Your own reference for that delivery, so you need not store ours.
+      # @return [String, nil]
+      def external_id
+        read("external_id")
+      end
+
+      # @return [Models::CourierPing::Location]
+      def location
+        read("location")
+      end
+
+      # When this position was last confirmed, which is not the same as when the event was sent.
+      # @return [String, nil]
+      def updated_at
+        read("updated_at")
+      end
+
+      class Location < Model
+        TYPES = {
+          "lat" => nil,
+          "lng" => nil
+        }.freeze
+
+        # @return [Numeric]
+        def lat
+          read("lat")
+        end
+
+        # @return [Numeric]
+        def lng
+          read("lng")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# 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 restaurant owner to ask, and where to send them back.
+    class CreateConnectRequestRequest < Model
+      TYPES = {
+        "owner_email" => nil,
+        "redirect_uri" => nil,
+        "state" => nil
+      }.freeze
+
+      # The email of the person who signs in to the restaurant's Listo account.
+      # @return [String]
+      def owner_email
+        read("owner_email")
+      end
+
+      # Where the owner's browser returns after approving.
+      # @return [String]
+      def redirect_uri
+        read("redirect_uri")
+      end
+
+      # An opaque value returned to `redirect_uri` unchanged, up to 255 characters.
+      # @return [String, nil]
+      def state
+        read("state")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# 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 one-time code from an approved connect request.
+    class CreateConnectionRequest < Model
+      TYPES = {
+        "code" => nil
+      }.freeze
+
+      # The `pcc_` code that arrived at your `redirect_uri`.
+      # @return [String]
+      def code
+        read("code")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,189 @@
+# 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 order to dispatch.
+    class CreateDeliveryRequest < Model
+      TYPES = {
+        "store_id" => nil,
+        "quote_id" => nil,
+        "external_id" => nil,
+        "payment_method" => nil,
+        "order_value_cents" => nil,
+        "business_fee_share" => nil,
+        "business_fee_cap_cents" => nil,
+        "tip_cents" => nil,
+        "dropoff" => ["model", "CreateDeliveryRequest::Dropoff"],
+        "handoff" => nil,
+        "manifest" => ["model", "Manifest"],
+        "verification" => ["model", "CreateDeliveryRequest::Verification"],
+        "pickup_ready_at" => nil,
+        "vehicle" => nil,
+        "simulate" => nil
+      }.freeze
+
+      # The `st_` id of the store the courier collects from.
+      # @return [String]
+      def store_id
+        read("store_id")
+      end
+
+      # The `qt_` id of a quote to book at exactly its price.
+      # @return [String, nil]
+      def quote_id
+        read("quote_id")
+      end
+
+      # Your own reference for this order.
+      # @return [String]
+      def external_id
+        read("external_id")
+      end
+
+      # How the customer pays.
+      # One of: "prepaid", "cash", "card".
+      # @return [String]
+      def payment_method
+        read("payment_method")
+      end
+
+      # The value of the order, in centavos.
+      # @return [Integer]
+      def order_value_cents
+        read("order_value_cents")
+      end
+
+      # The percent of the delivery fee the store pays.
+      # @return [Integer, nil]
+      def business_fee_share
+        read("business_fee_share")
+      end
+
+      # The most the store pays toward the fee, in centavos.
+      # @return [Integer, nil]
+      def business_fee_cap_cents
+        read("business_fee_cap_cents")
+      end
+
+      # A tip for the courier, in centavos, up to 100000.
+      # @return [Integer, nil]
+      def tip_cents
+        read("tip_cents")
+      end
+
+      # Where the order goes, and who receives it.
+      # @return [Models::CreateDeliveryRequest::Dropoff]
+      def dropoff
+        read("dropoff")
+      end
+
+      # Where the courier hands the order over.
+      # One of: "meet_at_door", "leave_at_door", "meet_outside".
+      # @return [String, nil]
+      def handoff
+        read("handoff")
+      end
+
+      # @return [Models::Manifest, nil]
+      def manifest
+        read("manifest")
+      end
+
+      # Proof the customer must give the courier.
+      # @return [Models::CreateDeliveryRequest::Verification, nil]
+      def verification
+        read("verification")
+      end
+
+      # When the order will be ready, ISO-8601 in UTC, between 10 minutes and 29 days from now.
+      # @return [String, nil]
+      def pickup_ready_at
+        read("pickup_ready_at")
+      end
+
+      # Defaults to `moto`, or to the quote's when you book one.
+      # One of: "moto", "car".
+      # @return [String, nil]
+      def vehicle
+        read("vehicle")
+      end
+
+      # Test keys only: the scenario the simulated courier plays.
+      # One of: "returned", "no_courier", "delayed_pickup", "courier_reassigned".
+      # @return [String, nil]
+      def simulate
+        read("simulate")
+      end
+
+      # Where the order goes, and who receives it.
+      class Dropoff < Model
+        TYPES = {
+          "name" => nil,
+          "phone" => nil,
+          "street" => nil,
+          "apt_unit" => nil,
+          "lat" => nil,
+          "lng" => nil,
+          "notes" => nil
+        }.freeze
+
+        # Who receives the order.
+        # @return [String]
+        def name
+          read("name")
+        end
+
+        # A phone the courier can call, any format that resolves to an E.164 number.
+        # @return [String]
+        def phone
+          read("phone")
+        end
+
+        # The full street address, in one string.
+        # @return [String]
+        def street
+          read("street")
+        end
+
+        # @return [String, nil]
+        def apt_unit
+          read("apt_unit")
+        end
+
+        # Latitude.
+        # @return [Numeric, nil]
+        def lat
+          read("lat")
+        end
+
+        # Longitude.
+        # @return [Numeric, nil]
+        def lng
+          read("lng")
+        end
+
+        # Instructions for the courier at the door, up to 280 characters.
+        # @return [String, nil]
+        def notes
+          read("notes")
+        end
+      end
+
+      # Proof the customer must give the courier.
+      class Verification < Model
+        TYPES = {
+          "dropoff_pincode" => nil
+        }.freeze
+
+        # True to require a code at the door.
+        # @return [Boolean, nil]
+        def dropoff_pincode
+          read("dropoff_pincode")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+# 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 trip to price.
+    class CreateQuoteRequest < Model
+      TYPES = {
+        "store_id" => nil,
+        "dropoff" => ["model", "CreateQuoteRequest::Dropoff"],
+        "payment_method" => nil,
+        "order_value_cents" => nil,
+        "business_fee_share" => nil,
+        "business_fee_cap_cents" => nil,
+        "pickup_ready_at" => nil,
+        "vehicle" => nil,
+        "manifest" => ["model", "Manifest"]
+      }.freeze
+
+      # The `st_` id of the store the courier collects from.
+      # @return [String]
+      def store_id
+        read("store_id")
+      end
+
+      # Where the order goes.
+      # @return [Models::CreateQuoteRequest::Dropoff]
+      def dropoff
+        read("dropoff")
+      end
+
+      # How the customer pays.
+      # One of: "prepaid", "cash", "card".
+      # @return [String, nil]
+      def payment_method
+        read("payment_method")
+      end
+
+      # The value of the order, in centavos.
+      # @return [Integer, nil]
+      def order_value_cents
+        read("order_value_cents")
+      end
+
+      # The percent of the delivery fee the store pays.
+      # @return [Integer, nil]
+      def business_fee_share
+        read("business_fee_share")
+      end
+
+      # The most the store pays toward the fee, in centavos.
+      # @return [Integer, nil]
+      def business_fee_cap_cents
+        read("business_fee_cap_cents")
+      end
+
+      # When the order will be ready, ISO-8601 in UTC.
+      # @return [String, nil]
+      def pickup_ready_at
+        read("pickup_ready_at")
+      end
+
+      # Defaults to `moto`.
+      # One of: "moto", "car".
+      # @return [String, nil]
+      def vehicle
+        read("vehicle")
+      end
+
+      # @return [Models::Manifest, nil]
+      def manifest
+        read("manifest")
+      end
+
+      # Where the order goes.
+      class Dropoff < Model
+        TYPES = {
+          "street" => nil,
+          "apt_unit" => nil,
+          "lat" => nil,
+          "lng" => nil
+        }.freeze
+
+        # The full street address, in one string.
+        # @return [String]
+        def street
+          read("street")
+        end
+
+        # @return [String, nil]
+        def apt_unit
+          read("apt_unit")
+        end
+
+        # Latitude.
+        # @return [Numeric, nil]
+        def lat
+          read("lat")
+        end
+
+        # Longitude.
+        # @return [Numeric, nil]
+        def lng
+          read("lng")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# 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 person to invite as the store's owner.
+    class CreateStoreOwnerRequest < Model
+      TYPES = {
+        "name" => nil,
+        "email" => nil
+      }.freeze
+
+      # @return [String]
+      def name
+        read("name")
+      end
+
+      # @return [String]
+      def email
+        read("email")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,104 @@
+# 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 pickup location to create.
+    class CreateStoreRequest < Model
+      TYPES = {
+        "name" => nil,
+        "phone" => nil,
+        "street" => nil,
+        "apt_unit" => nil,
+        "lat" => nil,
+        "lng" => nil,
+        "pickup_notes" => nil,
+        "timezone" => nil,
+        "default_business_fee_share" => nil,
+        "access_tier" => nil,
+        "markup_cents" => nil,
+        "external_id" => nil,
+        "owner_email" => nil
+      }.freeze
+
+      # @return [String]
+      def name
+        read("name")
+      end
+
+      # A phone that resolves to an E.164 number.
+      # @return [String]
+      def phone
+        read("phone")
+      end
+
+      # The full street address, in one string.
+      # @return [String]
+      def street
+        read("street")
+      end
+
+      # @return [String, nil]
+      def apt_unit
+        read("apt_unit")
+      end
+
+      # Latitude.
+      # @return [Numeric, nil]
+      def lat
+        read("lat")
+      end
+
+      # Longitude.
+      # @return [Numeric, nil]
+      def lng
+        read("lng")
+      end
+
+      # Instructions for the courier at the store, up to 280 characters.
+      # @return [String, nil]
+      def pickup_notes
+        read("pickup_notes")
+      end
+
+      # An IANA time zone name.
+      # @return [String, nil]
+      def timezone
+        read("timezone")
+      end
+
+      # The percent of the delivery fee the store pays by default.
+      # @return [Integer, nil]
+      def default_business_fee_share
+        read("default_business_fee_share")
+      end
+
+      # What the store gets besides the API.
+      # One of: "api_only", "wallet", "full".
+      # @return [String, nil]
+      def access_tier
+        read("access_tier")
+      end
+
+      # Your markup on each delivery, in centavos, up to 1000000.
+      # @return [Integer, nil]
+      def markup_cents
+        read("markup_cents")
+      end
+
+      # Your own reference for this location.
+      # @return [String, nil]
+      def external_id
+        read("external_id")
+      end
+
+      # The restaurant owner to invite, for a store with a console.
+      # @return [String, nil]
+      def owner_email
+        read("owner_email")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# 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 to move out of your balance.
+    class CreateWithdrawalRequest < Model
+      TYPES = {
+        "amount_cents" => nil,
+        "kind" => nil
+      }.freeze
+
+      # What your bank receives, in centavos.
+      # @return [Integer]
+      def amount_cents
+        read("amount_cents")
+      end
+
+      # Defaults to `standard`.
+      # One of: "standard", "same_day", nil.
+      # @return [String, nil]
+      def kind
+        read("kind")
+      end
+    end
+  end
+end