dataservices-api/client/renderer/interface.yaml

---
- name: cdb_geocode_admin0_polygon
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: country_name, type: text }

- name: cdb_geocode_admin1_polygon
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: admin1_name, type: text }

- name: cdb_geocode_admin1_polygon
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: admin1_name,  type: text }
    - { name: country_name, type: text }

- name: cdb_geocode_namedplace_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: city_name, type: text}

- name: cdb_geocode_namedplace_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: city_name,    type: text}
    - { name: country_name, type: text}

- name: cdb_geocode_namedplace_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: city_name,    type: text}
    - { name: admin1_name,  type: text}
    - { name: country_name, type: text}

- name: cdb_geocode_postalcode_polygon
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: postal_code,  type: text}
    - { name: country_name, type: text}

- name: cdb_geocode_postalcode_polygon
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: postal_code,  type: double precision}
    - { name: country_name, type: text}

- name: cdb_geocode_postalcode_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: postal_code,  type: text}
    - { name: country_name, type: text}

- name: cdb_geocode_postalcode_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: postal_code,  type: double precision}
    - { name: country_name, type: text}

- name: cdb_geocode_ipaddress_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: ip_address,  type: text}

- name: cdb_geocode_street_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: searchtext,  type: text}
    - { name: city,  type: text, default: 'NULL'}
    - { name: state_province,  type: text, default: 'NULL'}
    - { name: country,  type: text, default: 'NULL'}

- name: _cdb_bulk_geocode_street_point
  return_type: SETOF cdb_dataservices_client.geocoding
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: searches,  type: jsonb } # Array of JSON objects with id, address, city, state and country fields

- name: cdb_here_geocode_street_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: searchtext,  type: text}
    - { name: city,  type: text, default: 'NULL'}
    - { name: state_province,  type: text, default: 'NULL'}
    - { name: country,  type: text, default: 'NULL'}

- name: cdb_google_geocode_street_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: searchtext,  type: text}
    - { name: city,  type: text, default: 'NULL'}
    - { name: state_province,  type: text, default: 'NULL'}
    - { name: country,  type: text, default: 'NULL'}

- name: cdb_mapbox_geocode_street_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: searchtext,  type: text}
    - { name: city,  type: text, default: 'NULL'}
    - { name: state_province,  type: text, default: 'NULL'}
    - { name: country,  type: text, default: 'NULL'}

- name: cdb_tomtom_geocode_street_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: searchtext,  type: text}
    - { name: city,  type: text, default: 'NULL'}
    - { name: state_province,  type: text, default: 'NULL'}
    - { name: country,  type: text, default: 'NULL'}

- name: cdb_geocodio_geocode_street_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: searchtext,  type: text}
    - { name: city,  type: text, default: 'NULL'}
    - { name: state_province,  type: text, default: 'NULL'}
    - { name: country,  type: text, default: 'NULL'}

- name: cdb_mapzen_geocode_street_point
  return_type: public.Geometry
  requires_permission: true
  permission_name: geocoding
  permission_error: Geocoding permission denied
  params:
    - { name: searchtext,  type: text}
    - { name: city,  type: text, default: 'NULL'}
    - { name: state_province,  type: text, default: 'NULL'}
    - { name: country,  type: text, default: 'NULL'}

- name: cdb_isodistance
  return_type: SETOF cdb_dataservices_client.isoline
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: isolines
  permission_error: Isolines permission denied
  params:
    - { name: source,  type: "public.geometry(Geometry, 4326)" }
    - { name: mode, type: text }
    - { name: range, type: "integer[]" }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }

- name: cdb_isochrone
  return_type: SETOF cdb_dataservices_client.isoline
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: isolines
  permission_error: Isolines permission denied
  params:
    - { name: source,  type: "public.geometry(Geometry, 4326)" }
    - { name: mode, type: text }
    - { name: range, type: "integer[]" }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }

