View Source StarkInfra (starkinfra v0.0.1)
SDK to facilitate Elixir integrations with the Stark Infra API v2.
Link to this section Summary
Functions
The Organization struct is an authentication entity for the SDK that represents your entire Organization, being able to access any Workspace underneath it and even create new Workspaces. Only a legal representative of your organization can register or change the Organization credentials. All requests to the Stark Infra API must be authenticated via an SDK user, which must have been previously created at the Stark Infra website [https://web.sandbox.starkinfra.com] or [https://web.starkinfra.com] before you can use it in this SDK. Organizations may be passed as the user parameter on each request or may be defined as the default user at the start (See README). If you are accessing a specific Workspace using Organization credentials, you should specify the workspace ID when building the Organization struct or by request, using the Organization.replace(organization, workspace_id) method, which creates a copy of the organization struct with the altered workspace ID. If you are listing or creating new Workspaces, the workspace_id should be nil.
The Project struct is an authentication entity for the SDK that is permanently linked to a specific Workspace. All requests to the Stark Infra API must be authenticated via an SDK user, which must have been previously created at the Stark Infra website [https://web.sandbox.starkinfra.com] or [https://web.starkinfra.com] before you can use it in this SDK. Projects may be passed as the user parameter on each request or may be defined as the default user at the start (See README).
Link to this section Functions
@spec organization( environment: :production | :sandbox, id: binary(), private_key: binary(), workspace_id: binary() | nil ) :: StarkInfra.Organization.t()
The Organization struct is an authentication entity for the SDK that represents your entire Organization, being able to access any Workspace underneath it and even create new Workspaces. Only a legal representative of your organization can register or change the Organization credentials. All requests to the Stark Infra API must be authenticated via an SDK user, which must have been previously created at the Stark Infra website [https://web.sandbox.starkinfra.com] or [https://web.starkinfra.com] before you can use it in this SDK. Organizations may be passed as the user parameter on each request or may be defined as the default user at the start (See README). If you are accessing a specific Workspace using Organization credentials, you should specify the workspace ID when building the Organization struct or by request, using the Organization.replace(organization, workspace_id) method, which creates a copy of the organization struct with the altered workspace ID. If you are listing or creating new Workspaces, the workspace_id should be nil.
parameters-required
Parameters (required):
- `:environment` [string]: environment where the organization is being used. ex: "sandbox" or "production"
- `:id` [string]: unique id required to identify organization. ex: "5656565656565656"
- `:private_key` [EllipticCurve.Organization()]: PEM string of the private key linked to the organization. ex: "-----BEGIN PUBLIC KEY-----
MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEyTIHK6jYuik6ktM9FIF3yCEYzpLjO5X/ tqDioGM+R2RyW0QEo+1DG8BrUf4UXHSvCjtQ0yLppygz23z0yPZYfw== -----END PUBLIC KEY-----"
parameters-optional
Parameters (optional):
- `:workspace_id` [string]: unique id of the accessed Workspace, if any. ex: nil or "4848484848484848"
@spec project( environment: :production | :sandbox, id: binary(), private_key: binary() ) :: StarkInfra.Project.t()
The Project struct is an authentication entity for the SDK that is permanently linked to a specific Workspace. All requests to the Stark Infra API must be authenticated via an SDK user, which must have been previously created at the Stark Infra website [https://web.sandbox.starkinfra.com] or [https://web.starkinfra.com] before you can use it in this SDK. Projects may be passed as the user parameter on each request or may be defined as the default user at the start (See README).
parameters-required
Parameters (required):
- `:environment` [string]: environment where the project is being used. ex: "sandbox" or "production"
- `:id` [string]: unique id required to identify project. ex: "5656565656565656"
- `:private_key` [string]: PEM string of the private key linked to the project. ex: "-----BEGIN PUBLIC KEY-----
MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEyTIHK6jYuik6ktM9FIF3yCEYzpLjO5X/ tqDioGM+R2RyW0QEo+1DG8BrUf4UXHSvCjtQ0yLppygz23z0yPZYfw== -----END PUBLIC KEY-----"