Method: SyncClient#create_sync

Defined in:
lib/lockstep_sdk/clients/sync_client.rb

#create_sync(body:) ⇒ Object

Requests a new Sync task from the Application specified in the request and returns a token that can be used to check the progress and status of the task.

A Sync task represents an action performed by an Application for a particular account. An Application can provide many different tasks as part of their capabilities. Sync tasks are executed in the background and will continue running after they are created. Use one of the creation APIs to request execution of a task. To check on the progress of the task, call GetSync or QuerySync.

Parameters:

  • body (SyncSubmitModel) —

    Information about the Sync to execute



33
34
35
36
 
# File 'lib/lockstep_sdk/clients/sync_client.rb', line 33

def create_sync(body:)
    path = "/api/v1/Sync"
    @connection.request(:post, path, body, nil)
end