@sftpsync-api/api-client NPM

@sftpsync-api/api-client@0.0.1

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

Node.js
Webpack
Browserify

Language level

ES5 - you must have a Promises/A+ library installed
ES6

Module system

CommonJS
ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @sftpsync-api/api-client@0.0.1 --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AuthApi	authControllerChangePassword	POST /auth/change-password	Change user password
AuthApi	authControllerLogin	POST /auth/login	User login
AuthApi	authControllerRegister	POST /auth/register	Register a new workspace with admin user
AwsApi	awsControllerCreateBucket	POST /aws/s3/bucket	Create a new S3 bucket
AwsApi	awsControllerCreateSftpServer	POST /aws/sftp/server	Create a new SFTP server
AwsApi	awsControllerDeleteFile	DELETE /aws/s3/bucket/{bucketName}/file/{key}	Delete a file from an S3 bucket
AwsApi	awsControllerDeleteSftpServer	DELETE /aws/sftp/server/{serverId}	Delete an SFTP server
AwsApi	awsControllerDeleteSftpUser	DELETE /aws/sftp/server/{serverId}/user/{username}	Delete an SFTP user
AwsApi	awsControllerGetSftpCredentials	GET /aws/sftp/server/{serverId}/user/{username}/credentials	Get SFTP credentials for a user
AwsApi	awsControllerGetSftpServer	GET /aws/sftp/server/{serverId}	Get SFTP server details
AwsApi	awsControllerGetSignedUrl	GET /aws/s3/bucket/{bucketName}/file/{key}/url	Get a pre-signed URL for a file
AwsApi	awsControllerListBuckets	GET /aws/s3/buckets	List all S3 buckets
AwsApi	awsControllerListFiles	GET /aws/s3/bucket/{bucketName}/files	List files in an S3 bucket
AwsApi	awsControllerListSftpServers	GET /aws/sftp/servers	List all SFTP servers
AwsApi	awsControllerListSftpUsers	GET /aws/sftp/server/{serverId}/users	List users for an SFTP server
AwsApi	awsControllerStartSftpServer	POST /aws/sftp/server/{serverId}/start	Start an SFTP server
AwsApi	awsControllerStopSftpServer	POST /aws/sftp/server/{serverId}/stop	Stop an SFTP server
ClientsApi	clientsControllerCreate	POST /clients	Create a new SFTP client
ClientsApi	clientsControllerFindAll	GET /clients	Get all SFTP clients
ClientsApi	clientsControllerFindOne	GET /clients/{id}	Get an SFTP client by ID
ClientsApi	clientsControllerRemove	DELETE /clients/{id}	Delete an SFTP client
ClientsApi	clientsControllerTestConnection	POST /clients/{id}/test-connection	Test connection to an SFTP client
ClientsApi	clientsControllerUpdate	PATCH /clients/{id}	Update an SFTP client
FilesApi	filesControllerGetFile	GET /files/json	Retrieve a processed JSON file from S3 (protected with user API key)
FilesApi	filesControllerProcessFile	POST /files/process	Process a file from S3 (protected with API key)
HealthApi	healthControllerCheck	GET /health	Health check endpoint
InvoicesApi	invoicesControllerGetInvoice	GET /invoices/{id}
InvoicesApi	invoicesControllerGetInvoices	GET /invoices
InvoicesApi	invoicesControllerSyncInvoices	POST /invoices/sync
PipelineRunsApi	pipelineRunsControllerFindAll	GET /pipeline-runs	List pipeline runs with pagination
PipelineRunsApi	pipelineRunsControllerFindAll_0	GET /pipeline-runs	List pipeline runs with pagination
PipelineRunsApi	pipelineRunsControllerFindOne	GET /pipeline-runs/{id}	Get a pipeline run by ID
PipelineRunsApi	pipelineRunsControllerFindOne_0	GET /pipeline-runs/{id}	Get a pipeline run by ID
PipelinesApi	pipelinesControllerCreate	POST /pipelines	Create a new pipeline
PipelinesApi	pipelinesControllerFindAll	GET /pipelines	Get all pipelines
PipelinesApi	pipelinesControllerFindOne	GET /pipelines/{id}	Get a pipeline by ID
PipelinesApi	pipelinesControllerProcessPipeline	POST /pipelines/{id}/process/{fileId}	Process a file through a pipeline
PipelinesApi	pipelinesControllerRemove	DELETE /pipelines/{id}	Delete a pipeline
PipelinesApi	pipelinesControllerToggleActive	PATCH /pipelines/{id}/toggle-active	Toggle pipeline active status
PipelinesApi	pipelinesControllerUpdate	PATCH /pipelines/{id}	Update a pipeline
SchemasApi	schemasControllerCreate	POST /schemas	Create a new schema
SchemasApi	schemasControllerFindAll	GET /schemas	Get all schemas
SchemasApi	schemasControllerFindOne	GET /schemas/{id}	Get a schema by ID
SchemasApi	schemasControllerRemove	DELETE /schemas/{id}	Delete a schema
SchemasApi	schemasControllerUpdate	PATCH /schemas/{id}	Update a schema
SchemasApi	schemasControllerValidateData	POST /schemas/{id}/validate	Validate data against a schema
StripeWebhookApi	stripeWebhookControllerHandleWebhook	POST /stripe-webhook
SubscriptionPlansApi	subscriptionPlansControllerCreate	POST /subscription-plans
SubscriptionPlansApi	subscriptionPlansControllerFindAll	GET /subscription-plans
SubscriptionPlansApi	subscriptionPlansControllerFindOne	GET /subscription-plans/{id}
SubscriptionPlansApi	subscriptionPlansControllerRemove	DELETE /subscription-plans/{id}
SubscriptionPlansApi	subscriptionPlansControllerUpdate	PATCH /subscription-plans/{id}
SubscriptionsApi	subscriptionsControllerCancelSubscription	POST /subscriptions/cancel
SubscriptionsApi	subscriptionsControllerCreateCheckoutSession	POST /subscriptions/checkout
SubscriptionsApi	subscriptionsControllerCreateSubscription	POST /subscriptions
SubscriptionsApi	subscriptionsControllerGetSubscription	GET /subscriptions
SubscriptionsApi	subscriptionsControllerGetUsageStats	GET /subscriptions/usage
SubscriptionsApi	subscriptionsControllerUpdateSubscription	PATCH /subscriptions
UsersApi	usersControllerCreate	POST /users	Create a new user
UsersApi	usersControllerFindAll	GET /users	Get all users
UsersApi	usersControllerFindOne	GET /users/{id}	Get a user by ID
UsersApi	usersControllerRemove	DELETE /users/{id}	Delete a user
UsersApi	usersControllerUpdate	PATCH /users/{id}	Update a user
WebhooksApi	webhooksControllerCreate	POST /webhooks	Create a new webhook
WebhooksApi	webhooksControllerFindAll	GET /webhooks	Get all webhooks
WebhooksApi	webhooksControllerFindOne	GET /webhooks/{id}	Get a webhook by ID
WebhooksApi	webhooksControllerGetDeliveries	GET /webhooks/deliveries	List webhook deliveries with pagination
WebhooksApi	webhooksControllerReceiveTest	POST /webhooks/receive-test	Receive a test webhook payload for internal testing
WebhooksApi	webhooksControllerRemove	DELETE /webhooks/{id}	Delete a webhook
WebhooksApi	webhooksControllerTriggerTest	POST /webhooks/trigger-test	Trigger a test webhook event
WebhooksApi	webhooksControllerUpdate	PATCH /webhooks/{id}	Update a webhook
WorkspacesApi	workspacesControllerCreate	POST /workspaces	Create a new workspace
WorkspacesApi	workspacesControllerFindAll	GET /workspaces	Get all workspaces
WorkspacesApi	workspacesControllerFindOne	GET /workspaces/{id}	Get a workspace by ID

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearer

Type: Bearer authentication (JWT)

api-key

Type: API key
API key parameter name: x-api-key
Location: HTTP header

tenant

Type: API key
API key parameter name: x-tenant
Location: HTTP header

axios typescript openapi-client openapi-generator @sftpsync-api/api-client

axios

0.0.1

2 months ago