Interface Routes

commonParams: {}

formData: {}

jsonBody: {
    allow_external_modification?: boolean;
    attempt_for_offline_device?: boolean;
    code?: string;
    common_code_key?: string;
    device_id: string;
    ends_at?: string;
    is_external_modification_allowed?: boolean;
    is_offline_access_code?: boolean;
    is_one_time_use?: boolean;
    max_time_rounding?: "1hour" | "1day" | "1h" | "1d";
    name?: string;
    prefer_native_scheduling?: boolean;
    starts_at?: string;
    sync?: boolean;
    use_backup_access_code_pool?: boolean;
    use_offline_access_code?: boolean;
}

• Optional allow_external_modification?: boolean

• Optional attempt_for_offline_device?: boolean

• Optional code?: string

• Optional common_code_key?: string

• device_id: string

• Optional ends_at?: string

• Optional is_external_modification_allowed?: boolean

• Optional is_offline_access_code?: boolean

• Optional is_one_time_use?: boolean

• Optional max_time_rounding?: "1hour" | "1day" | "1h" | "1d"

• Optional name?: string

• Optional prefer_native_scheduling?: boolean

• Optional starts_at?: string

• Optional sync?: boolean

• Optional use_backup_access_code_pool?: boolean

• Optional use_offline_access_code?: boolean

jsonResponse: {
    access_code: {
        access_code_id: string;
        code: null | string;
        common_code_key: null | string;
        created_at: string;
        device_id: string;
        ends_at?: null | string;
        errors?: any;
        is_backup?: boolean;
        is_backup_access_code_available: boolean;
        is_external_modification_allowed: boolean;
        is_managed: true;
        is_offline_access_code: boolean;
        is_one_time_use: boolean;
        is_scheduled_on_device?: boolean;
        is_waiting_for_code_assignment?: boolean;
        name: null | string;
        pulled_backup_access_code_id?: null | string;
        starts_at?: null | string;
        status: "set" | "unknown" | "setting" | "unset" | "removing";
        type: "time_bound" | "ongoing";
        warnings?: any;
    };
    action_attempt: {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result?: any;
        status: "success";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result: null;
        status: "pending";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: {
            message: string;
            type: string;
        };
        result: null;
        status: "error";
    };
}

• access_code: {
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_offline_access_code: boolean;
      is_one_time_use: boolean;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: null | string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }

  • access_code_id: string

    Unique identifier for the access code.

  • code: null | string

    Code used for access. Typically, a numeric or alphanumeric string.

  • common_code_key: null | string

    Unique identifier for a group of access codes that share the same code.

  • created_at: string

    Date and time at which the access code was created.

  • device_id: string

    Unique identifier for the device associated with the access code.

  • Optional ends_at?: null | string

    Date and time after which the time-bound access code becomes inactive.

  • Optional errors?: any

    Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.

  • Optional is_backup?: boolean

    Indicates whether the access code is a backup code.

  • is_backup_access_code_available: boolean

    Indicates whether a backup access code is available for use if the primary access code is lost or compromised.

  • is_external_modification_allowed: boolean

    Indicates whether changes to the access code from external sources are permitted.

  • is_managed: true

    Indicates whether Seam manages the access code.

  • is_offline_access_code: boolean

    Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection.

  • is_one_time_use: boolean

    Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.

  • Optional is_scheduled_on_device?: boolean

    Indicates whether the code is set on the device according to a preconfigured schedule.

  • Optional is_waiting_for_code_assignment?: boolean

    Indicates whether the access code is waiting for a code assignment.

  • name: null | string

    Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.

  • Optional pulled_backup_access_code_id?: null | string

    Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.

  • Optional starts_at?: null | string

    Date and time at which the time-bound access code becomes active.

  • status: "set" | "unknown" | "setting" | "unset" | "removing"

    Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.

  • type: "time_bound" | "ongoing"

    Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.

  • Optional warnings?: any

    Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.

• action_attempt: {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: {
          message: string;
          type: string;
      };
      result: null;
      status: "error";
  }

method: "POST"

queryParams: {}

route: "/access_codes/create"

commonParams: {}

formData: {}

jsonBody: {
    allow_external_modification?: boolean;
    attempt_for_offline_device?: boolean;
    behavior_when_code_cannot_be_shared?: "throw" | "create_random_code";
    code?: string;
    device_ids: string[];
    ends_at?: string;
    is_external_modification_allowed?: boolean;
    is_offline_access_code?: boolean;
    is_one_time_use?: boolean;
    max_time_rounding?: "1hour" | "1day" | "1h" | "1d";
    name?: string;
    prefer_native_scheduling?: boolean;
    starts_at?: string;
    use_backup_access_code_pool?: boolean;
    use_offline_access_code?: boolean;
}

