listo-delivery 0.1.1

data/lib/listo_delivery/generated/models/request_log.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
+    # One call your key made to this API: what was called, how it was answered and how long it took.
+    class RequestLog < Model
+      TYPES = {
+        "id" => nil,
+        "method" => nil,
+        "path" => nil,
+        "endpoint" => nil,
+        "status" => nil,
+        "error_code" => nil,
+        "duration_ms" => nil,
+        "request_id" => nil,
+        "api_key_prefix" => nil,
+        "test" => nil,
+        "created_at" => nil
+      }.freeze
+
+      # The call's id, `req_` prefixed.
+      # @return [String]
+      def id
+        read("id")
+      end
+
+      # The HTTP method of the call.
+      # @return [String]
+      def method
+        read("method")
+      end
+
+      # The path that was called, with its query string.
+      # @return [String, nil]
+      def path
+        read("path")
+      end
+
+      # Which operation the call reached, as `controller#action`.
+      # @return [String]
+      def endpoint
+        read("endpoint")
+      end
+
+      # The HTTP status Listo answered with.
+      # @return [Integer]
+      def status
+        read("status")
+      end
+
+      # The `error.code` of the answer when it was an error, otherwise null.
+      # @return [String, nil]
+      def error_code
+        read("error_code")
+      end
+
+      # How long Listo took to answer, in milliseconds.
+      # @return [Integer, nil]
+      def duration_ms
+        read("duration_ms")
+      end
+
+      # The call's request id, the value of the `X-Request-Id` response header.
+      # @return [String, nil]
+      def request_id
+        read("request_id")
+      end
+
+      # The first characters of the key that made the call, the same text the dashboard's keys page shows, never the secret.
+      # @return [String, nil]
+      def api_key_prefix
+        read("api_key_prefix")
+      end
+
+      # True when the call was made with a test key.
+      # @return [Boolean]
+      def test
+        read("test")
+      end
+
+      # When Listo received the call, ISO-8601 in UTC.
+      # @return [String]
+      def created_at
+        read("created_at")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,105 @@
+# 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 call with what was sent and what came back.
+    class RequestLogDetail < Model
+      TYPES = {
+        "id" => nil,
+        "method" => nil,
+        "path" => nil,
+        "endpoint" => nil,
+        "status" => nil,
+        "error_code" => nil,
+        "duration_ms" => nil,
+        "request_id" => nil,
+        "api_key_prefix" => nil,
+        "test" => nil,
+        "created_at" => nil,
+        "request_body" => nil,
+        "response_body" => nil
+      }.freeze
+
+      # The call's id, `req_` prefixed.
+      # @return [String]
+      def id
+        read("id")
+      end
+
+      # The HTTP method of the call.
+      # @return [String]
+      def method
+        read("method")
+      end
+
+      # The path that was called, with its query string.
+      # @return [String, nil]
+      def path
+        read("path")
+      end
+
+      # Which operation the call reached, as `controller#action`.
+      # @return [String]
+      def endpoint
+        read("endpoint")
+      end
+
+      # The HTTP status Listo answered with.
+      # @return [Integer]
+      def status
+        read("status")
+      end
+
+      # The `error.code` of the answer when it was an error, otherwise null.
+      # @return [String, nil]
+      def error_code
+        read("error_code")
+      end
+
+      # How long Listo took to answer, in milliseconds.
+      # @return [Integer, nil]
+      def duration_ms
+        read("duration_ms")
+      end
+
+      # The call's request id, the value of the `X-Request-Id` response header.
+      # @return [String, nil]
+      def request_id
+        read("request_id")
+      end
+
+      # The first characters of the key that made the call, never the secret.
+      # @return [String, nil]
+      def api_key_prefix
+        read("api_key_prefix")
+      end
+
+      # True when the call was made with a test key.
+      # @return [Boolean]
+      def test
+        read("test")
+      end
+
+      # When Listo received the call, ISO-8601 in UTC.
+      # @return [String]
+      def created_at
+        read("created_at")
+      end
+
+      # What the call sent, as JSON.
+      # @return [Object]
+      def request_body
+        read("request_body")
+      end
+
+      # What Listo answered, as JSON.
+      # @return [Object]
+      def response_body
+        read("response_body")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/request_log_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 logged calls, newest first.
+    class RequestLogList < Model
+      TYPES = {
+        "data" => ["array", ["model", "RequestLog"]],
+        "has_more" => nil,
+        "cursor" => nil
+      }.freeze
+
+      # @return [Array<Models::RequestLog>]
+      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/reschedule_delivery_request.rb

