Class ServiceResource

Resource for managing services.

Index

Constructors

Methods

create createService deleteVersionSet getServices list updateService upsertVersionSet

Constructors

constructor

new ServiceResource(c: AmigoFetch, orgId: OrgId): ServiceResource
Parameters
- c: AmigoFetch
- orgId: OrgId
Returns ServiceResource
- Defined in resources/services.ts:8

Methods

create

create(options: { body: {}; headers?: {} }): Promise<{}>
Alias for createService.
Parameters
- options: { body: {}; headers?: {} }
Returns Promise<{}>
- Defined in resources/services.ts:114

createService

createService(options: { body: {}; headers?: {} }): Promise<{}>
Create a new service.
Parameters
- options: { body: {}; headers?: {} }
Returns Promise<{}>
- Defined in resources/services.ts:27

deleteVersionSet

deleteVersionSet(
options: { headers?: {}; serviceId: ServiceId; versionSetName: string },
): Promise<void>
Delete a service version set.
Parameters
- options: { headers?: {}; serviceId: ServiceId; versionSetName: string }
Returns Promise<void>
- Defined in resources/services.ts:81

getServices

getServices(queryParams?: {}, headers?: {}): Promise<{}>
List services for the organization.
Parameters
- OptionalqueryParams: {}
- Optionalheaders: {}
Returns Promise<{}>
- Defined in resources/services.ts:14

list

list(queryParams?: {}, headers?: {}): Promise<{}>
Alias for getServices.
Parameters
- OptionalqueryParams: {}
- Optionalheaders: {}
Returns Promise<{}>
- Defined in resources/services.ts:106

updateService

updateService(
options: { body: {}; headers?: {}; serviceId: ServiceId },
): Promise<{}>
Update a service.
Parameters
- options: { body: {}; headers?: {}; serviceId: ServiceId }
Returns Promise<{}>
- Defined in resources/services.ts:42

upsertVersionSet

upsertVersionSet(
    options: {
        body: {};
        headers?: {};
        serviceId: ServiceId;
        versionSetName: string;
    },
): Promise<never>
Upsert a service version set.
Parameters
- options: { body: {}; headers?: {}; serviceId: ServiceId; versionSetName: string }
Returns Promise<never>
- Defined in resources/services.ts:58