Bitrise

0.0.3

An easy to use command-line tool for interacting with the Bitrise API
csjones/bitrise-cli

What's New

0.0.3

2020-12-28T21:24:14Z

Bitrise

This is an api generated from a OpenAPI 3.0 spec with SwagGen

Operation

Each operation lives under the Bitrise namespace and within an optional tag: Bitrise(.tagName).operationId. If an operation doesn't have an operationId one will be generated from the path and method.

Each operation has a nested Request and a Response, as well as a static service property

Service

This is the struct that contains the static information about an operation including it's id, tag, method, pre-modified path, and authorization requirements. It has a generic ResponseType type which maps to the Response type. You shouldn't really need to interact with this service type.

Request

Each request is a subclass of APIRequest and has an init with a body param if it has a body, and a options struct for other url and path parameters. There is also a convenience init for passing parameters directly. The options and body structs are both mutable so they can be modified before actually sending the request.

Response

The response is an enum of all the possible responses the request can return. it also contains getters for the statusCode, whether it was successful, and the actual decoded optional success response. If the operation only has one type of failure type there is also an optional failure type.

Model

Models that are sent and returned from the API are mutable classes. Each model is Equatable and Codable.

Required properties are non optional and non-required are optional

All properties can be passed into the initializer, with required properties being mandatory.

If a model has additionalProperties it will have a subscript to access these by string

APIClient

The APIClient is used to encode, authorize, send, monitor, and decode the requests. There is a APIClient.default that uses the default baseURL otherwise a custom one can be initialized:

public init(baseURL: String, sessionManager: SessionManager = .default, defaultHeaders: [String: String] = [:], behaviours: [RequestBehaviour] = [])

APIClient properties

  • baseURL: The base url that every request path will be appended to
  • behaviours: A list of Request Behaviours to add to every request
  • session: An URLSession that can be configured ahead of time
  • defaultHeaders: Headers that will be applied to every request

Making a request

To make a request first initialize a Request and then pass it to makeRequest, which will return an APIResponsePublisher<T>, which will eventually publish a single APIResponse<T>, successful or failed.

func makeRequest<T>(_ request: APIRequest<T>, behaviours: [RequestBehaviour] = []) -> APIResponsePublisher<T>

There is also a higher level shortcut call<T> that will publish the service's success type, or error with an APIClientError or one of the service's failure types.

Example request that can be run from the command line (that is not neccessarily in this api):

import Combine
import Dispatch
import Foundation

/// Something we can wait on at the very end of the script.
let done = DispatchWorkItem {}

APIClient.default
    .call(Bitrise.User.GetUser.Request(id: 123))
    .receive(
        subscriber: Subscribers.Sink(
            receiveCompletion: { completion in
                switch completion {
                    case .failure(let error):
                        print("GetUser failed with \(error)")
                    case .finished:
                        print("Finished")
                }
                DispatchQueue.global().async(execute: done)
            },
            receiveValue: { user in
                print("GetUser returned user \(user)")
            }
        )
    )

done.wait()

Each Request also has a makeRequest convenience function that uses Bitrise.shared.

APIResponse

The APIResponse that gets passed to the completion closure contains the following properties:

  • request: The original request
  • result: A Result type either containing an APIClientError or the Response of the request
  • urlRequest: The URLRequest used to send the request
  • urlResponse: The HTTPURLResponse that was returned by the request
  • data: The Data returned by the request.
  • metrics: The URLSessionTaskMetrics of the request which contains timing information. # TODO: not implemented yet

Encoding and Decoding

Only JSON requests and responses are supported. These are encoded and decoded by JSONEncoder and JSONDecoder respectively, using Swift's Codable apis. There are some options to control how invalid JSON is handled when decoding and these are available as static properties on Bitrise:

  • safeOptionalDecoding: Whether to discard any errors when decoding optional properties. Defaults to true.
  • safeArrayDecoding: Whether to remove invalid elements instead of throwing when decoding arrays. Defaults to true.

Dates are encoded and decoded differently according to the swagger date format. They use different DateFormatter's that you can set.

  • date-time
    • DateTime.dateEncodingFormatter: defaults to yyyy-MM-dd'T'HH:mm:ss.Z
    • DateTime.dateDecodingFormatters: an array of date formatters. The first one to decode successfully will be used
  • date
    • DateDay.dateFormatter: defaults to yyyy-MM-dd

APIClientError

