@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api SMS API
@base https://unify.apideck.com
@version 10.24.12
@auth ApiKey Authorization in header
@endpoints 5
@toc sms(5)

@endpoint GET /sms/messages
@required {x-apideck-consumer-id: str, x-apideck-app-id: str}
@optional {raw: bool=false, x-apideck-service-id: str, cursor: str, limit: int=20, fields: str}
@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: [map], _raw: map?, meta: map{items_on_page: int, cursors: map{previous: str?, current: str?, next: str?}}, links: map{previous: str?, current: str, next: str?}}
@errors {400, 401, 402, 404, 422}

@endpoint POST /sms/messages
@required {x-apideck-consumer-id: str, x-apideck-app-id: str, from: str, to: str, body: str}
@optional {raw: bool=false, x-apideck-service-id: str, id: str, subject: str, type: str(sms/mms), number_of_units: int, number_of_media_files: int, direction: str(inbound/outbound-api/outbound-call/outbound-reply/unknown), status: str(accepted/scheduled/canceled/queued/sending/sent/failed/delivered/undelivered/receiving/received/read), scheduled_at: str(date-time), sent_at: str(date-time), webhook_url: str, reference: str, price: map{per_unit: str, total_amount: str, currency: str}, error: map{code: str, message: str}, messaging_service_id: str, custom_mappings: map, updated_by: str, created_by: str, updated_at: str(date-time), created_at: str(date-time), pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}]}
@returns(201) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?}
@errors {400, 401, 402, 404, 422}

@endpoint GET /sms/messages/{id}
@required {id: str, x-apideck-consumer-id: str, x-apideck-app-id: str}
@optional {x-apideck-service-id: str, raw: bool=false, fields: str}
@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str, from: str, to: str, subject: str, body: str, type: str, number_of_units: int, number_of_media_files: int, direction: str, status: str, scheduled_at: str(date-time), sent_at: str(date-time), webhook_url: str, reference: str, price: map{per_unit: str, total_amount: str, currency: str?}, error: map{code: str, message: str}, messaging_service_id: str, custom_mappings: map?, updated_by: str?, created_by: str?, updated_at: str(date-time)?, created_at: str(date-time)?, pass_through: [map]}, _raw: map?}
@errors {400, 401, 402, 404, 422}

@endpoint PATCH /sms/messages/{id}
@required {id: str, x-apideck-consumer-id: str, x-apideck-app-id: str, from: str, to: str, body: str}
@optional {x-apideck-service-id: str, raw: bool=false, id: str, subject: str, type: str(sms/mms), number_of_units: int, number_of_media_files: int, direction: str(inbound/outbound-api/outbound-call/outbound-reply/unknown), status: str(accepted/scheduled/canceled/queued/sending/sent/failed/delivered/undelivered/receiving/received/read), scheduled_at: str(date-time), sent_at: str(date-time), webhook_url: str, reference: str, price: map{per_unit: str, total_amount: str, currency: str}, error: map{code: str, message: str}, messaging_service_id: str, custom_mappings: map, updated_by: str, created_by: str, updated_at: str(date-time), created_at: str(date-time), pass_through: [map{service_id!: str, operation_id: str, extend_object: map, extend_paths: [map]}]}
@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?}
@errors {400, 401, 402, 404, 422}

@endpoint DELETE /sms/messages/{id}
@required {id: str, x-apideck-consumer-id: str, x-apideck-app-id: str}
@optional {x-apideck-service-id: str, raw: bool=false}
@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}, _raw: map?}
@errors {400, 401, 402, 404, 422}

@end