@doorstepai/dropoff-sdk-capacitor 1.0.0

package/dist/docs.json

@@ -0,0 +1,705 @@
+{
+  "api": {
+    "name": "DoorstepAIDropoffSDKPlugin",
+    "slug": "doorstepaidropoffsdkplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "init",
+        "signature": "(options?: InitOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "InitOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Android-only: initialize the foreground service and notification.\nNo-op on iOS. Safe to call multiple times. Call once at app startup\nbefore any other method.",
+        "complexTypes": [
+          "InitOptions"
+        ],
+        "slug": "init"
+      },
+      {
+        "name": "setApiKey",
+        "signature": "(options: SetApiKeyOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SetApiKeyOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Set the API key. Call once after {@link init}.",
+        "complexTypes": [
+          "SetApiKeyOptions"
+        ],
+        "slug": "setapikey"
+      },
+      {
+        "name": "startDeliveryByPlaceID",
+        "signature": "(options: StartDeliveryByPlaceIDOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "StartDeliveryByPlaceIDOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "StartDeliveryByPlaceIDOptions"
+        ],
+        "slug": "startdeliverybyplaceid"
+      },
+      {
+        "name": "startDeliveryByPlusCode",
+        "signature": "(options: StartDeliveryByPlusCodeOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "StartDeliveryByPlusCodeOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "StartDeliveryByPlusCodeOptions"
+        ],
+        "slug": "startdeliverybypluscode"
+      },
+      {
+        "name": "startDeliveryByAddress",
+        "signature": "(options: StartDeliveryByAddressOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "StartDeliveryByAddressOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Alias for {@link startDeliveryByAddressType} — kept for parity with the Flutter SDK.",
+        "complexTypes": [
+          "StartDeliveryByAddressOptions"
+        ],
+        "slug": "startdeliverybyaddress"
+      },
+      {
+        "name": "startDeliveryByAddressType",
+        "signature": "(options: StartDeliveryByAddressOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "StartDeliveryByAddressOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "StartDeliveryByAddressOptions"
+        ],
+        "slug": "startdeliverybyaddresstype"
+      },
+      {
+        "name": "startDeliveryByAddressString",
+        "signature": "(options: StartDeliveryByAddressStringOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "StartDeliveryByAddressStringOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "StartDeliveryByAddressStringOptions"
+        ],
+        "slug": "startdeliverybyaddressstring"
+      },
+      {
+        "name": "startDeliveryByLatLng",
+        "signature": "(options: StartDeliveryByLatLngOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "StartDeliveryByLatLngOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "StartDeliveryByLatLngOptions"
+        ],
+        "slug": "startdeliverybylatlng"
+      },
+      {
+        "name": "markDropoff",
+        "signature": "(options: MarkDropoffOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "MarkDropoffOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "MarkDropoffOptions"
+        ],
+        "slug": "markdropoff"
+      },
+      {
+        "name": "newEvent",
+        "signature": "(options: NewEventOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "NewEventOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "NewEventOptions"
+        ],
+        "slug": "newevent"
+      },
+      {
+        "name": "stopDelivery",
+        "signature": "(options: StopDeliveryOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "StopDeliveryOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "StopDeliveryOptions"
+        ],
+        "slug": "stopdelivery"
+      },
+      {
+        "name": "checkPermissions",
+        "signature": "() => Promise<PermissionStatus>",
+        "parameters": [],
+        "returns": "Promise<PermissionStatus>",
+        "tags": [],
+        "docs": "Returns the current grant state for each permission the SDK uses.",
+        "complexTypes": [
+          "PermissionStatus"
+        ],
+        "slug": "checkpermissions"
+      },
+      {
+        "name": "requestPermissions",
+        "signature": "(options?: PermissionRequestOptions | undefined) => Promise<PermissionStatus>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PermissionRequestOptions | undefined"
+          }
+        ],
+        "returns": "Promise<PermissionStatus>",
+        "tags": [],
+        "docs": "Requests the specified permissions (or all if `permissions` is omitted)\nand resolves with the resulting state for each.",
+        "complexTypes": [
+          "PermissionStatus",
+          "PermissionRequestOptions"
+        ],
+        "slug": "requestpermissions"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "InitOptions",
+      "slug": "initoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "notificationTitle",
+          "tags": [],
+          "docs": "Android only: title shown in the foreground-service notification.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "notificationText",
+          "tags": [],
+          "docs": "Android only: body text shown in the foreground-service notification.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "SetApiKeyOptions",
+      "slug": "setapikeyoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "key",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "StartDeliveryByPlaceIDOptions",
+      "slug": "startdeliverybyplaceidoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "placeID",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "deliveryId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "timeoutSeconds",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "StartDeliveryByPlusCodeOptions",
+      "slug": "startdeliverybypluscodeoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "plusCode",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "deliveryId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "timeoutSeconds",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "StartDeliveryByAddressOptions",
+      "slug": "startdeliverybyaddressoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "address",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "AddressType"
+          ],
+          "type": "AddressType"
+        },
+        {
+          "name": "deliveryId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "coordinates",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "LatLngObject"
+          ],
+          "type": "LatLngObject"
+        },
+        {
+          "name": "timeoutSeconds",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "AddressType",
+      "slug": "addresstype",
+      "docs": "Structured address used by {@link DoorstepAIDropoffSDKPlugin.startDeliveryByAddress}.\nField names mirror the Google Places address-component types.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "streetNumber",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "route",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "subPremise",
+          "tags": [],
+          "docs": "Apartment / unit / suite. Optional.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "locality",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "administrativeAreaLevel1",
+          "tags": [],
+          "docs": "State / province (e.g. \"CA\").",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "postalCode",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "LatLngObject",
+      "slug": "latlngobject",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "lat",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "lng",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "StartDeliveryByAddressStringOptions",
+      "slug": "startdeliverybyaddressstringoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "address",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "deliveryId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "coordinates",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "LatLngObject"
+          ],
+          "type": "LatLngObject"
+        },
+        {
+          "name": "timeoutSeconds",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "StartDeliveryByLatLngOptions",
+      "slug": "startdeliverybylatlngoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "latitude",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "longitude",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "subUnit",
+          "tags": [],
+          "docs": "Apartment / unit. Optional, defaults to `\"\"`.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "deliveryId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "timeoutSeconds",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "MarkDropoffOptions",
+      "slug": "markdropoffoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "deliveryId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "dropoffType",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "DropoffType"
+          ],
+          "type": "DropoffType"
+        }
+      ]
+    },
+    {
+      "name": "NewEventOptions",
+      "slug": "neweventoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "eventName",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "deliveryId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "StopDeliveryOptions",
+      "slug": "stopdeliveryoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "deliveryId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PermissionStatus",
+      "slug": "permissionstatus",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "location",
+          "tags": [],
+          "docs": "Foreground location (when-in-use). Both platforms.",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "PermissionState"
+        },
+        {
+          "name": "activity",
+          "tags": [],
+          "docs": "Activity recognition / motion.\nAndroid: `ACTIVITY_RECOGNITION`. iOS: `NSMotionUsageDescription`.",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "PermissionState"
+        }
+      ]
+    },
+    {
+      "name": "PermissionRequestOptions",
+      "slug": "permissionrequestoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "permissions",
+          "tags": [],
+          "docs": "If omitted, requests all permissions.",
+          "complexTypes": [
+            "DoorstepPermissionType"
+          ],
+          "type": "DoorstepPermissionType[] | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "DropoffType",
+      "slug": "dropofftype",
+      "docs": "Type of dropoff for {@link DoorstepAIDropoffSDKPlugin.markDropoff}.\nMaps to the native SDK's `\"pod\"` / `\"non_pod\"` strings.",
+      "types": [
+        {
+          "text": "'pod'",
+          "complexTypes": []
+        },
+        {
+          "text": "'non_pod'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "PermissionState",
+      "slug": "permissionstate",
+      "docs": "",
+      "types": [
+        {
+          "text": "'prompt'",
+          "complexTypes": []
+        },
+        {
+          "text": "'prompt-with-rationale'",
+          "complexTypes": []
+        },
+        {
+          "text": "'granted'",
+          "complexTypes": []
+        },
+        {
+          "text": "'denied'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "DoorstepPermissionType",
+      "slug": "doorsteppermissiontype",
+      "docs": "",
+      "types": [
+        {
+          "text": "'location'",
+          "complexTypes": []
+        },
+        {
+          "text": "'activity'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}