@@ -0,0 +1,41 @@
+# 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 to change on an order.
+    class RescheduleDeliveryRequest < Model
+      TYPES = {
+        "pickup_ready_at" => nil,
+        "dropoff" => ["model", "RescheduleDeliveryRequest::Dropoff"]
+      }.freeze
+
+      # When the order will be ready: an ISO-8601 instant in UTC, or the literal `now` to dispatch it immediately.
+      # @return [String, nil]
+      def pickup_ready_at
+        read("pickup_ready_at")
+      end
+
+      # The part of the drop-off that can still change.
+      # @return [Models::RescheduleDeliveryRequest::Dropoff, nil]
+      def dropoff
+        read("dropoff")
+      end
+
+      # The part of the drop-off that can still change.
+      class Dropoff < Model
+        TYPES = {
+          "notes" => nil
+        }.freeze
+
+        # Instructions for the courier at the door, up to 280 characters.
+        # @return [String, nil]
+        def notes
+          read("notes")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,106 @@
+# 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 a `same_day` withdrawal would cost you and how large a one you could ask for, right now.
+    class SameDayTerms < Model
+      TYPES = {
+        "fee_cents" => nil,
+        "minimum_cents" => nil,
+        "ceiling_cents" => nil,
+        "reach_cents" => nil,
+        "advanceable_cents" => nil,
+        "cap_cents" => nil,
+        "cap_used_cents" => nil,
+        "cap_remaining_cents" => nil,
+        "window_open" => nil,
+        "due_at" => nil,
+        "next_window_opens_at" => nil,
+        "offerable" => nil,
+        "unavailable_reason" => nil
+      }.freeze
+
+      # What a same-day withdrawal costs, IVA included, charged on top of the amount.
+      # @return [Integer]
+      def fee_cents
+        read("fee_cents")
+      end
+
+      # The smallest `amount_cents` a same-day request is accepted for.
+      # @return [Integer]
+      def minimum_cents
+        read("minimum_cents")
+      end
+
+      # The largest `amount_cents` a same-day request would be accepted for at this moment.
+      # @return [Integer]
+      def ceiling_cents
+        read("ceiling_cents")
+      end
+
+      # Everything a request could draw on before the fee.
+      # @return [Integer]
+      def reach_cents
+        read("reach_cents")
+      end
+
+      # The part of `reach_cents` that is still-held cash.
+      # @return [Integer]
+      def advanceable_cents
+        read("advanceable_cents")
+      end
+
+      # The daily maximum per account.
+      # @return [Integer]
+      def cap_cents
+        read("cap_cents")
+      end
+
+      # How much of the daily maximum is already used today.
+      # @return [Integer]
+      def cap_used_cents
+        read("cap_used_cents")
+      end
+
+      # What is left of the daily maximum today.
+      # @return [Integer]
+      def cap_remaining_cents
+        read("cap_remaining_cents")
+      end
+
+      # Whether staff are sending transfers right now.
+      # @return [Boolean]
+      def window_open
+        read("window_open")
+      end
+
+      # The deadline a request made at the moment you read this would carry.
+      # @return [String]
+      def due_at
+        read("due_at")
+      end
+
+      # The next time sending resumes.
+      # @return [String]
+      def next_window_opens_at
+        read("next_window_opens_at")
+      end
+
+      # False when no same-day request would be accepted at all.
+      # @return [Boolean]
+      def offerable
+        read("offerable")
+      end
+
+      # Why `offerable` is false: `cap_reached` (today's maximum is spent) or `below_minimum` (the reach is too small to clear the floor plus the...
+      # One of: "cap_reached", "below_minimum", nil.
+      # @return [String, nil]
+      def unavailable_reason
+        read("unavailable_reason")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/send_test_webhook_request.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
+    # Which event to send a sample of.
+    class SendTestWebhookRequest < Model
+      TYPES = {
+        "type" => nil
+      }.freeze
+
+      # The published event type to send a sample of.
+      # One of: "delivery.status_changed", "delivery.updated", "delivery.courier_location", "withdrawal.updated", "store.updated", "store.connected", "delivery.message_skipped".
+      # @return [String]
+      def type
+        read("type")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,235 @@
+# 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 pickup location.
+    class Store < Model
+      TYPES = {
+        "id" => nil,
+        "external_id" => nil,
+        "name" => nil,
+        "phone" => nil,
+        "street" => nil,
+        "apt_unit" => nil,
+        "lat" => nil,
+        "lng" => nil,
+        "pickup_notes" => nil,
+        "timezone" => nil,
+        "default_business_fee_share" => nil,
+        "default_fee_split_mode" => nil,
+        "default_fee_split_amount_cents" => nil,
+        "access_tier" => nil,
+        "markup_cents" => nil,
+        "billing" => nil,
+        "test" => nil,
+        "created_at" => nil,
+        "plan" => ["model", "Store::Plan"]
+      }.freeze
+
+      # The store id, `st_` prefixed.
+      # @return [String]
+      def id
+        read("id")
+      end
+
+      # Your own reference for this location, if you sent one.
+      # @return [String, nil]
+      def external_id
+        read("external_id")
+      end
+
+      # The name you gave the store; for a restaurant that connected an account with several branches, the business and the branch, the way its own...
+      # @return [String]
+      def name
+        read("name")
+      end
+
+      # E.164, normalized on the way in.
+      # @return [String]
+      def phone
+        read("phone")
+      end
+
+      # @return [String]
+      def street
+        read("street")
+      end
+
+      # @return [String, nil]
+      def apt_unit
+        read("apt_unit")
+      end
+
+      # @return [Numeric, nil]
+      def lat
+        read("lat")
+      end
+
+      # @return [Numeric, nil]
+      def lng
+        read("lng")
+      end
+
+      # Standing instructions for the courier collecting here.
+      # @return [String, nil]
+      def pickup_notes
+        read("pickup_notes")
+      end
+
+      # The IANA zone the store keeps its hours in, normalized to one spelling per zone.
+      # @return [String]
+      def timezone
+        read("timezone")
+      end
+
+      # The share of the delivery fee this store covers by default, as a percentage.
+      # @return [Integer]
+      def default_business_fee_share
+        read("default_business_fee_share")
+      end
+
+      # Which shape this store's default split has, and therefore which of the two fields above and below is in force.
+      # One of: "percent", "business_amount", "customer_amount".
+      # @return [String]
+      def default_fee_split_mode
+        read("default_fee_split_mode")
+      end
+
+      # The amount the two amount modes divide the fee by, in cents.
+      # @return [Integer, nil]
+      def default_fee_split_amount_cents
+        read("default_fee_split_amount_cents")
+      end
+
+      # How much of Listo the store itself uses.
+      # One of: "api_only", "wallet", "full".
+      # @return [String]
+      def access_tier
+        read("access_tier")
+      end
+
+      # Your own markup on every delivery of this store, in cents.
+      # @return [Integer]
+      def markup_cents
+        read("markup_cents")
+      end
+
+      # Whose balance pays this store's deliveries, read off `access_tier` so you never have to derive it: `partner` is yours, `store` is the...
+      # One of: "partner", "store".
+      # @return [String]
+      def billing
+        read("billing")
+      end
+
+      # @return [Boolean]
+      def test
+        read("test")
+      end
+
+      # @return [String]
+      def created_at
+        read("created_at")
+      end
+
+      # The store's Plan Listo, or `null` when the store needs no plan: a test store, or a live store created before Plan Listo existed, which...
+      # @return [Models::Store::Plan, nil]
+      def plan
+        read("plan")
+      end
+
+      # The store's Plan Listo, or `null` when the store needs no plan: a test store, or a live store created before Plan Listo existed, which...
+      class Plan < Model
+        TYPES = {
+          "status" => nil,
+          "price_cents" => nil,
+          "currency" => nil,
+          "interval" => nil,
+          "current_period_ends_on" => nil,
+          "next_charge_on" => nil,
+          "canceled_at" => nil,
+          "ends_on" => nil,
+          "paid_by" => nil,
+          "pending_paid_by" => nil,
+          "pending_paid_by_on" => nil,
+          "courtesy" => nil
+        }.freeze
+
+        # `active` is paid up and renews on `next_charge_on` (null on a plan that is passing to the restaurant, see `pending_paid_by`).
+        # One of: "active", "past_due", "canceling", "canceled", "awaiting_payment".
+        # @return [String]
+        def status
+          read("status")
+        end
+
+        # What one month of this store's plan costs you, before IVA: your price, even while a restaurant that connected to you is still paying its...
+        # @return [Integer]
+        def price_cents
+          read("price_cents")
+        end
+
+        # @return [String]
+        def currency
+          read("currency")
+        end
+
+        # How long one period of this plan is, and the cycle `price_cents` is the price of.
+        # @return [String]
+        def interval
+          read("interval")
+        end
+
+        # The last day of the current period, already paid unless `status` is `past_due`.
+        # @return [String, nil]
+        def current_period_ends_on
+          read("current_period_ends_on")
+        end
+
+        # The day you are charged next: the next renewal, or, while a restaurant that connected to you still pays its own plan, your first charge.
+        # @return [String, nil]
+        def next_charge_on
+          read("next_charge_on")
+        end
+
+        # When you canceled the plan.
+        # @return [String, nil]
+        def canceled_at
+          read("canceled_at")
+        end
+
+        # The day the plan stops serving the store, which is the day after the last day paid, or the day a plan whose charge was pending was canceled.
+        # @return [String, nil]
+        def ends_on
+          read("ends_on")
+        end
+
+        # Who pays this plan: `partner`, which is you, or `store`, the restaurant itself.
+        # One of: "partner", "store".
+        # @return [String]
+        def paid_by
+          read("paid_by")
+        end
+
+        # Who will pay it from `pending_paid_by_on`, when that is about to change, or null.
+        # @return [String, nil]
+        def pending_paid_by
+          read("pending_paid_by")
+        end
+
+        # The date that change lands (the day the new payer's first period starts), or null.
+        # @return [String, nil]
+        def pending_paid_by_on
+          read("pending_paid_by_on")
+        end
+
+        # `courtesy` is true while Listo waives this store's plan: nothing is charged and `next_charge_on` is null.
+        # @return [Boolean]
+        def courtesy
+          read("courtesy")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# 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 store's balance, for the store's own billing.
+    class StoreBalance < Model
+      TYPES = {
+        "balance_cents" => nil,
+        "available_cents" => nil,
+        "currency" => nil,
+        "billing" => nil,
+        "in_review_cents" => nil
+      }.freeze
+
+      # @return [Integer]
+      def balance_cents
+        read("balance_cents")
+      end
+
+      # @return [Integer]
+      def available_cents
+        read("available_cents")
+      end
+
+      # One of: "MXN".
+      # @return [String]
+      def currency
+        read("currency")
+      end
+
+      # Whose balance pays this store's deliveries.
+      # One of: "partner", "store".
+      # @return [String]
+      def billing
+        read("billing")
+      end
+
+      # The part of `balance_cents` that is cash from an order we are still reviewing.
+      # @return [Integer]
+      def in_review_cents
+        read("in_review_cents")
+      end
+    end
+  end
+end

data/lib/listo_delivery/generated/models/store_connected_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 StoreConnectedEvent < 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