This is error enum that APIResponse.result may contain:

public enum APIClientError: Error {
    case unexpectedStatusCode(statusCode: Int, data: Data)
    case decodingError(DecodingError)
    case requestEncodingError(String)
    case validationError(String)
    case networkError(Error)
    case unknownError(Error)
}

RequestBehaviour

Request behaviours are used to modify, authorize, monitor or respond to requests. They can be added to the APIClient.behaviours for all requests, or they can passed into makeRequest for just that single request.

RequestBehaviour is a protocol you can conform to with each function being optional. As the behaviours must work across multiple different request types, they only have access to a typed erased AnyRequest.

public typealias RequestValidationPublisher = AnyPublisher<URLRequest, Error>

public protocol RequestBehaviour {

    /// runs first and allows the requests to be modified. If modifying asynchronously use validate
    func modifyRequest(request: AnyRequest, urlRequest: URLRequest) -> URLRequest

    /// validates and modifies the request asynchronously.
    func validate(request: AnyRequest, urlRequest: URLRequest) -> RequestValidationPublisher

    /// called before request is sent
    func beforeSend(request: AnyRequest)

    /// called when request successfuly returns a 200 range response
    func onSuccess(request: AnyRequest, result: Any)

    /// called when request fails with an error. This will not be called if the request returns a known response even if the a status code is out of the 200 range
    func onFailure(request: AnyRequest, error: APIClientError)

    /// called if the request recieves a network response. This is not called if request fails validation or encoding
    func onResponse(request: AnyRequest, response: AnyResponse)
}

Authorization

Each request has an optional securityRequirement. You can create a RequestBehaviour that checks this requirement and adds some form of authorization (usually via headers) in validate or modifyRequest. An alternative way is to set the APIClient.defaultHeaders which applies to all requests.

Reactive and Promises

Not supported. This will eventually be pure Combine, all the way down to encoding/decoding. # TODO: not there yet…

Models

  • AddonsAddon
  • AddonsDeveloperLink
  • AddonsFeature
  • AddonsPlan
  • AddonsSetupGuide
  • AddonsSetupInstruction
  • ServiceStandardErrorRespModel
  • V0ActivityEventListResponseModel
  • V0ActivityEventResponseItemModel
  • V0AddOnAppResponseItemModel
  • V0AddonsListResponseModel
  • V0AddonsShowResponseModel
  • V0AndroidKeystoreFileUploadParams
  • V0AppAddOnResponseItemModel
  • V0AppAddOnsListResponseModel
  • V0AppConfigRequestParam
  • V0AppConfigRespModel
  • V0AppFinishParams
  • V0AppFinishRespModel
  • V0AppListResponseModel
  • V0AppRespModel
  • V0AppResponseItemModel
  • V0AppShowResponseModel
  • V0AppUploadParams
  • V0AppWebhookCreateParams
  • V0AppWebhookCreatedResponseModel
  • V0AppWebhookDeletedResponseModel
  • V0AppWebhookListResponseModel
  • V0AppWebhookResponseItemModel
  • V0AppWebhookResponseModel
  • V0AppWebhookUpdateParams
  • V0AppleAPICredentialResponseItem
  • V0AppleAPICredentialsListResponse
  • V0ArtifactDeleteResponseModel
  • V0ArtifactListElementResponseModel
  • V0ArtifactListResponseModel
  • V0ArtifactResponseItemModel
  • V0ArtifactShowResponseModel
  • V0ArtifactUpdateParams
  • V0AvatarCandidateCreateBulkParams
  • V0AvatarCandidateCreateParams
  • V0AvatarCandidateCreateResponseItem
  • V0AvatarCandidateCreateResponseItems
  • V0AvatarPromoteParams
  • V0AvatarPromoteResponseItemModel
  • V0AvatarPromoteResponseModel
  • V0BranchListResponseModel
  • V0BuildAbortParams
  • V0BuildAbortResponseModel
  • V0BuildCertificateListResponseModel
  • V0BuildCertificateResponseItemModel
  • V0BuildCertificateResponseModel
  • V0BuildCertificateUpdateParams
  • V0BuildCertificateUploadParams
  • V0BuildListAllResponseItemModel
  • V0BuildListAllResponseModel
  • V0BuildListResponseModel
  • V0BuildLogChunkItemResponseModel
  • V0BuildLogInfoResponseModel
  • V0BuildParamsEnvironment
  • V0BuildRequestListResponseModel
  • V0BuildRequestResponseItemModel
  • V0BuildRequestUpdateParams
  • V0BuildRequestUpdateResponseModel
  • V0BuildResponseItemModel
  • V0BuildShowResponseModel
  • V0BuildTriggerParams
  • V0BuildTriggerParamsBuildParams
  • V0BuildTriggerParamsHookInfo
  • V0BuildTriggerRespModel
  • V0BuildWorkflowListResponseModel
  • V0CommitPaths
  • V0FindAvatarCandidateResponse
  • V0FindAvatarCandidateResponseItem
  • V0OrganizationDataModel
  • V0OrganizationListRespModel
  • V0OrganizationOwner
  • V0OrganizationRespModel
  • V0OwnerAccountResponseModel
  • V0OwnerAddOnResponseItemModel
  • V0OwnerAddOnsListResponseModel
  • V0PagingResponseModel
  • V0PlanDataModel
  • V0ProjectFileStorageDocumentUpdateParams
  • V0ProjectFileStorageListResponseModel
  • V0ProjectFileStorageResponseItemModel
  • V0ProjectFileStorageResponseModel
  • V0ProjectFileStorageUploadParams
  • V0ProvProfileDocumentUpdateParams
  • V0ProvisionProfileListResponseModel
  • V0ProvisionProfileResponseItemModel
  • V0ProvisionProfileResponseModel
  • V0ProvisionProfileUploadParams
  • V0SSHKeyRespModel
  • V0SSHKeyUploadParams
  • V0TestDeviceListResponseModel
  • V0TestDeviceResponseItemModel
  • V0UserPlanDataModel
  • V0UserPlanRespModel
  • V0UserProfileDataModel
  • V0UserProfileRespModel
  • V0WebhookDeliveryItemResponseModel
  • V0WebhookDeliveryItemShowResponseModel
  • V0WebhookRespModel

