Expand description
Types used as operation parameters and responses.
Modules§
- builder
- Types for composing complex structures.
- defaults
- Generation of default values for serde.
- error
- Error types.
Structs§
- ApiToken
- An ApiToken is a unique identifier that you can use to authenticate requests to the API. You can create as many ApiTokens as you need.
- ApiToken
Create Input ApiTokenCreateInput- Cache
Rule - A CacheRule is a rule that overrides the default cache settings.
- Cache
Rule Conditions CacheRuleConditions- Component
- A component is a reusable piece of code that can be used in multiple projects.
- Component
Create Input ComponentCreateInput- Component
List Params ComponentListParams- Component
Update Params ComponentUpdateParams- Component
Version - Version of a component
- Component
Version Create Input ComponentVersionCreateInput- Component
Version Update Input ComponentVersionUpdateInput- Configuration
Field ConfigurationField- Deleted
Response DeletedResponse- Domain
- A Domain is a hostname that you can use to access your project. Each domain belongs to a project.
- Domain
Create Input DomainCreateInput- Domain
Update Input DomainUpdateInput- Error
Response - An error response from the API. More info here
- Error
Response Error ErrorResponseError- Error
Response Error Params Item ErrorResponseErrorParamsItem- GetIncoming
Data Collection Events Response GetIncomingDataCollectionEventsResponse- GetOutgoing
Data Collection Events Response GetOutgoingDataCollectionEventsResponse- Incoming
Data Collection Event - An incoming data collection event is an event created by edgee, which will be processed and transformed into one or more outgoing data collection events by the components.
- Invitation
- An invitation is a request to join an organization. An invitation is sent to an email address, and the recipient can accept or decline the invitation.
- Invitation
Create Input InvitationCreateInput- KeyValue
Conditions KeyValueConditions- List
ApiTokens Response ListApiTokensResponse- List
Invitations Response ListInvitationsResponse- List
Organization Components Response ListOrganizationComponentsResponse- List
Organizations Response ListOrganizationsResponse- List
Organizations Users Response ListOrganizationsUsersResponse- List
Params ListParams- List
Project Components Response ListProjectComponentsResponse- List
Project Domains Response ListProjectDomainsResponse- List
Project Proxy Settings Response ListProjectProxySettingsResponse- List
Projects Response ListProjectsResponse- List
Public Components Response ListPublicComponentsResponse- List
Response ListResponse- Organization
Organization- Organization
Create Input OrganizationCreateInput- Organization
Update Input OrganizationUpdateInput- Organization
User OrganizationUser- Organization
User Update Input OrganizationUserUpdateInput- Outgoing
Data Collection Event - An outgoing data collection event is an event created by a component, which will be sent to the destination specified by the component.
- Project
Project- Project
Autocapture - Configuration for automatic event capture by the Edgee SDK.
- Project
Base - A Project is a unique identifier that you can use to manage and organize your work. Each project belongs to an organization.
- Project
Base Without OrgId - A Project is a unique identifier that you can use to manage and organize your work. Each project belongs to an organization.
- Project
Component - A Project Component object represents an integration of a component in a project.
- Project
Component Counters - A Project Counters object represents the counters of a project.
- Project
Counters - A Project Counters object represents the statistics of a project.
- Project
Create Input ProjectCreateInput- Project
Forwarded Headers Item ProjectForwardedHeadersItem- Project
Full - A Project is a unique identifier that you can use to manage and organize your work. Each project belongs to an organization.
- Project
Full Autocapture - Configuration for automatic event capture by the Edgee SDK.
- Project
Full Forwarded Headers Item ProjectFullForwardedHeadersItem- Project
Update Input ProjectUpdateInput- Project
Update Input Autocapture - Configuration for automatic event capture by the Edgee SDK.
- Project
Update Input Forwarded Headers Item ProjectUpdateInputForwardedHeadersItem- Proxy
Settings - A ProxySettings is a revision of the proxy settings of a project.
- Proxy
Settings Backend - A ProxySettings backend entity
- Proxy
Settings Create Input ProxySettingsCreateInput- Proxy
Settings Route - A ProxySettings route entity
- Proxy
Settings Update Input ProxySettingsUpdateInput- Purge
Cache Input - Input parameters for purging cache
- Purge
Project Cache Response PurgeProjectCacheResponse- Rate
Limiting Rule - A RateLimitingRule defines a rate limiting rule for the project.
- Rate
Limiting Rule Conditions - Conditions that must be met for this rule to apply.
- Rate
Limiting Rule Conditions Country Item RateLimitingRuleConditionsCountryItem- Upload
Presign UploadPresign- User
- A User is a unique identifier that you can use to manage and organize your work.
- User
Base - A User is a unique identifier that you can use to manage and organize your work.
- User
Update Input UserUpdateInput- User
With Roles UserWithRoles
Enums§
- Component
Create Input Category - Category of the component.
- Component
Create Input Subcategory - Subcategory of the component.
- Component
List Params Category - Filter components by category.
- Component
List Params Subcategory - Filter components by sub category.
- Configuration
Field Type - The type of the configuration field.
- Error
Response Error Type - The type of error returned.
- GetIncoming
Data Collection Events Order Direction - The order direction of the returned list. Objects are returned sorted by creation date. By default, the order is descending, so the most recent object appears first. Possible values are ASC and DESC. Default is DESC.
- GetOutgoing
Data Collection Events Order Direction - The order direction of the returned list. Objects are returned sorted by creation date. By default, the order is descending, so the most recent object appears first. Possible values are ASC and DESC. Default is DESC.
- Incoming
Data Collection Event From - Origin of the event
- Incoming
Data Collection Event Type - Type of the event
- Invitation
Create Input Role - The future role of the user in the organization.
- Invitation
Role - The future role of the user in the organization.
- List
ApiTokens Order Direction - The order direction of the returned list. Objects are returned sorted by creation date. By default, the order is descending, so the most recent object appears first. Possible values are ASC and DESC. Default is DESC.
- List
ApiTokens Response Order Direction - The order direction of the returned list. Objects are returned sorted by creation date. By default, the order is descending, so the most recent object appears first. Possible values are ASC and DESC. Default is DESC.
- List
Invitations Order Direction - The order direction of the returned list. Objects are returned sorted by creation date. By default, the order is descending, so the most recent object appears first. Possible values are ASC and DESC. Default is DESC.
- List
Organization Components Category - Filter components by category.
- List
Organization Components Subcategory - Filter components by sub category.
- List
Organizations Order Direction - The order direction of the returned list. Objects are returned sorted by creation date. By default, the order is descending, so the most recent object appears first. Possible values are ASC and DESC. Default is DESC.
- List
Organizations Users Order Direction - The order direction of the returned list. Objects are returned sorted by creation date. By default, the order is descending, so the most recent object appears first. Possible values are ASC and DESC. Default is DESC.
- List
Organizations Users Role - The role of the users.
- List
Params Order Direction - The order direction of the returned list. Objects are returned sorted by creation date. By default, the order is descending, so the most recent object appears first. Possible values are ASC and DESC. Default is DESC.
- List
Project Components Category - Filter components by category.
- List
Project Components Subcategory - Filter components by sub category.
- List
Projects Order Direction - The order direction of the returned list. Objects are returned sorted by creation date. By default, the order is descending, so the most recent object appears first. Possible values are ASC and DESC. Default is DESC.
- List
Public Components Category - Filter components by category.
- List
Public Components Subcategory - Filter components by sub category.
- Organization
Type - The type of the organization.
- Organization
User Role OrganizationUserRole- Organization
User Update Input Role OrganizationUserUpdateInputRole- Project
Full Inject SdkPosition - The position of the SDK injection.
- Project
Full LogSeverity - The log severity of the project.
- Project
Inject SdkPosition - The position of the SDK injection.
- Project
LogSeverity - The log severity of the project.
- Project
Update Input Inject SdkPosition - The position of the SDK injection.
- Project
Update Input LogSeverity - The log severity of the project.
- Rate
Limiting Rule Conditions Continent Item RateLimitingRuleConditionsContinentItem- Rate
Limiting Rule Conditions Method Item RateLimitingRuleConditionsMethodItem- Rate
Limiting Rule KeyItem RateLimitingRuleKeyItem- Rate
Limiting Rule Window - Rate window for counting requests.
- User
With Roles Roles Value - The role of the user in each organization.