listo-delivery 0.1.1

data/lib/listo_delivery/generated/models/store_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 stores, newest first.
+    class StoreList < Model
+      TYPES = {
+        "data" => ["array", ["model", "Store"]],
+        "has_more" => nil,
+        "cursor" => nil
+      }.freeze
+
+      # @return [Array<Models::Store>]
+      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/store_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 StoreUpdatedEvent < WebhookEvent
+      TYPES = {
+        "id" => nil,
+        "created_at" => nil,
+        "test" => nil,
+        "type" => nil,
+        "data" => ["model", "Store"]
+      }.freeze
+
+      # @return [Models::Store]
+      def data
+        read("data")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+# 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 fields to change.
+    class UpdateStoreRequest < 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
+      }.freeze
+
+      # @return [String, nil]
+      def name
+        read("name")
+      end
+
+      # A phone that resolves to an E.164 number.
+      # @return [String, nil]
+      def phone
+        read("phone")
+      end
+
+      # The full street address, in one string.
+      # @return [String, nil]
+      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
+
+      # @return [Integer, nil]
+      def default_business_fee_share
+        read("default_business_fee_share")
+      end
+
+      # One of: "api_only", "wallet", "full".
+      # @return [String, nil]
+      def access_tier
+        read("access_tier")
+      end
+
+      # @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
+    end
+  end
+end

data/lib/listo_delivery/generated/models/webhook_delivery.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
+    # One attempt to POST an event to your webhook URL, and what came back.
+    class WebhookDelivery < Model
+      TYPES = {
+        "id" => nil,
+        "event_id" => nil,
+        "event_type" => nil,
+        "attempt" => nil,
+        "resent" => nil,
+        "url" => nil,
+        "status_code" => nil,
+        "error_message" => nil,
+        "response_body" => nil,
+        "duration_ms" => nil,
+        "succeeded" => nil,
+        "created_at" => nil
+      }.freeze
+
+      # The attempt's id, `whd_` prefixed.
+      # @return [String]
+      def id
+        read("id")
+      end
+
+      # The event this was an attempt to deliver, `evt_` prefixed.
+      # @return [String]
+      def event_id
+        read("event_id")
+      end
+
+      # The type of that event.
+      # One of: "delivery.status_changed", "delivery.updated", "delivery.courier_location", "withdrawal.updated", "store.updated", "store.connected", "delivery.message_skipped".
+      # @return [String]
+      def event_type
+        read("event_type")
+      end
+
+      # Which attempt this is for the event, counted from 1 in the order they were made.
+      # @return [Integer]
+      def attempt
+        read("attempt")
+      end
+
+      # True when you asked for this attempt (`POST /v1/events/{id}/resend`) rather than Listo making it on its own schedule.
+      # @return [Boolean]
+      def resent
+        read("resent")
+      end
+
+      # The URL that was posted to, as it was when the attempt was made.
+      # @return [String]
+      def url
+        read("url")
+      end
+
+      # The HTTP status your endpoint answered with.
+      # @return [Integer, nil]
+      def status_code
+        read("status_code")
+      end
+
+      # Why the attempt counted as failed, in words (a timeout, a refused connection, a non-2xx status).
+      # @return [String, nil]
+      def error_message
+        read("error_message")
+      end
+
+      # The first 500 characters of the body your endpoint answered with.
+      # @return [String, nil]
+      def response_body
+        read("response_body")
+      end
+
+      # How long the attempt took, in milliseconds.
+      # @return [Integer, nil]
+      def duration_ms
+        read("duration_ms")
+      end
+
+      # True when your endpoint answered with a 2xx.
+      # @return [Boolean]
+      def succeeded
+        read("succeeded")
+      end
+
+      # When the attempt was made, ISO-8601 in UTC.
+      # @return [String]
+      def created_at
+        read("created_at")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/webhook_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 delivery attempts, newest first.
+    class WebhookDeliveryList < Model
+      TYPES = {
+        "data" => ["array", ["model", "WebhookDelivery"]],
+        "has_more" => nil,
+        "cursor" => nil
+      }.freeze
+
+      # @return [Array<Models::WebhookDelivery>]
+      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/webhook_event.rb