Requests

  • Bitrise.Activity
    • ActivityList: GET /me/activities
  • Bitrise.Addons
    • AddonListByApp: GET /apps/{app-slug}/addons
    • AddonListByOrganization: GET /organizations/{organization-slug}/addons
    • AddonListByUser: GET /users/{user-slug}/addons
    • AddonsList: GET /addons
    • AddonsShow: GET /addons/{addon-id}
  • Bitrise.AndroidKeystoreFile
    • AndroidKeystoreFileCreate: POST /apps/{app-slug}/android-keystore-files
    • AndroidKeystoreFileList: GET /apps/{app-slug}/android-keystore-files
  • Bitrise.AppSetup
    • AppConfigCreate: POST /apps/{app-slug}/bitrise.yml
    • AppCreate: POST /apps/register
    • AppFinish: POST /apps/{app-slug}/finish
    • AppWebhookCreate: POST /apps/{app-slug}/register-webhook
    • SshKeyCreate: POST /apps/{app-slug}/register-ssh-key
  • Bitrise.AppleApiCredentials
    • AppleApiCredentialList: GET /users/{user-slug}/apple-api-credentials
  • Bitrise.Application
    • AppConfigDatastoreShow: GET /apps/{app-slug}/bitrise.yml
    • AppList: GET /apps
    • AppListByOrganization: GET /organizations/{org-slug}/apps
    • AppListByUser: GET /users/{user-slug}/apps
    • AppShow: GET /apps/{app-slug}
    • BranchList: GET /apps/{app-slug}/branches
  • Bitrise.AvatarCandidate
    • AvatarCandidateCreate: POST /apps/{app-slug}/avatar-candidates
    • AvatarCandidateList: GET /v0.1/apps/{app-slug}/avatar-candidates
    • AvatarCandidatePromote: PATCH /apps/{app-slug}/avatar-candidates/{avatar-slug}
  • Bitrise.BuildArtifact
    • ArtifactDelete: DELETE /apps/{app-slug}/builds/{build-slug}/artifacts/{artifact-slug}
    • ArtifactList: GET /apps/{app-slug}/builds/{build-slug}/artifacts
    • ArtifactShow: GET /apps/{app-slug}/builds/{build-slug}/artifacts/{artifact-slug}
    • ArtifactUpdate: PATCH /apps/{app-slug}/builds/{build-slug}/artifacts/{artifact-slug}
  • Bitrise.BuildCertificate
    • BuildCertificateConfirm: POST /apps/{app-slug}/build-certificates/{build-certificate-slug}/uploaded
    • BuildCertificateCreate: POST /apps/{app-slug}/build-certificates
    • BuildCertificateDelete: DELETE /apps/{app-slug}/build-certificates/{build-certificate-slug}
    • BuildCertificateList: GET /apps/{app-slug}/build-certificates
    • BuildCertificateShow: GET /apps/{app-slug}/build-certificates/{build-certificate-slug}
    • BuildCertificateUpdate: PATCH /apps/{app-slug}/build-certificates/{build-certificate-slug}
  • Bitrise.BuildRequest
    • BuildRequestList: GET /apps/{app-slug}/build-requests
    • BuildRequestUpdate: PATCH /apps/{app-slug}/build-requests/{build-request-slug}
  • Bitrise.Builds
    • BuildAbort: POST /apps/{app-slug}/builds/{build-slug}/abort
    • BuildBitriseYmlShow: GET /apps/{app-slug}/builds/{build-slug}/bitrise.yml
    • BuildList: GET /apps/{app-slug}/builds
    • BuildListAll: GET /builds
    • BuildLog: GET /apps/{app-slug}/builds/{build-slug}/log
    • BuildShow: GET /apps/{app-slug}/builds/{build-slug}
    • BuildTrigger: POST /apps/{app-slug}/builds
    • BuildWorkflowList: GET /apps/{app-slug}/build-workflows
  • Bitrise.GenericProjectFile
    • GenericProjectFileConfirm: POST /apps/{app-slug}/generic-project-files/{generic-project-file-slug}/uploaded
    • GenericProjectFileDelete: DELETE /apps/{app-slug}/generic-project-files/{generic-project-file-slug}
    • GenericProjectFileList: GET /apps/{app-slug}/generic-project-files
    • GenericProjectFileShow: GET /apps/{app-slug}/generic-project-files/{generic-project-file-slug}
    • GenericProjectFileUpdate: PATCH /apps/{app-slug}/generic-project-files/{generic-project-file-slug}
    • GenericProjectFilesCreate: POST /apps/{app-slug}/generic-project-files
  • Bitrise.Organizations
    • OrgList: GET /organizations
    • OrgShow: GET /organizations/{org-slug}
  • Bitrise.OutgoingWebhook
    • OutgoingWebhookCreate: POST /apps/{app-slug}/outgoing-webhooks
    • OutgoingWebhookDelete: DELETE /apps/{app-slug}/outgoing-webhooks/{app-webhook-slug}
    • OutgoingWebhookList: GET /apps/{app-slug}/outgoing-webhooks
    • OutgoingWebhookUpdate: PUT /apps/{app-slug}/outgoing-webhooks/{app-webhook-slug}
  • Bitrise.ProvisioningProfile
    • ProvisioningProfileConfirm: POST /apps/{app-slug}/provisioning-profiles/{provisioning-profile-slug}/uploaded
    • ProvisioningProfileCreate: POST /apps/{app-slug}/provisioning-profiles
    • ProvisioningProfileDelete: DELETE /apps/{app-slug}/provisioning-profiles/{provisioning-profile-slug}
    • ProvisioningProfileList: GET /apps/{app-slug}/provisioning-profiles
    • ProvisioningProfileShow: GET /apps/{app-slug}/provisioning-profiles/{provisioning-profile-slug}
    • ProvisioningProfileUpdate: PATCH /apps/{app-slug}/provisioning-profiles/{provisioning-profile-slug}
  • Bitrise.TestDevices
    • TestDeviceList: GET /apps/{app-slug}/test-devices
  • Bitrise.User
    • UserPlan: GET /me/plan
    • UserProfile: GET /me
    • UserShow: GET /users/{user-slug}
  • Bitrise.WebhookDeliveryItem
    • WebhookDeliveryItemList: GET /apps/{app-slug}/outgoing-webhooks/{app-webhook-slug}/delivery-items
    • WebhookDeliveryItemRedeliver: POST /apps/{app-slug}/outgoing-webhooks/{app-webhook-slug}/delivery-items/{webhook-delivery-item-slug}/redeliver
    • WebhookDeliveryItemShow: GET /apps/{app-slug}/outgoing-webhooks/{app-webhook-slug}/delivery-items/{webhook-delivery-item-slug}

Description

  • Swift Tools 5.1.0

Dependencies

Last updated: Mon Dec 28 2020 19:26:19 GMT-0500 (GMT-05:00)