• Optional allow_external_modification?: boolean

• Optional attempt_for_offline_device?: boolean

• Optional behavior_when_code_cannot_be_shared?: "throw" | "create_random_code"

• Optional code?: string

• device_ids: string[]

• Optional ends_at?: string

• Optional is_external_modification_allowed?: boolean

• Optional is_offline_access_code?: boolean

• Optional is_one_time_use?: boolean

• Optional max_time_rounding?: "1hour" | "1day" | "1h" | "1d"

• Optional name?: string

• Optional prefer_native_scheduling?: boolean

• Optional starts_at?: string

• Optional use_backup_access_code_pool?: boolean

• Optional use_offline_access_code?: boolean

jsonResponse: {
    access_codes: {
        access_code_id: string;
        code: null | string;
        common_code_key: null | string;
        created_at: string;
        device_id: string;
        ends_at?: null | string;
        errors?: any;
        is_backup?: boolean;
        is_backup_access_code_available: boolean;
        is_external_modification_allowed: boolean;
        is_managed: true;
        is_offline_access_code: boolean;
        is_one_time_use: boolean;
        is_scheduled_on_device?: boolean;
        is_waiting_for_code_assignment?: boolean;
        name: null | string;
        pulled_backup_access_code_id?: null | string;
        starts_at?: null | string;
        status: "set" | "unknown" | "setting" | "unset" | "removing";
        type: "time_bound" | "ongoing";
        warnings?: any;
    }[];
}

• access_codes: {
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_offline_access_code: boolean;
      is_one_time_use: boolean;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: null | string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }[]

method: "POST" | "PUT"

queryParams: {}

route: "/access_codes/create_multiple"

commonParams: {
    access_code_id: string;
    device_id?: string;
    sync?: boolean;
}

• access_code_id: string

• Optional device_id?: string

• Optional sync?: boolean

formData: {}

jsonBody: {}

jsonResponse: {
    action_attempt: {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result?: any;
        status: "success";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result: null;
        status: "pending";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: {
            message: string;
            type: string;
        };
        result: null;
        status: "error";
    };
}

• action_attempt: {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: {
          message: string;
          type: string;
      };
      result: null;
      status: "error";
  }

method: "POST" | "DELETE"

queryParams: {}

route: "/access_codes/delete"

commonParams: {
    device_id: string;
}

• device_id: string

formData: {}

jsonBody: {}

jsonResponse: {
    generated_code: {
        code: string;
        device_id: string;
    };
}

• generated_code: {
      code: string;
      device_id: string;
  }

  • code: string

  • device_id: string

method: "POST" | "GET"

queryParams: {}

route: "/access_codes/generate_code"

commonParams: {
    access_code_id?: string;
    code?: string;
    device_id?: string;
}

• Optional access_code_id?: string

• Optional code?: string

• Optional device_id?: string

formData: {}

jsonBody: {}

jsonResponse: {
    access_code: {
        access_code_id: string;
        code: null | string;
        common_code_key: null | string;
        created_at: string;
        device_id: string;
        ends_at?: null | string;
        errors?: any;
        is_backup?: boolean;
        is_backup_access_code_available: boolean;
        is_external_modification_allowed: boolean;
        is_managed: true;
        is_offline_access_code: boolean;
        is_one_time_use: boolean;
        is_scheduled_on_device?: boolean;
        is_waiting_for_code_assignment?: boolean;
        name: null | string;
        pulled_backup_access_code_id?: null | string;
        starts_at?: null | string;
        status: "set" | "unknown" | "setting" | "unset" | "removing";
        type: "time_bound" | "ongoing";
        warnings?: any;
    };
}

• access_code: {
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_offline_access_code: boolean;
      is_one_time_use: boolean;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: null | string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }

  • access_code_id: string

    Unique identifier for the access code.

  • code: null | string

    Code used for access. Typically, a numeric or alphanumeric string.

  • common_code_key: null | string

    Unique identifier for a group of access codes that share the same code.

  • created_at: string

    Date and time at which the access code was created.

  • device_id: string

    Unique identifier for the device associated with the access code.

  • Optional ends_at?: null | string

    Date and time after which the time-bound access code becomes inactive.

  • Optional errors?: any

    Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.

  • Optional is_backup?: boolean

    Indicates whether the access code is a backup code.

  • is_backup_access_code_available: boolean

    Indicates whether a backup access code is available for use if the primary access code is lost or compromised.

  • is_external_modification_allowed: boolean

    Indicates whether changes to the access code from external sources are permitted.

  • is_managed: true

    Indicates whether Seam manages the access code.

  • is_offline_access_code: boolean

    Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection.

  • is_one_time_use: boolean

    Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.

  • Optional is_scheduled_on_device?: boolean

    Indicates whether the code is set on the device according to a preconfigured schedule.

  • Optional is_waiting_for_code_assignment?: boolean

    Indicates whether the access code is waiting for a code assignment.

  • name: null | string

    Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.

  • Optional pulled_backup_access_code_id?: null | string

    Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.

  • Optional starts_at?: null | string

    Date and time at which the time-bound access code becomes active.

  • status: "set" | "unknown" | "setting" | "unset" | "removing"

    Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.

  • type: "time_bound" | "ongoing"

    Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.

  • Optional warnings?: any

    Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.