@@ -0,0 +1,69 @@
+# 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
+    # Every event your webhook endpoint receives, and every event the debugging reads return: one of the seven below, told apart by `type`.
+    class WebhookEvent < Model
+      TYPES = {
+        "id" => nil,
+        "created_at" => nil,
+        "test" => nil,
+        "type" => nil,
+        "data" => nil
+      }.freeze
+
+      # type value => class name.
+      VARIANTS = {
+        "delivery.courier_location" => "DeliveryCourierLocationEvent",
+        "delivery.message_skipped" => "DeliveryMessageSkippedEvent",
+        "delivery.status_changed" => "DeliveryStatusChangedEvent",
+        "delivery.updated" => "DeliveryUpdatedEvent",
+        "store.connected" => "StoreConnectedEvent",
+        "store.updated" => "StoreUpdatedEvent",
+        "withdrawal.updated" => "WithdrawalUpdatedEvent"
+      }.freeze
+
+      # Builds the variant named by "type"; a value of a kind this SDK
+      # does not know yet stays a plain WebhookEvent, never an error.
+      def self.build(value)
+        return super unless equal?(WebhookEvent)
+        return value unless value.is_a?(Hash)
+
+        name = VARIANTS[(value["type"] || value[:type]).to_s]
+        name ? Models.const_get(name).new(value) : new(value)
+      end
+
+      # The event id, `evt_` prefixed.
+      # @return [String]
+      def id
+        read("id")
+      end
+
+      # When the event was recorded, ISO-8601 in UTC.
+      # @return [String]
+      def created_at
+        read("created_at")
+      end
+
+      # Present, and true, only on a test event you asked for with `POST /v1/test_webhooks`.
+      # @return [Boolean, nil]
+      def test
+        read("test")
+      end
+
+      # Which event this is.
+      # @return [String]
+      def type
+        read("type")
+      end
+
+      # @return [Object]
+      def data
+        read("data")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/webhook_event_envelope.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 fields every event shares.
+    class WebhookEventEnvelope < Model
+      TYPES = {
+        "id" => nil,
+        "created_at" => nil,
+        "test" => nil
+      }.freeze
+
+      # The event id, `evt_` prefixed.
+      # @return [String]
+      def id
+        read("id")
+      end
+
+      # When the event was recorded, ISO-8601 in UTC.
+      # @return [String]
+      def created_at
+        read("created_at")
+      end
+
+      # Present, and true, only on a test event you asked for with `POST /v1/test_webhooks`.
+      # @return [Boolean, nil]
+      def test
+        read("test")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# 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 request to move money out of your balance to your bank account.
+    class Withdrawal < Model
+      TYPES = {
+        "id" => nil,
+        "amount_cents" => nil,
+        "fee_cents" => nil,
+        "currency" => nil,
+        "kind" => nil,
+        "status" => nil,
+        "requested_at" => nil,
+        "due_at" => nil,
+        "resolved_at" => nil,
+        "clave_de_rastreo" => nil,
+        "test" => nil
+      }.freeze
+
+      # The withdrawal id, `wd_` prefixed.
+      # @return [String]
+      def id
+        read("id")
+      end
+
+      # What your bank receives.
+      # @return [Integer]
+      def amount_cents
+        read("amount_cents")
+      end
+
+      # What the withdrawal cost, IVA included.
+      # @return [Integer]
+      def fee_cents
+        read("fee_cents")
+      end
+
+      # One of: "MXN".
+      # @return [String]
+      def currency
+        read("currency")
+      end
+
+      # `standard` is the free path: your released balance only, sent in 1 to 3 business days.
+      # One of: "standard", "same_day".
+      # @return [String]
+      def kind
+        read("kind")
+      end
+
+      # `pending` until a human settles it.
+      # One of: "pending", "paid", "failed".
+      # @return [String]
+      def status
+        read("status")
+      end
+
+      # @return [String, nil]
+      def requested_at
+        read("requested_at")
+      end
+
+      # When a `same_day` withdrawal is due to have been sent, stamped when you requested it and never recalculated afterwards.
+      # @return [String, nil]
+      def due_at
+        read("due_at")
+      end
+
+      # Null while still pending.
+      # @return [String, nil]
+      def resolved_at
+        read("resolved_at")
+      end
+
+      # The SPEI tracking key for the transfer: the identifier your own bank uses to locate the deposit.
+      # @return [String, nil]
+      def clave_de_rastreo
+        read("clave_de_rastreo")
+      end
+
+      # @return [Boolean]
+      def test
+        read("test")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/withdrawal_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 withdrawals, newest first.
+    class WithdrawalList < Model
+      TYPES = {
+        "data" => ["array", ["model", "Withdrawal"]],
+        "has_more" => nil,
+        "cursor" => nil
+      }.freeze
+
+      # @return [Array<Models::Withdrawal>]
+      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/withdrawal_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 WithdrawalUpdatedEvent < WebhookEvent
+      TYPES = {
+        "id" => nil,
+        "created_at" => nil,
+        "test" => nil,
+        "type" => nil,
+        "data" => ["model", "Withdrawal"]
+      }.freeze
+
+      # @return [Models::Withdrawal]
+      def data
+        read("data")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# 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 "balance".
+    class Balance
+      # @api private
+      def initialize(client)
+        @client = client
+      end
+
+      # Read your prepaid balance.
+      #
+      # GET /v1/balance
+      # @return [Models::Balance]
+      # @raise [ListoDelivery::Error]
+      def retrieve
+        @client.execute(
+          "GET",
+          "/v1/balance",
+          model: Models::Balance
+        )
+      end
+
+      # Read a store's balance.
+      #
+      # GET /v1/stores/{store_id}/balance
+      # @param store_id [String]
+      # @return [Models::StoreBalance]
+      # @raise [ListoDelivery::Error]
+      def retrieve_for_store(store_id)
+        @client.execute(
+          "GET",
+          "/v1/stores/#{Util.segment(store_id)}/balance",
+          model: Models::StoreBalance
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# 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 "card_onboarding".
+    class CardOnboarding
+      # @api private
+      def initialize(client)
+        @client = client
+      end
+
+      # Start card onboarding for your company.
+      #
+      # POST /v1/stripe_onboarding
+      # @return [Models::CardOnboardingLink]
+      # @raise [ListoDelivery::Error]
+      def create
+        @client.execute(
+          "POST",
+          "/v1/stripe_onboarding",
+          model: Models::CardOnboardingLink
+        )
+      end
+
+      # Start card onboarding for a store.
+      #
+      # POST /v1/stores/{store_id}/stripe_onboarding
+      # @param store_id [String]
+      # @return [Models::CardOnboardingLink]
+      # @raise [ListoDelivery::Error]
+      def create_for_store(store_id)
+        @client.execute(
+          "POST",
+          "/v1/stores/#{Util.segment(store_id)}/stripe_onboarding",
+          model: Models::CardOnboardingLink
+        )
+      end
+
+      # Read your company's card readiness.
+      #
+      # GET /v1/stripe_status
+      # @return [Models::CardStatus]
+      # @raise [ListoDelivery::Error]
+      def status
+        @client.execute(
+          "GET",
+          "/v1/stripe_status",
+          model: Models::CardStatus
+        )
+      end
+
+      # Read a store's card readiness.
+      #
+      # GET /v1/stores/{store_id}/stripe_status
+      # @param store_id [String]
+      # @return [Models::CardStatus]
+      # @raise [ListoDelivery::Error]
+      def status_for_store(store_id)
+        @client.execute(
+          "GET",
+          "/v1/stores/#{Util.segment(store_id)}/stripe_status",
+          model: Models::CardStatus
+        )
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/resources/connect_requests.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 "connect_requests".
+    class ConnectRequests
+      # @api private
+      def initialize(client)
+        @client = client
+      end
+
+      # Ask a restaurant to connect its account.
+      #
+      # POST /v1/connect_requests
+      # @param body [Hash, nil] request body (also accepted as keywords)
+      # @return [Models::ConnectRequest]
+      # @raise [ListoDelivery::Error]
+      def create(body = nil, **fields)
+        @client.execute(
+          "POST",
+          "/v1/connect_requests",
+          body: Util.body(body, fields, required: "createConnectRequest"),
+          model: Models::ConnectRequest
+        )
+      end
+    end
+  end
+end