@integrationos/cli

IntegrationOS

Build performant, high-converting native integrations with a few lines of code. By unlocking more integrations, you can onboard more customers and expand app usage, overnight.

• IntegrationOS
  • Installation
  • Docker Setup
    • Commands
      • Start
        • Available Flags
      • Stop
  • Initialization
    • Available Flags
  • Supported Operations
  • Commands
    • Common Enums
      • List
      • Add
        • Available Flags
      • Pull
        • Available Flags
      • Push
        • Available Flags
      • Delete
        • Available Flags
    • Common Models
      • List
      • Add
        • Available Flags
      • Pull
        • Available Flags
      • Push
        • Available Flags
      • Delete
        • Available Flags
    • Platforms
      • List
      • Add
        • Available Flags
      • Add Model
        • Available Flags
      • Add OAuth
        • Available Flags
      • Pull
        • Available Flags
      • Push
        • Available Flags
      • Delete
        • Available Flags

Installation

npm install cios

Docker Setup

Commands

Start

To start the docker containers.

cios start

Available Flags

Flag	Description	Required
--kmsKeyId	The KMS Key ID.	Yes.
--kmsKeyRingId	The KMS Key Ring ID.	Yes.
--gcpLocationId	The GCP Location ID.	Yes.
--gcpProjectId	The GCP Project ID.	Yes.
--home	The GCP Configuration Global Path.	Yes.
--seed	Whether to seed the Database.	No.

Examples

# To start the docker containers
cios start --kmsKeyId random-key-id --kmsKeyRingId random-kms-key-ring-id --gcpLocationId global --gcpProjectId random-gcp-project-id --home /home/gcp_config

Stop

To stop the docker containers.

cios stop

Initialization

To generate the configuration file.

cios init

Available Flags

Flag	Description	Required
--mongoPassword	The Mongo Password.	No.
--buildableSecret	The Buildable Secret.	No.
--defaultLiveAccessKey	The Default Live Access Key.	No.
--defaultTestAccessKey	The Default Test Access Key.	No.
--developerAccountAccessKey	The Developer Account Access Key.	No.
--developerAccountId	The Developer Account ID.	No.
--eventAccessPassword	The Event Access Password.	No.
--jwtSecret	The JWT Secret.	No.
--gatewaySecret	The Gateway Secret.	No.
--apiUrl	The API URL.	No.
--xIosSecret	The X-IOS Secret.	No.
--bearerToken	The Bearer Token.	No.

Examples

# To generate the configuration file
cios init --mongoPassword mongo-password --buildableSecret buildable-secret --defaultLiveAccessKey default-live-access-key --defaultTestAccessKey default-test-access-key --developerAccountAccessKey developer-account-access-key --developerAccountId developer-account-id --eventAccessPassword event-access-password --jwtSecret jwt-secret --gatewaySecret gateway-secret --apiUrl api-url --xIosSecret x-ios-secret --bearerToken bearer-token

Supported Operations

Entity	Operations	Extra Operations
List	Add	Push	Pull	Delete
All	Specific	All	Specific	All	Specific
Common Enums	✓	X	✓	✓	✓	✓	X	X	X
Common Models	✓	✓	✓	✓	✓	✓	X	✓	X
Platforms	✓	✓	✓	✓	✓	✓	X	✓	Add Model	Add Oauth

Commands

The following commands are available to work with Common Models, Common Enums or Platforms.

Common Enums

Perform operations on common enums.

List

List common enum(s) available in the database.

cios listCommonEnum

Add

Add common enum(s) to the repository.

cios addCommonEnum

Available Flags

Flag	Description	Required
--enums	Names of the enum(s) to be added.	Yes.

Examples

# To add specific enums
cios addCommonModel --enums UserType MessageStatus

Pull

Pull common enum(s) from the database to the repository.

cios pullCommonEnum

Available Flags

Flag	Description	Required
--all	To pull all common enums available.	Yes, if --enums is not provided.
--enums	Names of the common enum(s) to be pulled.	Yes, if --all is not provided.

Examples

# To pull all enums 
cios pullCommonEnum --all

# To pull specific enums
cios pullCommonEnum --enums AddressType SocialProfileType