method: "POST" | "GET"

queryParams: {}

route: "/access_codes/get"

commonParams: {
    access_code_ids?: string[];
    device_id?: string;
    user_identifier_key?: string;
}

• Optional access_code_ids?: string[]

• Optional device_id?: string

• Optional user_identifier_key?: string

formData: {}

jsonBody: {}

jsonResponse: {
    access_codes: {
        access_code_id: string;
        code: null | string;
        common_code_key: null | string;
        created_at: string;
        device_id: string;
        ends_at?: null | string;
        errors?: any;
        is_backup?: boolean;
        is_backup_access_code_available: boolean;
        is_external_modification_allowed: boolean;
        is_managed: true;
        is_offline_access_code: boolean;
        is_one_time_use: boolean;
        is_scheduled_on_device?: boolean;
        is_waiting_for_code_assignment?: boolean;
        name: null | string;
        pulled_backup_access_code_id?: null | string;
        starts_at?: null | string;
        status: "set" | "unknown" | "setting" | "unset" | "removing";
        type: "time_bound" | "ongoing";
        warnings?: any;
    }[];
}

• access_codes: {
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_offline_access_code: boolean;
      is_one_time_use: boolean;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: null | string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }[]

method: "POST" | "GET"

queryParams: {}

route: "/access_codes/list"

commonParams: {}

formData: {}

jsonBody: {
    access_code_id: string;
}

• access_code_id: string

jsonResponse: {
    backup_access_code: {
        access_code_id: string;
        code: null | string;
        common_code_key: null | string;
        created_at: string;
        device_id: string;
        ends_at?: null | string;
        errors?: any;
        is_backup?: boolean;
        is_backup_access_code_available: boolean;
        is_external_modification_allowed: boolean;
        is_managed: true;
        is_offline_access_code: boolean;
        is_one_time_use: boolean;
        is_scheduled_on_device?: boolean;
        is_waiting_for_code_assignment?: boolean;
        name: null | string;
        pulled_backup_access_code_id?: null | string;
        starts_at?: null | string;
        status: "set" | "unknown" | "setting" | "unset" | "removing";
        type: "time_bound" | "ongoing";
        warnings?: any;
    };
}

• backup_access_code: {
      access_code_id: string;
      code: null | string;
      common_code_key: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_backup?: boolean;
      is_backup_access_code_available: boolean;
      is_external_modification_allowed: boolean;
      is_managed: true;
      is_offline_access_code: boolean;
      is_one_time_use: boolean;
      is_scheduled_on_device?: boolean;
      is_waiting_for_code_assignment?: boolean;
      name: null | string;
      pulled_backup_access_code_id?: null | string;
      starts_at?: null | string;
      status: "set" | "unknown" | "setting" | "unset" | "removing";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }

  • access_code_id: string

    Unique identifier for the access code.

  • code: null | string

    Code used for access. Typically, a numeric or alphanumeric string.

  • common_code_key: null | string

    Unique identifier for a group of access codes that share the same code.

  • created_at: string

    Date and time at which the access code was created.

  • device_id: string

    Unique identifier for the device associated with the access code.

  • Optional ends_at?: null | string

    Date and time after which the time-bound access code becomes inactive.

  • Optional errors?: any

    Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.

  • Optional is_backup?: boolean

    Indicates whether the access code is a backup code.

  • is_backup_access_code_available: boolean

    Indicates whether a backup access code is available for use if the primary access code is lost or compromised.

  • is_external_modification_allowed: boolean

    Indicates whether changes to the access code from external sources are permitted.

  • is_managed: true

    Indicates whether Seam manages the access code.

  • is_offline_access_code: boolean

    Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection.

  • is_one_time_use: boolean

    Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.

  • Optional is_scheduled_on_device?: boolean

    Indicates whether the code is set on the device according to a preconfigured schedule.

  • Optional is_waiting_for_code_assignment?: boolean

    Indicates whether the access code is waiting for a code assignment.

  • name: null | string

    Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.

  • Optional pulled_backup_access_code_id?: null | string

    Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.

  • Optional starts_at?: null | string

    Date and time at which the time-bound access code becomes active.

  • status: "set" | "unknown" | "setting" | "unset" | "removing"

    Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.

  • type: "time_bound" | "ongoing"

    Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.

  • Optional warnings?: any

    Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.

