import "./chunk-YPSWSI3M.js";

// src/docs/address-suggestions.json
var address_suggestions_default = '# Address Suggestions API\n\n- **Base URL:** `https://address-suggestions-api.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/address-suggestions](https://docs.epilot.io/api/address-suggestions)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.addressSuggestions.getAddresses(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/address-suggestions\'\n\nconst addressSuggestionsClient = getClient()\nauthorize(addressSuggestionsClient, () => \'<token>\')\nconst { data } = await addressSuggestionsClient.getAddresses(...)\n```\n\n## Operations\n\n**Addresses API**\n- [`getAddresses`](#getaddresses)\n- [`checkAvailability`](#checkavailability)\n- [`validateAddressesFile`](#validateaddressesfile)\n\n**Schemas**\n- [`AvailabilityLocation`](#availabilitylocation)\n- [`AvailabilityResult`](#availabilityresult)\n- [`Error`](#error)\n- [`AddressSuggestion`](#addresssuggestion)\n- [`AddressSuggestions`](#addresssuggestions)\n- [`ValidateAddressSuggestionsFileResult`](#validateaddresssuggestionsfileresult)\n- [`ValidateAddressFileResult`](#validateaddressfileresult)\n- [`AddressSuggestionError`](#addresssuggestionerror)\n- [`ValidateAddressFileError`](#validateaddressfileerror)\n\n### `getAddresses`\n\nget addresses from file\n\n`GET /v1/public/suggestions`\n\n```ts\nconst { data } = await client.getAddresses({\n  X-Epilot-Org-ID: \'example\',\n  s3FileUrl: \'example\',\n  fileId: \'example\',\n  countryCodeSearchTerm: \'example\',\n  postalCodeSearchTerm: \'example\',\n  streetSearchTerm: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "country": "string",\n    "postal_code": "string",\n    "city": "string",\n    "street": "string",\n    "street_number": "string"\n  }\n]\n```\n\n</details>\n\n---\n\n### `checkAvailability`\n\nCheck address availability\n\n`GET /v1/public/availability:check`\n\n```ts\nconst { data } = await client.checkAvailability({\n  X-Epilot-Org-ID: \'example\',\n  files: \'example\',\n  countryCode: \'example\',\n  postalCode: \'example\',\n  street: \'example\',\n  streetNumber: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "fileId": "4e7b7d95-ced6-4f5f-9326-0c61f30dcadb"\n}\n```\n\n</details>\n\n---\n\n### `validateAddressesFile`\n\nvalidate addresses file\n\n`GET /v1/addresses-files:validate`\n\n```ts\nconst { data } = await client.validateAddressesFile({\n  fileId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "status": "success",\n  "rules_parsed_count": 0,\n  "errors": [\n    {\n      "line": 0,\n      "msg": "string",\n      "data": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `AvailabilityLocation`\n\n```ts\ntype AvailabilityLocation = {\n  street?: string\n  street_number?: string\n  postal_code?: string\n  city?: string\n  country?: string\n}\n```\n\n### `AvailabilityResult`\n\n```ts\ntype AvailabilityResult = {\n  fileId?: string\n}\n```\n\n### `Error`\n\n```ts\ntype Error = {\n  message: string\n  status?: number\n  cause?: string\n}\n```\n\n### `AddressSuggestion`\n\nThe address suggestions entity\n\n```ts\ntype AddressSuggestion = {\n  country?: string\n  postal_code?: string\n  city?: string\n  street?: string\n  street_number?: string\n}\n```\n\n### `AddressSuggestions`\n\nThe address suggestions entity array\n\n```ts\ntype AddressSuggestions = Array<{\n  country?: string\n  postal_code?: string\n  city?: string\n  street?: string\n  street_number?: string\n}>\n```\n\n### `ValidateAddressSuggestionsFileResult`\n\nThe availability map file result payload\n\n```ts\ntype ValidateAddressSuggestionsFileResult = {\n  status?: "success" | "error"\n  rules_parsed_count?: number\n  errors?: Array<{\n    line?: number\n    msg: string\n    data?: string\n  }>\n}\n```\n\n### `ValidateAddressFileResult`\n\nThe address file validation result payload\n\n```ts\ntype ValidateAddressFileResult = {\n  status?: "success" | "error"\n  rules_parsed_count?: number\n  errors?: Array<{\n    line?: number\n    msg: string\n    data?: string\n  }>\n}\n```\n\n### `AddressSuggestionError`\n\nThe availability rule error\n\n```ts\ntype AddressSuggestionError = {\n  line?: number\n  msg: string\n  data?: string\n}\n```\n\n### `ValidateAddressFileError`\n\nThe address rule error\n\n```ts\ntype ValidateAddressFileError = {\n  line?: number\n  msg: string\n  data?: string\n}\n```\n';
export {
  address_suggestions_default as default
};
