Documentation
Interface: Branch
Description: Represents a branch within a repository.
Fields
Field: name
Description: The name of the branch.
Type:
string:
Field: label
Description: An optional label for the branch.
Type:
string:
Field: [key: string]: any
Description: Allows for additional, custom properties to be added to the branch object.
Type:
any:
Interface: Repository
Description: Represents a repository, containing metadata and information about its branches.
Fields
Field: id
Description: The unique identifier of the repository.
Type:
string:
Field: repo_id
Description: The ID of the repository in its source provider.
Type:
number:
Field: enabled
Description: Indicates whether the repository is enabled.
Type:
boolean:
Field: link
Description: The URL to the repository in its source provider.
Type:
string:
Field: name
Description: The name of the repository.
Type:
string:
Field: owner
Description: The owner of the repository.
Type:
string:
Field: provider
Description: The source provider of the repository (e.g., GitHub, GitLab).
Type:
string:
Field: mode
Description: The repository's mode (e.g., public, private).
Type:
number:
Field: channel
Description: The channel associated with the repository.
Type:
number:
Field: branch_default
Description: Indicates whether the repository has a default branch.
Type:
boolean:
Field: min_loc
Description: The minimum number of lines of code required for a commit to be processed.
Type:
number:
Field: created_at
Description: The date and time when the repository was created.
Type:
Date:
Field: overwrite
Description: Indicates whether the repository allows overwriting existing files.
Type:
boolean:
Field: trigger
Description: The trigger mechanism for the repository.
Type:
number:
Field: plan_id
Description: The ID of the plan associated with the repository.
Type:
number:
Optional: true
Field: branches
Description: An array of branches associated with the repository.
Type:
Branch[]:
Optional: true
Field: branch
Description: The default branch of the repository.
Type:
Branch:
Optional: true
Field: default_branch
Description: The name of the default branch.
Type:
string:
Optional: true
Interface: RepositoryResponse
Description: Represents a response containing multiple repositories and a total count.
Fields
Field: items
Description: An array of repositories, or null if no repositories were found.
Type:
Repository[] | null:
Field: total
Description: The total number of repositories matching the query.
Type:
number | 0:
Interface: Schedule
Description: Defines a schedule for triggering actions.
Fields
Field: time
Description: The specific time of day for the schedule.
Type:
string:
Field: weekday
Description: The day of the week for the schedule.
Type:
string:
Field: frequency
Description: The frequency of the schedule.
Type:
string: