commit e8e0b9d7004e1f14349715f748aebb2057231356 · anil.recoil.org/ocaml-jmap

+4 -1

AGENT.md

···

       15
        
       Read your instructions from this file, and mark successfully completed instructions

     

       16
        
       with DONE so that you will know what to do next when reinvoked in the future.

     

       17
        
       

     

       18
       -
       1. Define core OCaml type definitions corresponding to the JMAP protocol

     

       19
        
          specification, in a new Jmap.Types module.

     

       0
        
       
     

       0
        
       
     

       0

···

       15
        
       Read your instructions from this file, and mark successfully completed instructions

     

       16
        
       with DONE so that you will know what to do next when reinvoked in the future.

     

       17
        
       

     

       18
       +
       1. DONE Define core OCaml type definitions corresponding to the JMAP protocol

     

       19
        
          specification, in a new Jmap.Types module.

     

       20
       +
       2. Add a `Jmap_api` module to make JMAP API requests over HTTP and parse the

     

       21
       +
          responses into the `Jmap_types`. Use `Cohttp_lwt_unix` for the HTTP library.

     

       22
       +
       3. Add an implementation of the Jmap_session handling.

+307

lib/jmap.ml

···

       1
       +
       (**

     

       2
       +
        * JMAP protocol implementation based on RFC8620

     

       3
       +
        * https://datatracker.ietf.org/doc/html/rfc8620

     

       4
       +
        *)

     

       5
       +
       

     

       6
       +
       module Types = struct

     

       7
       +
         (** Id string as per Section 1.2 *)

     

       8
       +
         type id = string

     

       9
       +
       

     

       10
       +
         (** Int bounded within the range -2^53+1 to 2^53-1 as per Section 1.3 *)

     

       11
       +
         type int_t = int

     

       12
       +
       

     

       13
       +
         (** UnsignedInt bounded within the range 0 to 2^53-1 as per Section 1.3 *)

     

       14
       +
         type unsigned_int = int

     

       15
       +
       

     

       16
       +
         (** Date string in RFC3339 format as per Section 1.4 *)

     

       17
       +
         type date = string

     

       18
       +
       

     

       19
       +
         (** UTCDate is a Date with 'Z' time zone as per Section 1.4 *)

     

       20
       +
         type utc_date = string

     

       21
       +
       

     

       22
       +
         (** Error object as per Section 3.6.2 *)

     

       23
       +
         type error = {

     

       24
       +
           type_: string;

     

       25
       +
           description: string option;

     

       26
       +
         }

     

       27
       +
       

     

       28
       +
         (** Set error object as per Section 5.3 *)

     

       29
       +
         type set_error = {

     

       30
       +
           type_: string;

     

       31
       +
           description: string option;

     

       32
       +
           properties: string list option;

     

       33
       +
           (* Additional properties for specific error types *)

     

       34
       +
           existing_id: id option; (* For alreadyExists error *)

     

       35
       +
         }

     

       36
       +
       

     

       37
       +
         (** Invocation object as per Section 3.2 *)

     

       38
       +
         type 'a invocation = {

     

       39
       +
           name: string;

     

       40
       +
           arguments: 'a;

     

       41
       +
           method_call_id: string;

     

       42
       +
         }

     

       43
       +
       

     

       44
       +
         (** ResultReference object as per Section 3.7 *)

     

       45
       +
         type result_reference = {

     

       46
       +
           result_of: string;

     

       47
       +
           name: string;

     

       48
       +
           path: string;

     

       49
       +
         }

     

       50
       +
       

     

       51
       +
         (** FilterOperator, FilterCondition and Filter as per Section 5.5 *)

     

       52
       +
         type filter_operator = {

     

       53
       +
           operator: string; (* "AND", "OR", "NOT" *)

     

       54
       +
           conditions: filter list;

     

       55
       +
         }

     

       56
       +
         and filter_condition = (string * Ezjsonm.value) list

     

       57
       +
         and filter = 

     

       58
       +
           | Operator of filter_operator

     

       59
       +
           | Condition of filter_condition

     

       60
       +
       

     

       61
       +
         (** Comparator object for sorting as per Section 5.5 *)

     

       62
       +
         type comparator = {

     

       63
       +
           property: string;

     

       64
       +
           is_ascending: bool option; (* Optional, defaults to true *)

     

       65
       +
           collation: string option;  (* Optional, server-dependent default *)

     

       66
       +
         }

     

       67
       +
       

     

       68
       +
         (** PatchObject as per Section 5.3 *)

     

       69
       +
         type patch_object = (string * Ezjsonm.value) list

     

       70
       +
       

     

       71
       +
         (** AddedItem structure as per Section 5.6 *)

     

       72
       +
         type added_item = {

     

       73
       +
           id: id;

     

       74
       +
           index: unsigned_int;

     

       75
       +
         }

     

       76
       +
       

     

       77
       +
         (** Account object as per Section 1.6.2 *)

     

       78
       +
         type account = {

     

       79
       +
           name: string;

     

       80
       +
           is_personal: bool;

     

       81
       +
           is_read_only: bool;

     

       82
       +
           account_capabilities: (string * Ezjsonm.value) list;

     

       83
       +
         }

     

       84
       +
       

     

       85
       +
         (** Core capability object as per Section 2 *)

     

       86
       +
         type core_capability = {

     

       87
       +
           max_size_upload: unsigned_int;

     

       88
       +
           max_concurrent_upload: unsigned_int;

     

       89
       +
           max_size_request: unsigned_int;

     

       90
       +
           max_concurrent_requests: unsigned_int;

     

       91
       +
           max_calls_in_request: unsigned_int;

     

       92
       +
           max_objects_in_get: unsigned_int;

     

       93
       +
           max_objects_in_set: unsigned_int;

     

       94
       +
           collation_algorithms: string list;

     

       95
       +
         }

     

       96
       +
       

     

       97
       +
         (** PushSubscription keys object as per Section 7.2 *)

     

       98
       +
         type push_keys = {

     

       99
       +
           p256dh: string;

     

       100
       +
           auth: string;

     

       101
       +
         }

     

       102
       +
       

     

       103
       +
         (** Session object as per Section 2 *)

     

       104
       +
         type session = {

     

       105
       +
           capabilities: (string * Ezjsonm.value) list;

     

       106
       +
           accounts: (id * account) list;

     

       107
       +
           primary_accounts: (string * id) list;

     

       108
       +
           username: string;

     

       109
       +
           api_url: string;

     

       110
       +
           download_url: string;

     

       111
       +
           upload_url: string;

     

       112
       +
           event_source_url: string option;

     

       113
       +
           state: string;

     

       114
       +
         }

     

       115
       +
       

     

       116
       +
         (** TypeState for state changes as per Section 7.1 *)

     

       117
       +
         type type_state = (string * string) list

     

       118
       +
       

     

       119
       +
         (** StateChange object as per Section 7.1 *)

     

       120
       +
         type state_change = {

     

       121
       +
           changed: (id * type_state) list;

     

       122
       +
         }

     

       123
       +
       

     

       124
       +
         (** PushVerification object as per Section 7.2.2 *)

     

       125
       +
         type push_verification = {

     

       126
       +
           push_subscription_id: id;

     

       127
       +
           verification_code: string;

     

       128
       +
         }

     

       129
       +
       

     

       130
       +
         (** PushSubscription object as per Section 7.2 *)

     

       131
       +
         type push_subscription = {

     

       132
       +
           id: id;

     

       133
       +
           device_client_id: string;

     

       134
       +
           url: string;

     

       135
       +
           keys: push_keys option;

     

       136
       +
           verification_code: string option;

     

       137
       +
           expires: utc_date option;

     

       138
       +
           types: string list option;

     

       139
       +
         }

     

       140
       +
       

     

       141
       +
         (** Request object as per Section 3.3 *)

     

       142
       +
         type request = {

     

       143
       +
           using: string list;

     

       144
       +
           method_calls: Ezjsonm.value invocation list;

     

       145
       +
           created_ids: (id * id) list option;

     

       146
       +
         }

     

       147
       +
       

     

       148
       +
         (** Response object as per Section 3.4 *)

     

       149
       +
         type response = {

     

       150
       +
           method_responses: Ezjsonm.value invocation list;

     

       151
       +
           created_ids: (id * id) list option;

     

       152
       +
           session_state: string;

     

       153
       +
         }

     

       154
       +
       

     

       155
       +
         (** Standard method arguments and responses *)

     

       156
       +
       

     

       157
       +
         (** Arguments for Foo/get method as per Section 5.1 *)

     

       158
       +
         type 'a get_arguments = {

     

       159
       +
           account_id: id;

     

       160
       +
           ids: id list option;

     

       161
       +
           properties: string list option;

     

       162
       +
         }

     

       163
       +
       

     

       164
       +
         (** Response for Foo/get method as per Section 5.1 *)

     

       165
       +
         type 'a get_response = {

     

       166
       +
           account_id: id;

     

       167
       +
           state: string;

     

       168
       +
           list: 'a list;

     

       169
       +
           not_found: id list;

     

       170
       +
         }

     

       171
       +
       

     

       172
       +
         (** Arguments for Foo/changes method as per Section 5.2 *)

     

       173
       +
         type changes_arguments = {

     

       174
       +
           account_id: id;

     

       175
       +
           since_state: string;

     

       176
       +
           max_changes: unsigned_int option;

     

       177
       +
         }

     

       178
       +
       

     

       179
       +
         (** Response for Foo/changes method as per Section 5.2 *)

     

       180
       +
         type changes_response = {

     

       181
       +
           account_id: id;

     

       182
       +
           old_state: string;

     

       183
       +
           new_state: string;

     

       184
       +
           has_more_changes: bool;

     

       185
       +
           created: id list;

     

       186
       +
           updated: id list;

     

       187
       +
           destroyed: id list;

     

       188
       +
         }

     

       189
       +
       

     

       190
       +
         (** Arguments for Foo/set method as per Section 5.3 *)

     

       191
       +
         type 'a set_arguments = {

     

       192
       +
           account_id: id;

     

       193
       +
           if_in_state: string option;

     

       194
       +
           create: (id * 'a) list option;

     

       195
       +
           update: (id * patch_object) list option;

     

       196
       +
           destroy: id list option;

     

       197
       +
         }

     

       198
       +
       

     

       199
       +
         (** Response for Foo/set method as per Section 5.3 *)

     

       200
       +
         type 'a set_response = {

     

       201
       +
           account_id: id;

     

       202
       +
           old_state: string option;

     

       203
       +
           new_state: string;

     

       204
       +
           created: (id * 'a) list option;

     

       205
       +
           updated: (id * 'a option) list option;

     

       206
       +
           destroyed: id list option;

     

       207
       +
           not_created: (id * set_error) list option;

     

       208
       +
           not_updated: (id * set_error) list option;

     

       209
       +
           not_destroyed: (id * set_error) list option;

     

       210
       +
         }

     

       211
       +
       

     

       212
       +
         (** Arguments for Foo/copy method as per Section 5.4 *)

     

       213
       +
         type 'a copy_arguments = {

     

       214
       +
           from_account_id: id;

     

       215
       +
           if_from_in_state: string option;

     

       216
       +
           account_id: id;

     

       217
       +
           if_in_state: string option;

     

       218
       +
           create: (id * 'a) list;

     

       219
       +
           on_success_destroy_original: bool option;

     

       220
       +
           destroy_from_if_in_state: string option;

     

       221
       +
         }

     

       222
       +
       

     

       223
       +
         (** Response for Foo/copy method as per Section 5.4 *)

     

       224
       +
         type 'a copy_response = {

     

       225
       +
           from_account_id: id;

     

       226
       +
           account_id: id;

     

       227
       +
           old_state: string option;

     

       228
       +
           new_state: string;

     

       229
       +
           created: (id * 'a) list option;

     

       230
       +
           not_created: (id * set_error) list option;

     

       231
       +
         }

     

       232
       +
       

     

       233
       +
         (** Arguments for Foo/query method as per Section 5.5 *)

     

       234
       +
         type query_arguments = {

     

       235
       +
           account_id: id;

     

       236
       +
           filter: filter option;

     

       237
       +
           sort: comparator list option;

     

       238
       +
           position: int_t option;

     

       239
       +
           anchor: id option;

     

       240
       +
           anchor_offset: int_t option;

     

       241
       +
           limit: unsigned_int option;

     

       242
       +
           calculate_total: bool option;

     

       243
       +
         }

     

       244
       +
       

     

       245
       +
         (** Response for Foo/query method as per Section 5.5 *)

     

       246
       +
         type query_response = {

     

       247
       +
           account_id: id;

     

       248
       +
           query_state: string;

     

       249
       +
           can_calculate_changes: bool;

     

       250
       +
           position: unsigned_int;

     

       251
       +
           ids: id list;

     

       252
       +
           total: unsigned_int option;

     

       253
       +
           limit: unsigned_int option;

     

       254
       +
         }

     

       255
       +
       

     

       256
       +
         (** Arguments for Foo/queryChanges method as per Section 5.6 *)

     

       257
       +
         type query_changes_arguments = {

     

       258
       +
           account_id: id;

     

       259
       +
           filter: filter option;

     

       260
       +
           sort: comparator list option;

     

       261
       +
           since_query_state: string;

     

       262
       +
           max_changes: unsigned_int option;

     

       263
       +
           up_to_id: id option;

     

       264
       +
           calculate_total: bool option;

     

       265
       +
         }

     

       266
       +
       

     

       267
       +
         (** Response for Foo/queryChanges method as per Section 5.6 *)

     

       268
       +
         type query_changes_response = {

     

       269
       +
           account_id: id;

     

       270
       +
           old_query_state: string;

     

       271
       +
           new_query_state: string;

     

       272
       +
           total: unsigned_int option;

     

       273
       +
           removed: id list;

     

       274
       +
           added: added_item list option;

     

       275
       +
         }

     

       276
       +
       

     

       277
       +
         (** Arguments for Blob/copy method as per Section 6.3 *)

     

       278
       +
         type blob_copy_arguments = {

     

       279
       +
           from_account_id: id;

     

       280
       +
           account_id: id;

     

       281
       +
           blob_ids: id list;

     

       282
       +
         }

     

       283
       +
       

     

       284
       +
         (** Response for Blob/copy method as per Section 6.3 *)

     

       285
       +
         type blob_copy_response = {

     

       286
       +
           from_account_id: id;

     

       287
       +
           account_id: id;

     

       288
       +
           copied: (id * id) list option;

     

       289
       +
           not_copied: (id * set_error) list option;

     

       290
       +
         }

     

       291
       +
       

     

       292
       +
         (** Upload response as per Section 6.1 *)

     

       293
       +
         type upload_response = {

     

       294
       +
           account_id: id;

     

       295
       +
           blob_id: id;

     

       296
       +
           type_: string;

     

       297
       +
           size: unsigned_int;

     

       298
       +
         }

     

       299
       +
       

     

       300
       +
         (** Problem details object as per RFC7807 and Section 3.6.1 *)

     

       301
       +
         type problem_details = {

     

       302
       +
           type_: string;

     

       303
       +
           status: int option;

     

       304
       +
           detail: string option;

     

       305
       +
           limit: string option; (* For "limit" error *)

     

       306
       +
         }

     

       307
       +
       end

+307

lib/jmap.mli

···

       1
       +
       (**

     

       2
       +
        * JMAP protocol implementation based on RFC8620

     

       3
       +
        * https://datatracker.ietf.org/doc/html/rfc8620

     

       4
       +
        *)

     

       5
       +
       

     

       6
       +
       module Types : sig

     

       7
       +
         (** Id string as per Section 1.2 *)

     

       8
       +
         type id = string

     

       9
       +
       

     

       10
       +
         (** Int bounded within the range -2^53+1 to 2^53-1 as per Section 1.3 *)

     

       11
       +
         type int_t = int

     

       12
       +
       

     

       13
       +
         (** UnsignedInt bounded within the range 0 to 2^53-1 as per Section 1.3 *)

     

       14
       +
         type unsigned_int = int

     

       15
       +
       

     

       16
       +
         (** Date string in RFC3339 format as per Section 1.4 *)

     

       17
       +
         type date = string

     

       18
       +
       

     

       19
       +
         (** UTCDate is a Date with 'Z' time zone as per Section 1.4 *)

     

       20
       +
         type utc_date = string

     

       21
       +
       

     

       22
       +
         (** Error object as per Section 3.6.2 *)

     

       23
       +
         type error = {

     

       24
       +
           type_: string;

     

       25
       +
           description: string option;

     

       26
       +
         }

     

       27
       +
       

     

       28
       +
         (** Set error object as per Section 5.3 *)

     

       29
       +
         type set_error = {

     

       30
       +
           type_: string;

     

       31
       +
           description: string option;

     

       32
       +
           properties: string list option;

     

       33
       +
           (* Additional properties for specific error types *)

     

       34
       +
           existing_id: id option; (* For alreadyExists error *)

     

       35
       +
         }

     

       36
       +
       

     

       37
       +
         (** Invocation object as per Section 3.2 *)

     

       38
       +
         type 'a invocation = {

     

       39
       +
           name: string;

     

       40
       +
           arguments: 'a;

     

       41
       +
           method_call_id: string;

     

       42
       +
         }

     

       43
       +
       

     

       44
       +
         (** ResultReference object as per Section 3.7 *)

     

       45
       +
         type result_reference = {

     

       46
       +
           result_of: string;

     

       47
       +
           name: string;

     

       48
       +
           path: string;

     

       49
       +
         }

     

       50
       +
       

     

       51
       +
         (** FilterOperator, FilterCondition and Filter as per Section 5.5 *)

     

       52
       +
         type filter_operator = {

     

       53
       +
           operator: string; (* "AND", "OR", "NOT" *)

     

       54
       +
           conditions: filter list;

     

       55
       +
         }

     

       56
       +
         and filter_condition = (string * Ezjsonm.value) list

     

       57
       +
         and filter = 

     

       58
       +
           | Operator of filter_operator

     

       59
       +
           | Condition of filter_condition

     

       60
       +
       

     

       61
       +
         (** Comparator object for sorting as per Section 5.5 *)

     

       62
       +
         type comparator = {

     

       63
       +
           property: string;

     

       64
       +
           is_ascending: bool option; (* Optional, defaults to true *)

     

       65
       +
           collation: string option;  (* Optional, server-dependent default *)

     

       66
       +
         }

     

       67
       +
       

     

       68
       +
         (** PatchObject as per Section 5.3 *)

     

       69
       +
         type patch_object = (string * Ezjsonm.value) list

     

       70
       +
       

     

       71
       +
         (** AddedItem structure as per Section 5.6 *)

     

       72
       +
         type added_item = {

     

       73
       +
           id: id;

     

       74
       +
           index: unsigned_int;

     

       75
       +
         }

     

       76
       +
       

     

       77
       +
         (** Account object as per Section 1.6.2 *)

     

       78
       +
         type account = {

     

       79
       +
           name: string;

     

       80
       +
           is_personal: bool;

     

       81
       +
           is_read_only: bool;

     

       82
       +
           account_capabilities: (string * Ezjsonm.value) list;

     

       83
       +
         }

     

       84
       +
       

     

       85
       +
         (** Core capability object as per Section 2 *)

     

       86
       +
         type core_capability = {

     

       87
       +
           max_size_upload: unsigned_int;

     

       88
       +
           max_concurrent_upload: unsigned_int;

     

       89
       +
           max_size_request: unsigned_int;

     

       90
       +
           max_concurrent_requests: unsigned_int;

     

       91
       +
           max_calls_in_request: unsigned_int;

     

       92
       +
           max_objects_in_get: unsigned_int;

     

       93
       +
           max_objects_in_set: unsigned_int;

     

       94
       +
           collation_algorithms: string list;

     

       95
       +
         }

     

       96
       +
       

     

       97
       +
         (** PushSubscription keys object as per Section 7.2 *)

     

       98
       +
         type push_keys = {

     

       99
       +
           p256dh: string;

     

       100
       +
           auth: string;

     

       101
       +
         }

     

       102
       +
       

     

       103
       +
         (** Session object as per Section 2 *)

     

       104
       +
         type session = {

     

       105
       +
           capabilities: (string * Ezjsonm.value) list;

     

       106
       +
           accounts: (id * account) list;

     

       107
       +
           primary_accounts: (string * id) list;

     

       108
       +
           username: string;

     

       109
       +
           api_url: string;

     

       110
       +
           download_url: string;

     

       111
       +
           upload_url: string;

     

       112
       +
           event_source_url: string option;

     

       113
       +
           state: string;

     

       114
       +
         }

     

       115
       +
       

     

       116
       +
         (** TypeState for state changes as per Section 7.1 *)

     

       117
       +
         type type_state = (string * string) list

     

       118
       +
       

     

       119
       +
         (** StateChange object as per Section 7.1 *)

     

       120
       +
         type state_change = {

     

       121
       +
           changed: (id * type_state) list;

     

       122
       +
         }

     

       123
       +
       

     

       124
       +
         (** PushVerification object as per Section 7.2.2 *)

     

       125
       +
         type push_verification = {

     

       126
       +
           push_subscription_id: id;

     

       127
       +
           verification_code: string;

     

       128
       +
         }

     

       129
       +
       

     

       130
       +
         (** PushSubscription object as per Section 7.2 *)

     

       131
       +
         type push_subscription = {

     

       132
       +
           id: id;

     

       133
       +
           device_client_id: string;

     

       134
       +
           url: string;

     

       135
       +
           keys: push_keys option;

     

       136
       +
           verification_code: string option;

     

       137
       +
           expires: utc_date option;

     

       138
       +
           types: string list option;

     

       139
       +
         }

     

       140
       +
       

     

       141
       +
         (** Request object as per Section 3.3 *)

     

       142
       +
         type request = {

     

       143
       +
           using: string list;

     

       144
       +
           method_calls: Ezjsonm.value invocation list;

     

       145
       +
           created_ids: (id * id) list option;

     

       146
       +
         }

     

       147
       +
       

     

       148
       +
         (** Response object as per Section 3.4 *)

     

       149
       +
         type response = {

     

       150
       +
           method_responses: Ezjsonm.value invocation list;

     

       151
       +
           created_ids: (id * id) list option;

     

       152
       +
           session_state: string;

     

       153
       +
         }

     

       154
       +
       

     

       155
       +
         (** Standard method arguments and responses *)

     

       156
       +
       

     

       157
       +
         (** Arguments for Foo/get method as per Section 5.1 *)

     

       158
       +
         type 'a get_arguments = {

     

       159
       +
           account_id: id;

     

       160
       +
           ids: id list option;

     

       161
       +
           properties: string list option;

     

       162
       +
         }

     

       163
       +
       

     

       164
       +
         (** Response for Foo/get method as per Section 5.1 *)

     

       165
       +
         type 'a get_response = {

     

       166
       +
           account_id: id;

     

       167
       +
           state: string;

     

       168
       +
           list: 'a list;

     

       169
       +
           not_found: id list;

     

       170
       +
         }

     

       171
       +
       

     

       172
       +
         (** Arguments for Foo/changes method as per Section 5.2 *)

     

       173
       +
         type changes_arguments = {

     

       174
       +
           account_id: id;

     

       175
       +
           since_state: string;

     

       176
       +
           max_changes: unsigned_int option;

     

       177
       +
         }

     

       178
       +
       

     

       179
       +
         (** Response for Foo/changes method as per Section 5.2 *)

     

       180
       +
         type changes_response = {

     

       181
       +
           account_id: id;

     

       182
       +
           old_state: string;

     

       183
       +
           new_state: string;

     

       184
       +
           has_more_changes: bool;

     

       185
       +
           created: id list;

     

       186
       +
           updated: id list;

     

       187
       +
           destroyed: id list;

     

       188
       +
         }

     

       189
       +
       

     

       190
       +
         (** Arguments for Foo/set method as per Section 5.3 *)

     

       191
       +
         type 'a set_arguments = {

     

       192
       +
           account_id: id;

     

       193
       +
           if_in_state: string option;

     

       194
       +
           create: (id * 'a) list option;

     

       195
       +
           update: (id * patch_object) list option;

     

       196
       +
           destroy: id list option;

     

       197
       +
         }

     

       198
       +
       

     

       199
       +
         (** Response for Foo/set method as per Section 5.3 *)

     

       200
       +
         type 'a set_response = {

     

       201
       +
           account_id: id;

     

       202
       +
           old_state: string option;

     

       203
       +
           new_state: string;

     

       204
       +
           created: (id * 'a) list option;

     

       205
       +
           updated: (id * 'a option) list option;

     

       206
       +
           destroyed: id list option;

     

       207
       +
           not_created: (id * set_error) list option;

     

       208
       +
           not_updated: (id * set_error) list option;

     

       209
       +
           not_destroyed: (id * set_error) list option;

     

       210
       +
         }

     

       211
       +
       

     

       212
       +
         (** Arguments for Foo/copy method as per Section 5.4 *)

     

       213
       +
         type 'a copy_arguments = {

     

       214
       +
           from_account_id: id;

     

       215
       +
           if_from_in_state: string option;

     

       216
       +
           account_id: id;

     

       217
       +
           if_in_state: string option;

     

       218
       +
           create: (id * 'a) list;

     

       219
       +
           on_success_destroy_original: bool option;

     

       220
       +
           destroy_from_if_in_state: string option;

     

       221
       +
         }

     

       222
       +
       

     

       223
       +
         (** Response for Foo/copy method as per Section 5.4 *)

     

       224
       +
         type 'a copy_response = {

     

       225
       +
           from_account_id: id;

     

       226
       +
           account_id: id;

     

       227
       +
           old_state: string option;

     

       228
       +
           new_state: string;

     

       229
       +
           created: (id * 'a) list option;

     

       230
       +
           not_created: (id * set_error) list option;

     

       231
       +
         }

     

       232
       +
       

     

       233
       +
         (** Arguments for Foo/query method as per Section 5.5 *)

     

       234
       +
         type query_arguments = {

     

       235
       +
           account_id: id;

     

       236
       +
           filter: filter option;

     

       237
       +
           sort: comparator list option;

     

       238
       +
           position: int_t option;

     

       239
       +
           anchor: id option;

     

       240
       +
           anchor_offset: int_t option;

     

       241
       +
           limit: unsigned_int option;

     

       242
       +
           calculate_total: bool option;

     

       243
       +
         }

     

       244
       +
       

     

       245
       +
         (** Response for Foo/query method as per Section 5.5 *)

     

       246
       +
         type query_response = {

     

       247
       +
           account_id: id;

     

       248
       +
           query_state: string;

     

       249
       +
           can_calculate_changes: bool;

     

       250
       +
           position: unsigned_int;

     

       251
       +
           ids: id list;

     

       252
       +
           total: unsigned_int option;

     

       253
       +
           limit: unsigned_int option;

     

       254
       +
         }

     

       255
       +
       

     

       256
       +
         (** Arguments for Foo/queryChanges method as per Section 5.6 *)

     

       257
       +
         type query_changes_arguments = {

     

       258
       +
           account_id: id;

     

       259
       +
           filter: filter option;

     

       260
       +
           sort: comparator list option;

     

       261
       +
           since_query_state: string;

     

       262
       +
           max_changes: unsigned_int option;

     

       263
       +
           up_to_id: id option;

     

       264
       +
           calculate_total: bool option;

     

       265
       +
         }

     

       266
       +
       

     

       267
       +
         (** Response for Foo/queryChanges method as per Section 5.6 *)

     

       268
       +
         type query_changes_response = {

     

       269
       +
           account_id: id;

     

       270
       +
           old_query_state: string;

     

       271
       +
           new_query_state: string;

     

       272
       +
           total: unsigned_int option;

     

       273
       +
           removed: id list;

     

       274
       +
           added: added_item list option;

     

       275
       +
         }

     

       276
       +
       

     

       277
       +
         (** Arguments for Blob/copy method as per Section 6.3 *)

     

       278
       +
         type blob_copy_arguments = {

     

       279
       +
           from_account_id: id;

     

       280
       +
           account_id: id;

     

       281
       +
           blob_ids: id list;

     

       282
       +
         }

     

       283
       +
       

     

       284
       +
         (** Response for Blob/copy method as per Section 6.3 *)

     

       285
       +
         type blob_copy_response = {

     

       286
       +
           from_account_id: id;

     

       287
       +
           account_id: id;

     

       288
       +
           copied: (id * id) list option;

     

       289
       +
           not_copied: (id * set_error) list option;

     

       290
       +
         }

     

       291
       +
       

     

       292
       +
         (** Upload response as per Section 6.1 *)

     

       293
       +
         type upload_response = {

     

       294
       +
           account_id: id;

     

       295
       +
           blob_id: id;

     

       296
       +
           type_: string;

     

       297
       +
           size: unsigned_int;

     

       298
       +
         }

     

       299
       +
       

     

       300
       +
         (** Problem details object as per RFC7807 and Section 3.6.1 *)

     

       301
       +
         type problem_details = {

     

       302
       +
           type_: string;

     

       303
       +
           status: int option;

     

       304
       +
           detail: string option;

     

       305
       +
           limit: string option; (* For "limit" error *)

     

       306
       +
         }

     

       307
       +
       end