Push

Push common enum(s) from the repository to the database.

cios pushCommonEnum

Available Flags

Flag	Description	Required
--all	To push all common enums available.	Yes, if --enums is not provided.
--enums	Names of the enum(s) to be pushed.	Yes, if --all is not provided.

Examples

# To push all enums 
cios pushCommonEnum --all

# To push specific enums
cios pushCommonEnum --enums EventRuleType TimeCycle

Delete

Delete common enum(s) from the repository and the database.

cios deleteCommonEnum

Available Flags

Flag	Description	Required
--enums	Names of the enum(s) to be deleted.	Yes.

Examples

# To delete specific enums
cios deleteCommonEnum --enums UserStatus TaxType

Common Models

Perform operations on common models.

List

List common model(s) available in the database.

cios listCommonModel

Add

Add common model(s) to the repository.

cios addCommonModel

Available Flags

Flag	Description	Required
--models	Names of the model(s) to be added.	Yes.

Examples

# To add specific models
cios addCommonModel --models Contacts Deals

Pull

Pull common model(s) from the database to the repository.

cios pullCommonModel

Available Flags

Flag	Description	Required
--all	To pull all common models available.	Yes, if --models is not provided.
--models	Names of the model(s) to be pulled.	Yes, if --all is not provided.

Examples

# To pull all models 
cios pullCommonModel --all

# To pull specific models
cios pullCommonModel --models Customers Webhooks

Push

Push common model(s) from the repository to the database.

cios pushCommonModel

Available Flags

Flag	Description	Required
--all	To push all common models available.	Yes, if --models is not provided.
--models	Names of the model(s) to be pushed.	Yes, if --all is not provided.

Examples

# To push all models 
cios pushCommonModel --all

# To push specific models
cios pushCommonModel --models Customers Webhooks

Delete

Delete common model(s) from the repository and the database.

cios deleteCommonModel

Available Flags

Flag	Description	Required
--models	Names of the model(s) to be deleted.	Yes.

Examples

# To delete specific models
cios deleteCommonModel --models Leads Opportunities

Platforms

Perform operations on platforms.

List

List platform(s) available in the database.

cios listPlatform

Add

Add platform to the repository.

cios addPlatform

Available Flags

Flag	Description	Required
--platform	Name of the platform.	Yes.
--auth	Authentication type, possible options are: oauth or bearer.	Yes.
--models	Names of the model(s) to be added to the platform.	Yes.

Examples

# To add a platform
cios addPlatform --platform zenMail --auth oauth --models Addresses Discounts

Pull

Pull platform(s) from the database to the repository.

cios pullPlatform

Available Flags

Flag	Description	Required
--all	To pull all platforms available.	Yes, if --platforms is not provided.
--platforms	Names of the platform(s) to be pulled.	Yes, if --all is not provided.

Examples

# To pull all platforms
cios pullPlatform --all

# To pull specific platform
cios pullPlatform --platforms faceGram instaBook

Push

Push platform(s) from the repository to the database.

cios pushPlatform

Available Flags

Flag	Description	Required
--all	To push all platforms available.	Yes, if --platforms is not provided.
--platforms	Names of the platform(s) to be pushed.	Yes, if --all is not provided.

Examples

# To push all platforms 
cios pushPlatform --all

# To push specific platforms
cios pushPlatform --platforms shopCommerce bigify

Add Model

Add model(s) to the platform.

cios addPlatformModel

Available Flags

Flag	Description	Required
--platform	Name of the platform.	Yes.
--models	Name of the models to be added.	Yes.

Examples

# To add models to a platform
cios addPlatformModel --platform bananaShake --models Accounts Users

Add OAuth

Add oauth configuration for a platform.

cios addPlatformOAuth

Available Flags

Flag	Description	Required
--platform	Name of the platform.	Yes.

Examples

# To add oauth for a platform
cios addPlatformOAuth --platform boogle

Delete

Delete platform(s) from the repository and the database.

cios deletePlatform

Available Flags

Flag	Description	Required
--platforms	Names of the platform(s) to be deleted.	Yes.

Examples

# To delete specific platforms
cios deletePlatforms --platforms bwitter orange