- name: cdb_mapbox_isochrone
  return_type: SETOF cdb_dataservices_client.isoline
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: isolines
  permission_error: Isolines permission denied
  params:
    - { name: source,  type: "public.geometry(Geometry, 4326)" }
    - { name: mode, type: text }
    - { name: range, type: "integer[]" }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }

- name: cdb_tomtom_isochrone
  return_type: SETOF cdb_dataservices_client.isoline
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: isolines
  permission_error: Isolines permission denied
  params:
    - { name: source,  type: "public.geometry(Geometry, 4326)" }
    - { name: mode, type: text }
    - { name: range, type: "integer[]" }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }

- name: cdb_mapzen_isochrone
  return_type: SETOF cdb_dataservices_client.isoline
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: isolines
  permission_error: Isolines permission denied
  params:
    - { name: source,  type: "public.geometry(Geometry, 4326)" }
    - { name: mode, type: text }
    - { name: range, type: "integer[]" }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }

- name: cdb_mapbox_isodistance
  return_type: SETOF cdb_dataservices_client.isoline
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: isolines
  permission_error: Isolines permission denied
  params:
    - { name: source,  type: "public.geometry(Geometry, 4326)" }
    - { name: mode, type: text }
    - { name: range, type: "integer[]" }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }

- name: cdb_tomtom_isodistance
  return_type: SETOF cdb_dataservices_client.isoline
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: isolines
  permission_error: Isolines permission denied
  params:
    - { name: source,  type: "public.geometry(Geometry, 4326)" }
    - { name: mode, type: text }
    - { name: range, type: "integer[]" }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }

- name: cdb_mapzen_isodistance
  return_type: SETOF cdb_dataservices_client.isoline
  multi_row: true
  multi_field: true
  requires_permission: true
  permission_name: isolines
  permission_error: Isolines permission denied
  params:
    - { name: source,  type: "public.geometry(Geometry, 4326)" }
    - { name: mode, type: text }
    - { name: range, type: "integer[]" }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }

- name: cdb_route_point_to_point
  return_type: cdb_dataservices_client.simple_route
  multi_field: true
  requires_permission: true
  permission_name: routing
  permission_error: Routing permission denied
  params:
    - { name: origin,  type: "public.geometry(Point, 4326)" }
    - { name: destination,  type: "public.geometry(Point, 4326)" }
    - { name: mode, type: text }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }
    - { name: units, type: "text", default: "'kilometers'"}

- name: cdb_route_with_waypoints
  return_type: cdb_dataservices_client.simple_route
  multi_field: true
  requires_permission: true
  permission_name: routing
  permission_error: Routing permission denied
  params:
    - { name: waypoints,  type: "public.geometry(Point, 4326)[]" }
    - { name: mode, type: text }
    - { name: options, type: "text[]", default: 'ARRAY[]::text[]' }
    - { name: units, type: "text", default: "'kilometers'"}

- name: cdb_service_quota_info
  return_type: SETOF service_quota_info
  multi_row: true
  multi_field: true
  params:
    - {}

- name: cdb_service_quota_info_batch
  return_type: SETOF service_quota_info_batch
  multi_row: true
  multi_field: true
  params:
    - {}

- name: cdb_enough_quota
  return_type: BOOLEAN
  params:
    - { name: service, type: TEXT }
    - { name: input_size, type: NUMERIC }

- name: cdb_service_get_rate_limit
  return_type: json
  params:
    - { name: service,  type: "text" }

- name: cdb_service_set_user_rate_limit
  superuser: true
  return_type: void
  params:
    - { name: service,  type: "text" }
    - { name: rate_limit, type: json }

- name: cdb_service_set_org_rate_limit
  superuser: true
  return_type: void
  params:
    - { name: service,  type: "text" }
    - { name: rate_limit, type: json }

- name: cdb_service_set_server_rate_limit
  superuser: true
  return_type: void
  params:
    - { name: service,  type: "text" }
    - { name: rate_limit, type: json }