method: "POST"

queryParams: {}

route: "/access_codes/pull_backup_access_code"

commonParams: {}

formData: {}

jsonBody: {
    code: string;
    device_id: string;
    name: string;
}

• code: string

• device_id: string

• name: string

jsonResponse: {
    access_code: {
        access_code_id: string;
        code: null | string;
        created_at: string;
        device_id: string;
        ends_at?: null | string;
        errors?: any;
        is_managed: false;
        name: null | string;
        starts_at?: null | string;
        status: "set";
        type: "time_bound" | "ongoing";
        warnings?: any;
    };
}

• access_code: {
      access_code_id: string;
      code: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_managed: false;
      name: null | string;
      starts_at?: null | string;
      status: "set";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }

  • access_code_id: string

    Unique identifier for the access code.

  • code: null | string

    Code used for access. Typically, a numeric or alphanumeric string.

  • created_at: string

    Date and time at which the access code was created.

  • device_id: string

    Unique identifier for the device associated with the access code.

  • Optional ends_at?: null | string

    Date and time after which the time-bound access code becomes inactive.

  • Optional errors?: any

    Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.

  • is_managed: false

  • name: null | string

    Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.

  • Optional starts_at?: null | string

    Date and time at which the time-bound access code becomes active.

  • status: "set"

  • type: "time_bound" | "ongoing"

    Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.

  • Optional warnings?: any

    Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.

method: "POST"

queryParams: {}

route: "/access_codes/simulate/create_unmanaged_access_code"

commonParams: {
    access_code_id: string;
    allow_external_modification?: boolean;
    force?: boolean;
    is_external_modification_allowed?: boolean;
    sync?: boolean;
}

• access_code_id: string

• Optional allow_external_modification?: boolean

• Optional force?: boolean

• Optional is_external_modification_allowed?: boolean

• Optional sync?: boolean

formData: {}

jsonBody: {}

jsonResponse: {}

method: "POST" | "PATCH"

queryParams: {}

route: "/access_codes/unmanaged/convert_to_managed"

commonParams: {
    access_code_id: string;
    sync?: boolean;
}

• access_code_id: string

• Optional sync?: boolean

formData: {}

jsonBody: {}

jsonResponse: {
    action_attempt: {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result?: any;
        status: "success";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: null;
        result: null;
        status: "pending";
    } | {
        action_attempt_id: string;
        action_type: string;
        error: {
            message: string;
            type: string;
        };
        result: null;
        status: "error";
    };
}

• action_attempt: {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: {
          message: string;
          type: string;
      };
      result: null;
      status: "error";
  }

method: "POST" | "DELETE"

queryParams: {}

route: "/access_codes/unmanaged/delete"

commonParams: {
    access_code_id?: string;
    code?: string;
    device_id?: string;
}

• Optional access_code_id?: string

• Optional code?: string

• Optional device_id?: string

formData: {}

jsonBody: {}

jsonResponse: {
    access_code: {
        access_code_id: string;
        code: null | string;
        created_at: string;
        device_id: string;
        ends_at?: null | string;
        errors?: any;
        is_managed: false;
        name: null | string;
        starts_at?: null | string;
        status: "set";
        type: "time_bound" | "ongoing";
        warnings?: any;
    };
}

• access_code: {
      access_code_id: string;
      code: null | string;
      created_at: string;
      device_id: string;
      ends_at?: null | string;
      errors?: any;
      is_managed: false;
      name: null | string;
      starts_at?: null | string;
      status: "set";
      type: "time_bound" | "ongoing";
      warnings?: any;
  }

  • access_code_id: string

    Unique identifier for the access code.

  • code: null | string

    Code used for access. Typically, a numeric or alphanumeric string.

  • created_at: string

    Date and time at which the access code was created.

  • device_id: string

    Unique identifier for the device associated with the access code.

  • Optional ends_at?: null | string

    Date and time after which the time-bound access code becomes inactive.

  • Optional errors?: any

    Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.

  • is_managed: false

  • name: null | string

    Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.

  • Optional starts_at?: null | string

    Date and time at which the time-bound access code becomes active.

  • status: "set"

  • type: "time_bound" | "ongoing"

    Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.

  • Optional warnings?: any

    Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.