dist¶

Classes¶

OracleServiceProviderApiError¶

Extends¶

Error

Constructors¶

Constructor¶

new OracleServiceProviderApiError(input): OracleServiceProviderApiError;

Parameters¶

Parameter	Type
`input`	`OracleServiceProviderApiErrorInput`

Returns¶

OracleServiceProviderApiError

Overrides¶

Error.constructor

Properties¶

body¶

readonly body: unknown;

provider¶

readonly provider: "oracle-service" = "oracle-service";

response¶

readonly response: OracleServiceProviderApiErrorResponseMetadata;

status¶

readonly status: number;

Interfaces¶

OracleServiceCreateMessageInput¶

Properties¶

channelTypeCode?¶

optional channelTypeCode?: string;

fields?¶

optional fields?: OracleServiceJsonObject;

messageContent?¶

optional messageContent?: string;

messageTypeCode¶

messageTypeCode: string;

socialPrivateFlag?¶

optional socialPrivateFlag?: boolean;

sourceCode?¶

optional sourceCode?: string;

srNumber¶

srNumber: string;

statusCode?¶

optional statusCode?: string;

OracleServiceCreateRequestInput¶

Properties¶

accountPartyId?¶

optional accountPartyId?: number;

assigneeResourceId?¶

optional assigneeResourceId?: number;

categoryCode?¶

optional categoryCode?: string;

channelTypeCode?¶

optional channelTypeCode?: string;

fields?¶

optional fields?: OracleServiceJsonObject;

primaryContactPartyId?¶

optional primaryContactPartyId?: number;

problemDescription?¶

optional problemDescription?: string;

queueId?¶

optional queueId?: number;

severityCode?¶

optional severityCode?: string;

statusCode?¶

optional statusCode?: string;

title¶

title: string;

OracleServiceCredentialStatusInput¶

Properties¶

accessToken?¶

optional accessToken?: string;

apiAccessConfigured?¶

optional apiAccessConfigured?: boolean;

authConfigured?¶

optional authConfigured?: boolean;

baseUrl?¶

optional baseUrl?: string;

instanceUrl?¶

optional instanceUrl?: string;

password?¶

optional password?: string;

providerClientConfigured?¶

optional providerClientConfigured?: boolean;

scopes?¶

optional scopes?: string[];

username?¶

optional username?: string;

OracleServiceJsonObject¶

Indexable¶

[key: string]: OracleServiceProviderExtensionValue

OracleServiceLiveCheckOptions¶

Extends¶

OracleServiceTicketingClientOptions

Properties¶

accessToken?¶

optional accessToken?: string;

Inherited from¶

OracleServiceTicketingClientOptions.accessToken

apiVersion?¶

optional apiVersion?: string;

Inherited from¶

OracleServiceTicketingClientOptions.apiVersion

auth?¶

optional auth?: OracleServiceAuthOptions;

Inherited from¶

OracleServiceTicketingClientOptions.auth

baseUrl?¶

optional baseUrl?: string;

Inherited from¶

OracleServiceTicketingClientOptions.baseUrl

client?¶

optional client?: Pick<OracleServiceTicketingClient, "readiness">;

fetch?¶

optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`URL` \| `RequestInfo`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`string` \| `Request` \| `URL`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Inherited from¶

OracleServiceTicketingClientOptions.fetch

headers?¶

optional headers?: Record<string, string>;

Inherited from¶

OracleServiceTicketingClientOptions.headers

instanceUrl?¶

optional instanceUrl?: string;

Inherited from¶

OracleServiceTicketingClientOptions.instanceUrl

password?¶

optional password?: string;

Inherited from¶

OracleServiceTicketingClientOptions.password

providerClient?¶

optional providerClient?: OracleServiceTicketingProviderClient;

Inherited from¶

OracleServiceTicketingClientOptions.providerClient

retry?¶

optional retry?:
  | number
  | ProviderJsonRetryOptions;

Inherited from¶

OracleServiceTicketingClientOptions.retry

signal?¶

optional signal?: AbortSignal;

Inherited from¶

OracleServiceTicketingClientOptions.signal

timeoutMs?¶

optional timeoutMs?: number;

Inherited from¶

OracleServiceTicketingClientOptions.timeoutMs

username?¶

optional username?: string;

Inherited from¶

OracleServiceTicketingClientOptions.username

OracleServiceProviderApiErrorInput¶

Properties¶

body¶

body: unknown;

message¶

message: string;

response¶

response: OracleServiceProviderApiErrorResponseMetadata;

status¶

status: number;

OracleServiceProviderApiErrorResponseMetadata¶

Properties¶

headers¶

headers: Record<string, string>;

requestId?¶

optional requestId?: string;

statusText¶

statusText: string;

url¶

url: string;

OracleServiceProviderExtensionFields¶

Extends¶

OracleServiceJsonObject

Indexable¶

[key: string]: OracleServiceProviderExtensionValue

OracleServiceProviderResponse¶

Extends¶

OracleServiceJsonObject

Indexable¶

[key: string]: OracleServiceProviderExtensionValue

OracleServiceReadOperationInput¶

Properties¶

srNumber¶

srNumber: string;

OracleServiceSearchInput¶

Properties¶

expand?¶

optional expand?: string[];

fields?¶

optional fields?: string[];

finder?¶

optional finder?: string;

limit?¶

optional limit?: number;

offset?¶

optional offset?: number;

onlyData?¶

optional onlyData?: boolean;

orderBy?¶

optional orderBy?: string;

q?¶

optional q?: string;

OracleServiceSearchResult¶

Type Parameters¶

Type Parameter	Default type
`T`	`OracleServiceRequestResource`

Properties¶

count?¶

optional count?: number;

hasMore?¶

optional hasMore?: boolean;

items¶

items: T[];

limit?¶

optional limit?: number;

offset?¶

optional offset?: number;

OracleServiceTicketingClient¶

Extends¶

OracleServiceTicketingProviderClient

Properties¶

providerClient¶

providerClient: OracleServiceTicketingProviderClient;

Methods¶

createServiceRequest()¶

createServiceRequest(input): Promise<OracleServiceRequestResource>;

Parameters¶

Parameter	Type
`input`	`OracleServiceCreateRequestInput`

Returns¶

Promise\<OracleServiceRequestResource>

Inherited from¶

OracleServiceTicketingProviderClient.createServiceRequest

createServiceRequestMessage()¶

createServiceRequestMessage(input): Promise<OracleServiceProviderResponse>;

Parameters¶

Parameter	Type
`input`	`OracleServiceCreateMessageInput`

Returns¶

Promise\<OracleServiceProviderResponse>

Inherited from¶

OracleServiceTicketingProviderClient.createServiceRequestMessage

getServiceRequest()¶

getServiceRequest(srNumber): Promise<OracleServiceRequestResource>;

Parameters¶

Parameter	Type
`srNumber`	`string`

Returns¶

Promise\<OracleServiceRequestResource>

Inherited from¶

OracleServiceTicketingProviderClient.getServiceRequest

readiness()¶

readiness(): Promise<OracleServiceSearchResult<OracleServiceRequestResource>>;

Returns¶

Promise\<OracleServiceSearchResult\<OracleServiceRequestResource>>

Inherited from¶

OracleServiceTicketingProviderClient.readiness

searchServiceRequests()¶

searchServiceRequests(input?): Promise<OracleServiceSearchResult<OracleServiceRequestResource>>;

Parameters¶

Parameter	Type
`input?`	`OracleServiceSearchInput`

Returns¶

Promise\<OracleServiceSearchResult\<OracleServiceRequestResource>>

Inherited from¶

OracleServiceTicketingProviderClient.searchServiceRequests

updateServiceRequest()¶

updateServiceRequest(srNumber, input): Promise<OracleServiceRequestResource>;

Parameters¶

Parameter	Type
`srNumber`	`string`
`input`	`OracleServiceUpdateRequestInput`

Returns¶

Promise\<OracleServiceRequestResource>

Inherited from¶

OracleServiceTicketingProviderClient.updateServiceRequest

OracleServiceTicketingClientOptions¶

Extended by¶

OracleServiceLiveCheckOptions
OracleServiceTicketingIntegrationOptions

Properties¶

accessToken?¶

optional accessToken?: string;

apiVersion?¶

optional apiVersion?: string;

auth?¶

optional auth?: OracleServiceAuthOptions;

baseUrl?¶

optional baseUrl?: string;

fetch?¶

optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`URL` \| `RequestInfo`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`string` \| `Request` \| `URL`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

headers?¶

optional headers?: Record<string, string>;

instanceUrl?¶

optional instanceUrl?: string;

password?¶

optional password?: string;

providerClient?¶

optional providerClient?: OracleServiceTicketingProviderClient;

retry?¶

optional retry?:
  | number
  | ProviderJsonRetryOptions;

signal?¶

optional signal?: AbortSignal;

timeoutMs?¶

optional timeoutMs?: number;

username?¶

optional username?: string;

OracleServiceTicketingIntegrationOptions¶

Extends¶

OracleServiceTicketingClientOptions

Properties¶

accessToken?¶

optional accessToken?: string;

Overrides¶

OracleServiceTicketingClientOptions.accessToken

apiVersion?¶

optional apiVersion?: string;

Inherited from¶

OracleServiceTicketingClientOptions.apiVersion

auth?¶

optional auth?: OracleServiceAuthOptions;

Inherited from¶

OracleServiceTicketingClientOptions.auth

baseUrl?¶

optional baseUrl?: string;

Inherited from¶

OracleServiceTicketingClientOptions.baseUrl

client?¶

optional client?: OracleServiceTicketingClient;

fetch?¶

optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`URL` \| `RequestInfo`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`string` \| `Request` \| `URL`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Inherited from¶

OracleServiceTicketingClientOptions.fetch

headers?¶

optional headers?: Record<string, string>;

Inherited from¶

OracleServiceTicketingClientOptions.headers

instanceUrl?¶

optional instanceUrl?: string;

Overrides¶

OracleServiceTicketingClientOptions.instanceUrl

password?¶

optional password?: string;

Overrides¶

OracleServiceTicketingClientOptions.password

providerClient?¶

optional providerClient?: OracleServiceTicketingProviderClient;

Inherited from¶

OracleServiceTicketingClientOptions.providerClient

retry?¶

optional retry?:
  | number
  | ProviderJsonRetryOptions;

Inherited from¶

OracleServiceTicketingClientOptions.retry

signal?¶

optional signal?: AbortSignal;

Inherited from¶

OracleServiceTicketingClientOptions.signal

timeoutMs?¶

optional timeoutMs?: number;

Inherited from¶

OracleServiceTicketingClientOptions.timeoutMs

username?¶

optional username?: string;

Overrides¶

OracleServiceTicketingClientOptions.username

OracleServiceTicketingProviderClient¶

Extended by¶

OracleServiceTicketingClient

Methods¶

createServiceRequest()¶

createServiceRequest(input): Promise<OracleServiceRequestResource>;

Parameters¶

Parameter	Type
`input`	`OracleServiceCreateRequestInput`

Returns¶

Promise\<OracleServiceRequestResource>

createServiceRequestMessage()¶

createServiceRequestMessage(input): Promise<OracleServiceProviderResponse>;

Parameters¶

Parameter	Type
`input`	`OracleServiceCreateMessageInput`

Returns¶

Promise\<OracleServiceProviderResponse>

getServiceRequest()¶

getServiceRequest(srNumber): Promise<OracleServiceRequestResource>;

Parameters¶

Parameter	Type
`srNumber`	`string`

Returns¶

Promise\<OracleServiceRequestResource>

readiness()¶

readiness(): Promise<OracleServiceSearchResult<OracleServiceRequestResource>>;

Returns¶

Promise\<OracleServiceSearchResult\<OracleServiceRequestResource>>

searchServiceRequests()¶

searchServiceRequests(input?): Promise<OracleServiceSearchResult<OracleServiceRequestResource>>;

Parameters¶

Parameter	Type
`input?`	`OracleServiceSearchInput`

Returns¶

Promise\<OracleServiceSearchResult\<OracleServiceRequestResource>>

updateServiceRequest()¶

updateServiceRequest(srNumber, input): Promise<OracleServiceRequestResource>;

Parameters¶

Parameter	Type
`srNumber`	`string`
`input`	`OracleServiceUpdateRequestInput`

Returns¶

Promise\<OracleServiceRequestResource>

OracleServiceUpdateOperationInput¶

Extends¶

OracleServiceUpdateRequestInput

Properties¶

assigneeResourceId?¶

optional assigneeResourceId?: number;

Inherited from¶

OracleServiceUpdateRequestInput.assigneeResourceId

fields?¶

optional fields?: OracleServiceJsonObject;

Inherited from¶

OracleServiceUpdateRequestInput.fields

problemDescription?¶

optional problemDescription?: string;

Inherited from¶

OracleServiceUpdateRequestInput.problemDescription

queueId?¶

optional queueId?: number;

Inherited from¶

OracleServiceUpdateRequestInput.queueId

resolveDescription?¶

optional resolveDescription?: string;

Inherited from¶

OracleServiceUpdateRequestInput.resolveDescription

severityCode?¶

optional severityCode?: string;

Inherited from¶

OracleServiceUpdateRequestInput.severityCode

srNumber¶

srNumber: string;

statusCode?¶

optional statusCode?: string;

Inherited from¶

OracleServiceUpdateRequestInput.statusCode

title?¶

optional title?: string;

Inherited from¶

OracleServiceUpdateRequestInput.title

OracleServiceUpdateRequestInput¶

Extended by¶

OracleServiceUpdateOperationInput

Properties¶

assigneeResourceId?¶

optional assigneeResourceId?: number;

fields?¶

optional fields?: OracleServiceJsonObject;

problemDescription?¶

optional problemDescription?: string;

queueId?¶

optional queueId?: number;

resolveDescription?¶

optional resolveDescription?: string;

severityCode?¶

optional severityCode?: string;

statusCode?¶

optional statusCode?: string;

title?¶

optional title?: string;

Type Aliases¶

OracleServiceAuthOptions¶

type OracleServiceAuthOptions =
  | {
  accessToken: string;
  type: "bearer";
}
  | {
  password: string;
  type: "basic";
  username: string;
}
  | {
  headers: Record<string, string>;
  type: "headers";
};

OracleServiceJsonPrimitive¶

type OracleServiceJsonPrimitive = string | number | boolean | null;

OracleServiceJsonValue¶

type OracleServiceJsonValue =
  | OracleServiceJsonPrimitive
  | OracleServiceJsonObject
  | readonly OracleServiceJsonValue[];

OracleServiceProviderExtensionValue¶

type OracleServiceProviderExtensionValue = OracleServiceJsonValue | object | undefined;

OracleServiceProviderPayload¶

type OracleServiceProviderPayload = OracleServiceJsonObject | object;

OracleServiceProviderQuery¶

type OracleServiceProviderQuery = Record<string, OracleServiceProviderExtensionValue>;

OracleServiceRequestResource¶

type OracleServiceRequestResource = OracleServiceProviderPayload & {
  AssigneeResourceId?: number;
  ProblemDescription?: string;
  QueueId?: number;
  SeverityCd?: string;
  SrId?: number;
  SrNumber?: string;
  StatusCd?: string;
  Title?: string;
};

Type Declaration¶

Name	Type
`AssigneeResourceId?`	`number`
`ProblemDescription?`	`string`
`QueueId?`	`number`
`SeverityCd?`	`string`
`SrId?`	`number`
`SrNumber?`	`string`
`StatusCd?`	`string`
`Title?`	`string`

Functions¶

createOracleServiceRestProviderClient()¶

function createOracleServiceRestProviderClient(options): OracleServiceTicketingProviderClient;

Parameters¶

Parameter	Type
`options`	`OracleServiceTicketingClientOptions`

Returns¶

OracleServiceTicketingProviderClient

createOracleServiceTicketingClient()¶

function createOracleServiceTicketingClient(options?): OracleServiceTicketingClient;

Parameters¶

Parameter	Type
`options?`	`OracleServiceTicketingClientOptions`

Returns¶

OracleServiceTicketingClient

createOracleServiceTicketingIntegration()¶

function createOracleServiceTicketingIntegration(options): DefinedIntegration<{
  capabilities: {
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension?: boolean;
     label?: string;
     metadata?: Record<string, unknown>;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  category: string;
  channelAudiences: ("customer-facing" | "internal-support" | "mixed")[];
  coverage: {
     evidence: {
        label: string;
        url?: string;
     }[];
     notes: string[];
     scope:   | "support-workflow-subset"
        | "provider-api-subset"
        | "connector-required"
        | "local-protocol"
        | "full-provider-api";
  };
  credentialRequirements: {
     description?: string;
     id: string;
     label?: string;
     metadata?: Record<string, unknown>;
     required: boolean;
     scopes: string[];
  }[];
  directions: (
     | "receive-only"
     | "send-only"
     | "inbound-only"
     | "outbound-only"
    | "bidirectional")[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "community" | "official" | "unknown" | "partner";
     url?: string;
  }[];
  metadata?: Record<string, unknown>;
  name: string;
  operations: {
     alias: string;
     audience?: "customer-facing" | "internal-support" | "mixed";
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension: boolean;
     externallyVisible?: boolean;
     inputSchema?: unknown;
     inputSchemaName?: string;
     inputSchemaRef?: string;
     label?: string;
     metadata?: Record<string, unknown>;
     outputSchema?: unknown;
     outputSchemaName?: string;
     outputSchemaRef?: string;
     providerObject?: string;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     providerOperation?: string;
     requiredPolicyIds?: string[];
     requiresApproval?: boolean;
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "community" | "official" | "verified" | "experimental";
} & {
  capabilities: readonly [{
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "create-provider-object";
     changesWorkflow: true;
     description: "Creates Oracle Fusion Service serviceRequests records from SDK-user-selected support workflows.";
     exposesSensitiveData: true;
     label: "Create Oracle service requests";
     providerObjects: readonly [{
        kind: "oracleServiceRequest";
        label: "Oracle Service Request";
        schemaName: "serviceRequests";
      }, {
        kind: "oracleServiceRequestMessage";
        label: "Oracle Service Request Message";
        schemaName: "serviceRequests.child.messages";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "read-provider-object";
     description: "Reads Oracle Fusion Service service request records by SrNumber.";
     exposesSensitiveData: true;
     label: "Read Oracle service requests";
     providerObjects: readonly [{
        kind: "oracleServiceRequest";
        label: "Oracle Service Request";
        schemaName: "serviceRequests";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "update-provider-object";
     changesWorkflow: true;
     description: "Updates Oracle Fusion Service service request status, queue, assignee, resolution, or custom fields.";
     exposesSensitiveData: true;
     label: "Update Oracle service requests";
     providerObjects: readonly [{
        kind: "oracleServiceRequest";
        label: "Oracle Service Request";
        schemaName: "serviceRequests";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "search-provider-object";
     description: "Queries Oracle Fusion Service service requests with SDK-user-supplied q, finder, fields, and paging controls.";
     exposesSensitiveData: true;
     label: "Search Oracle service requests";
     providerObjects: readonly [{
        kind: "oracleServiceRequest";
        label: "Oracle Service Request";
        schemaName: "serviceRequests";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "handoff";
     changesWorkflow: true;
     description: "Provides Oracle service request operations for SDK-user-configured human handoff workflows.";
     exposesSensitiveData: true;
     label: "Attach handoff to Oracle Service";
     providerObjects: readonly [{
        kind: "oracleServiceRequest";
        label: "Oracle Service Request";
        schemaName: "serviceRequests";
      }, {
        kind: "oracleServiceRequestMessage";
        label: "Oracle Service Request Message";
        schemaName: "serviceRequests.child.messages";
     }];
     requiresCredential: true;
     sideEffect: true;
  }];
  category: "ticketing";
  channelAudiences: readonly ["customer-facing", "internal-support", "mixed"];
  coverage: {
     evidence: readonly [{
        label: "Oracle Fusion Service serviceRequests overview";
        url: "https://docs.oracle.com/en/cloud/saas/sales/faaps/api-internal-service-requests.html";
      }, {
        label: "Oracle Fusion Service create service request";
        url: "https://docs.oracle.com/en/cloud/saas/sales/faaps/op-servicerequests-post.html";
      }, {
        label: "Oracle Fusion Service get all service requests";
        url: "https://docs.oracle.com/en/cloud/saas/sales/faaps/op-servicerequests-get.html";
      }, {
        label: "Oracle Fusion Service get service request";
        url: "https://docs.oracle.com/en/cloud/saas/sales/faaps/op-servicerequests-srnumber-get.html";
      }, {
        label: "Oracle Fusion Service update service request";
        url: "https://docs.oracle.com/en/cloud/saas/sales/faaps/op-servicerequests-srnumber-patch.html";
      }, {
        label: "Oracle Fusion Service create service request message";
        url: "https://docs.oracle.com/en/cloud/saas/sales/faaps/op-servicerequests-srnumber-child-messages-post.html";
     }];
     notes: readonly ["Coverage is typed for Oracle Fusion Service serviceRequests create, read by SrNumber, patch, collection search, child message creation, and readiness checks used by Cognidesk support workflows.", "Runtime provider operations use the built-in Oracle Fusion Service REST adapter when baseUrl/instanceUrl plus access credentials are provided; a host-injected OracleServiceTicketingProviderClient remains available as an override.", "This is not full Oracle Fusion Service API coverage; service request child resources such as activities, attachments, contacts, message attachment/channel-communication lifecycle, milestones, resources, smart actions, tags, LOV/metadata behavior, workflow rules, queues, privileges, and broader Fusion CX APIs remain outside this adapter."];
     scope: "support-workflow-subset";
  };
  credentialRequirements: readonly [{
     description: "Optional SDK-user-owned provider client implementing OracleServiceTicketingProviderClient. When omitted, the package uses its built-in Oracle Fusion Service REST adapter.";
     id: "oracle-service-provider-client";
     label: "Optional host-provided Oracle Service provider client";
     metadata: {
        defaultClientPolicy: "built-in-provider-rest-adapter";
        importPolicy: "optional-host-override";
        interface: "OracleServiceTicketingProviderClient";
     };
     required: false;
   }, {
     description: "The Oracle Fusion Service base URL, for example https://example.fa.oraclecloud.com, used by the built-in REST adapter or supplied by a host provider client override.";
     id: "oracle-service-instance";
     label: "Oracle Fusion Service instance URL";
     metadata: {
        requiredWhen: "built-in-provider-rest-adapter";
     };
     required: false;
   }, {
     description: "Server-side Oracle Fusion Service access for serviceRequests and child messages, supplied as accessToken, basic auth, auth headers, or encapsulated in a host provider client.";
     id: "oracle-service-api-access";
     label: "Oracle Fusion Service API access";
     metadata: {
        privilegeGuidance: "These strings are Cognidesk capability labels, not official Oracle OAuth scope names. Oracle access depends on Fusion Service roles and privileges for service request read/create/update/search and message creation.";
        requiredWhen: "built-in-provider-rest-adapter";
        scopeKind: "internal-capability-labels";
     };
     required: false;
     scopes: readonly ["serviceRequests:read", "serviceRequests:write"];
  }];
  directions: readonly ["bidirectional"];
  id: "ticketing.oracle-service";
  limitations: readonly ["Oracle Service categories, required fields, queues, assignment rules, milestones, extensions, and privileges are owned by the SDK user's Fusion Service environment.", "SDK users own handoff timing, field mapping, customer identity matching, visibility, consent, notification policy, retry/rate-limit behavior, and retention before calling Oracle APIs.", "The built-in adapter covers selected serviceRequests REST operations only; hosts can still inject an approved Oracle Service provider client for custom authentication, retries, or API-version policy."];
  maintainers: readonly [{
     name: "Cognidesk";
     type: "official";
  }];
  metadata: {
     channelCoverage: {
        activitiesContactsMilestones: "provider-supported-not-typed";
        attachments: "provider-supported-not-typed";
        queuesSmartActionsWorkflowRules: "not-covered";
        readinessSearch: "typed-search";
        serviceRequestMessages: "typed-create";
        serviceRequests: "typed-create-read-update-search";
     };
     checkedProviderApiCoverage: {
        checkedFamilyCount: 5;
        coverageArtifact: "docs/provider-coverage/oracle-service-checked-service-requests-2026-06-18.inventory.json";
        gapFamilyCount: 2;
        implementedFamilyCount: 3;
        implementedOperationCount: 5;
        sourceKind: "checked-endpoint-family-inventory";
        verifiedAt: "2026-06-18";
     };
     implementation: {
        adapterKind: "no-official-sdk-rest-adapter";
        apiVersion: "11.13.18.05";
        defaultClient: "built-in-oracle-fusion-service-rest-adapter";
        providerClientOverride: true;
        strategy: "provider-rest-adapter";
     };
     implementationStrategy: {
        checkedAt: "2026-06-25";
        exception: "provider-rest-adapter";
        reason: "No suitable maintained npm runtime SDK was verified for Oracle Fusion Service serviceRequests or Oracle Service Cloud/B2C Service incidents; Oracle documents these ticketing surfaces as REST APIs, while the official OCI TypeScript/JavaScript SDK manages OCI resources including Fusion Apps as a Service rather than service request records.";
        rejectedLibraries: readonly [{
           packageName: "oci-fusionapps";
           reason: "Oracle-maintained OCI SDK package for Fusion Apps Service administration, not a typed Oracle Fusion Service serviceRequests or B2C Service incident data client.";
           result: "not-used-as-runtime-ticketing-sdk";
           source: "npm";
           version: "2.135.1";
         }, {
           packageName: "oci-sdk";
           reason: "Oracle-maintained OCI SDK aggregate, but it does not expose the Oracle Fusion Service serviceRequests or Oracle B2C Service incident ticketing runtime surface used by this package.";
           result: "not-used-as-runtime-ticketing-sdk";
           source: "npm";
           version: "2.135.1";
         }, {
           packageName: "osvc_node";
           reason: "Unofficial Oracle Service Cloud REST wrapper last published years ago, not a maintained Oracle runtime SDK suitable for Cognidesk provider-client ownership.";
           result: "rejected-unofficial-stale-wrapper";
           source: "npm";
           version: "1.0.0";
        }];
        result: "no-suitable-maintained-runtime-provider-sdk";
        strategy: "no-official-sdk-rest-adapter";
     };
     providerClient: {
        defaultClientPolicy: "built-in-provider-rest-adapter";
        importPolicy: "optional-host-override";
        interface: "OracleServiceTicketingProviderClient";
        operationTargets: readonly [{
           alias: "ticket.create";
           target: "providerClient.createServiceRequest";
         }, {
           alias: "ticket.read";
           target: "providerClient.getServiceRequest";
         }, {
           alias: "ticket.update";
           target: "providerClient.updateServiceRequest";
         }, {
           alias: "ticket.search";
           target: "providerClient.searchServiceRequests";
         }, {
           alias: "oracle-service.serviceRequestMessage.create";
           target: "providerClient.createServiceRequestMessage";
        }];
        package: "optional-host-provided";
     };
     providerRestAdapterOperationSlice: {
        adapterKind: "no-official-sdk-rest-adapter";
        checkedAt: "2026-06-25";
        operations: readonly [{
           alias: "ticket.create";
           target: "providerClient.createServiceRequest";
         }, {
           alias: "ticket.read";
           target: "providerClient.getServiceRequest";
         }, {
           alias: "ticket.update";
           target: "providerClient.updateServiceRequest";
         }, {
           alias: "ticket.search";
           target: "providerClient.searchServiceRequests";
         }, {
           alias: "oracle-service.serviceRequestMessage.create";
           target: "providerClient.createServiceRequestMessage";
        }];
        sourceKind: "provider-rest-adapter";
        sourceVersion: "11.13.18.05";
     };
     sdkDecision: {
        acceptedRuntimeProviderSdk: null;
        checkedAt: "2026-06-25";
        checkedSources: readonly ["Oracle Fusion Service serviceRequests REST API documentation", "Oracle B2C Service incidents REST API documentation", "npm registry package metadata and search results"];
        providerRestAdapterException: true;
        rejectedLibraries: readonly [{
           packageName: "oci-fusionapps";
           reason: "Oracle-maintained OCI SDK package for Fusion Apps Service administration, not a typed Oracle Fusion Service serviceRequests or B2C Service incident data client.";
           result: "not-used-as-runtime-ticketing-sdk";
           source: "npm";
           version: "2.135.1";
         }, {
           packageName: "oci-sdk";
           reason: "Oracle-maintained OCI SDK aggregate, but it does not expose the Oracle Fusion Service serviceRequests or Oracle B2C Service incident ticketing runtime surface used by this package.";
           result: "not-used-as-runtime-ticketing-sdk";
           source: "npm";
           version: "2.135.1";
         }, {
           packageName: "osvc_node";
           reason: "Unofficial Oracle Service Cloud REST wrapper last published years ago, not a maintained Oracle runtime SDK suitable for Cognidesk provider-client ownership.";
           result: "rejected-unofficial-stale-wrapper";
           source: "npm";
           version: "1.0.0";
        }];
        result: "provider-rest-adapter-exception";
        viableMaintainedRuntimeProviderSdk: false;
     };
  };
  name: "Oracle Service";
  operations: readonly [{
     alias: "ticket.create";
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "create-provider-object";
     changesWorkflow: true;
     exposesSensitiveData: true;
     providerObject: "oracleServiceRequest";
     requiresCredential: true;
     sideEffect: true;
   }, {
     alias: "ticket.read";
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "read-provider-object";
     exposesSensitiveData: true;
     providerObject: "oracleServiceRequest";
     requiresCredential: true;
   }, {
     alias: "ticket.update";
     audiences: readonly ["internal-support", "mixed"];
     capability: "update-provider-object";
     changesWorkflow: true;
     exposesSensitiveData: true;
     providerObject: "oracleServiceRequest";
     requiresCredential: true;
     sideEffect: true;
   }, {
     alias: "ticket.search";
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "search-provider-object";
     exposesSensitiveData: true;
     providerObject: "oracleServiceRequest";
     requiresCredential: true;
   }, {
     alias: "oracle-service.serviceRequestMessage.create";
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "create-provider-object";
     changesWorkflow: true;
     exposesSensitiveData: true;
     extension: true;
     providerObject: "oracleServiceRequestMessage";
     requiresCredential: true;
     sideEffect: true;
  }];
  packageName: "@cognidesk/integration-ticketing-oracle-service";
  privacyNotes: readonly ["Oracle service requests can contain customer identity, problem descriptions, service profile data, queue and assignee details, and internal resolution notes.", "Oracle credentials stay server-side and are represented in Studio only as credential readiness and scope status."];
  provider: "oracle-service";
  trustLevel: "official";
}, {
  accessToken: string;
  authConfigured: true;
  baseUrl: string;
  basicAuthConfigured: boolean;
  headersConfigured: boolean;
  instanceUrl: string;
  providerClientConfigured: true;
}, {
  oracle-service.serviceRequestMessage.create: (input) => Promise<OracleServiceProviderResponse>;
  ticket.create: (input) => Promise<OracleServiceRequestResource>;
  ticket.read: (input) => Promise<OracleServiceRequestResource>;
  ticket.search: (input?) => Promise<OracleServiceSearchResult<OracleServiceRequestResource>>;
  ticket.update: (input) => Promise<OracleServiceRequestResource>;
}>;

Parameters¶

Parameter	Type
`options`	`OracleServiceTicketingIntegrationOptions`

Returns¶

DefinedIntegration\<{ capabilities: { audiences?: ("customer-facing" | "internal-support" | "mixed")[]; capability: string; changesWorkflow?: boolean; description?: string; exposesSensitiveData?: boolean; extension?: boolean; label?: string; metadata?: Record\<string, unknown>; providerObjects?: { description?: string; kind: string; label?: string; metadata?: Record\<string, unknown>; schemaName?: string; }[]; requiresCredential?: boolean; sideEffect?: boolean; }[]; category: string; channelAudiences: ("customer-facing" | "internal-support" | "mixed")[]; coverage: { evidence: { label: string; url?: string; }[]; notes: string[]; scope: | "support-workflow-subset" | "provider-api-subset" | "connector-required" | "local-protocol" | "full-provider-api"; }; credentialRequirements: { description?: string; id: string; label?: string; metadata?: Record\<string, unknown>; required: boolean; scopes: string[]; }[]; directions: ( | "receive-only" | "send-only" | "inbound-only" | "outbound-only" | "bidirectional")[]; id: string; limitations: string[]; maintainers: { name: string; type: "community" | "official" | "unknown" | "partner"; url?: string; }[]; metadata?: Record\<string, unknown>; name: string; operations: { alias: string; audience?: "customer-facing" | "internal-support" | "mixed"; audiences?: ("customer-facing" | "internal-support" | "mixed")[]; capability: string; changesWorkflow?: boolean; description?: string; exposesSensitiveData?: boolean; extension: boolean; externallyVisible?: boolean; inputSchema?: unknown; inputSchemaName?: string; inputSchemaRef?: string; label?: string; metadata?: Record\<string, unknown>; outputSchema?: unknown; outputSchemaName?: string; outputSchemaRef?: string; providerObject?: string; providerObjects?: { description?: string; kind: string; label?: string; metadata?: Record\<string, unknown>; schemaName?: string; }[]; providerOperation?: string; requiredPolicyIds?: string[]; requiresApproval?: boolean; requiresCredential?: boolean; sideEffect?: boolean; }[]; packageName: string; privacyNotes: string[]; provider: string; trustLevel: "community" | "official" | "verified" | "experimental"; } & { capabilities: readonly [{ audiences: readonly ["customer-facing", "internal-support", "mixed"]; capability: "create-provider-object"; changesWorkflow: true; description: "Creates Oracle Fusion Service serviceRequests records from SDK-user-selected support workflows."; exposesSensitiveData: true; label: "Create Oracle service requests"; providerObjects: readonly [{ kind: "oracleServiceRequest"; label: "Oracle Service Request"; schemaName: "serviceRequests"; }, { kind: "oracleServiceRequestMessage"; label: "Oracle Service Request Message"; schemaName: "serviceRequests.child.messages"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["customer-facing", "internal-support", "mixed"]; capability: "read-provider-object"; description: "Reads Oracle Fusion Service service request records by SrNumber."; exposesSensitiveData: true; label: "Read Oracle service requests"; providerObjects: readonly [{ kind: "oracleServiceRequest"; label: "Oracle Service Request"; schemaName: "serviceRequests"; }]; requiresCredential: true; }, { audiences: readonly ["internal-support", "mixed"]; capability: "update-provider-object"; changesWorkflow: true; description: "Updates Oracle Fusion Service service request status, queue, assignee, resolution, or custom fields."; exposesSensitiveData: true; label: "Update Oracle service requests"; providerObjects: readonly [{ kind: "oracleServiceRequest"; label: "Oracle Service Request"; schemaName: "serviceRequests"; }]; requiresCredential: true; sideEffect: true; }, { audiences: readonly ["customer-facing", "internal-support", "mixed"]; capability: "search-provider-object"; description: "Queries Oracle Fusion Service service requests with SDK-user-supplied q, finder, fields, and paging controls."; exposesSensitiveData: true; label: "Search Oracle service requests"; providerObjects: readonly [{ kind: "oracleServiceRequest"; label: "Oracle Service Request"; schemaName: "serviceRequests"; }]; requiresCredential: true; }, { audiences: readonly ["customer-facing", "internal-support", "mixed"]; capability: "handoff"; changesWorkflow: true; description: "Provides Oracle service request operations for SDK-user-configured human handoff workflows."; exposesSensitiveData: true; label: "Attach handoff to Oracle Service"; providerObjects: readonly [{ kind: "oracleServiceRequest"; label: "Oracle Service Request"; schemaName: "serviceRequests"; }, { kind: "oracleServiceRequestMessage"; label: "Oracle Service Request Message"; schemaName: "serviceRequests.child.messages"; }]; requiresCredential: true; sideEffect: true; }]; category: "ticketing"; channelAudiences: readonly ["customer-facing", "internal-support", "mixed"]; coverage: { evidence: readonly [{ label: "Oracle Fusion Service serviceRequests overview"; url: "https://docs.oracle.com/en/cloud/saas/sales/faaps/api-internal-service-requests.html"; }, { label: "Oracle Fusion Service create service request"; url: "https://docs.oracle.com/en/cloud/saas/sales/faaps/op-servicerequests-post.html"; }, { label: "Oracle Fusion Service get all service requests"; url: "https://docs.oracle.com/en/cloud/saas/sales/faaps/op-servicerequests-get.html"; }, { label: "Oracle Fusion Service get service request"; url: "https://docs.oracle.com/en/cloud/saas/sales/faaps/op-servicerequests-srnumber-get.html"; }, { label: "Oracle Fusion Service update service request"; url: "https://docs.oracle.com/en/cloud/saas/sales/faaps/op-servicerequests-srnumber-patch.html"; }, { label: "Oracle Fusion Service create service request message"; url: "https://docs.oracle.com/en/cloud/saas/sales/faaps/op-servicerequests-srnumber-child-messages-post.html"; }]; notes: readonly ["Coverage is typed for Oracle Fusion Service serviceRequests create, read by SrNumber, patch, collection search, child message creation, and readiness checks used by Cognidesk support workflows.", "Runtime provider operations use the built-in Oracle Fusion Service REST adapter when baseUrl/instanceUrl plus access credentials are provided; a host-injected OracleServiceTicketingProviderClient remains available as an override.", "This is not full Oracle Fusion Service API coverage; service request child resources such as activities, attachments, contacts, message attachment/channel-communication lifecycle, milestones, resources, smart actions, tags, LOV/metadata behavior, workflow rules, queues, privileges, and broader Fusion CX APIs remain outside this adapter."]; scope: "support-workflow-subset"; }; credentialRequirements: readonly [{ description: "Optional SDK-user-owned provider client implementing OracleServiceTicketingProviderClient. When omitted, the package uses its built-in Oracle Fusion Service REST adapter."; id: "oracle-service-provider-client"; label: "Optional host-provided Oracle Service provider client"; metadata: { defaultClientPolicy: "built-in-provider-rest-adapter"; importPolicy: "optional-host-override"; interface: "OracleServiceTicketingProviderClient"; }; required: false; }, { description: "The Oracle Fusion Service base URL, for example https://example.fa.oraclecloud.com, used by the built-in REST adapter or supplied by a host provider client override."; id: "oracle-service-instance"; label: "Oracle Fusion Service instance URL"; metadata: { requiredWhen: "built-in-provider-rest-adapter"; }; required: false; }, { description: "Server-side Oracle Fusion Service access for serviceRequests and child messages, supplied as accessToken, basic auth, auth headers, or encapsulated in a host provider client."; id: "oracle-service-api-access"; label: "Oracle Fusion Service API access"; metadata: { privilegeGuidance: "These strings are Cognidesk capability labels, not official Oracle OAuth scope names. Oracle access depends on Fusion Service roles and privileges for service request read/create/update/search and message creation."; requiredWhen: "built-in-provider-rest-adapter"; scopeKind: "internal-capability-labels"; }; required: false; scopes: readonly ["serviceRequests:read", "serviceRequests:write"]; }]; directions: readonly ["bidirectional"]; id: "ticketing.oracle-service"; limitations: readonly ["Oracle Service categories, required fields, queues, assignment rules, milestones, extensions, and privileges are owned by the SDK user's Fusion Service environment.", "SDK users own handoff timing, field mapping, customer identity matching, visibility, consent, notification policy, retry/rate-limit behavior, and retention before calling Oracle APIs.", "The built-in adapter covers selected serviceRequests REST operations only; hosts can still inject an approved Oracle Service provider client for custom authentication, retries, or API-version policy."]; maintainers: readonly [{ name: "Cognidesk"; type: "official"; }]; metadata: { channelCoverage: { activitiesContactsMilestones: "provider-supported-not-typed"; attachments: "provider-supported-not-typed"; queuesSmartActionsWorkflowRules: "not-covered"; readinessSearch: "typed-search"; serviceRequestMessages: "typed-create"; serviceRequests: "typed-create-read-update-search"; }; checkedProviderApiCoverage: { checkedFamilyCount: 5; coverageArtifact: "docs/provider-coverage/oracle-service-checked-service-requests-2026-06-18.inventory.json"; gapFamilyCount: 2; implementedFamilyCount: 3; implementedOperationCount: 5; sourceKind: "checked-endpoint-family-inventory"; verifiedAt: "2026-06-18"; }; implementation: { adapterKind: "no-official-sdk-rest-adapter"; apiVersion: "11.13.18.05"; defaultClient: "built-in-oracle-fusion-service-rest-adapter"; providerClientOverride: true; strategy: "provider-rest-adapter"; }; implementationStrategy: { checkedAt: "2026-06-25"; exception: "provider-rest-adapter"; reason: "No suitable maintained npm runtime SDK was verified for Oracle Fusion Service serviceRequests or Oracle Service Cloud/B2C Service incidents; Oracle documents these ticketing surfaces as REST APIs, while the official OCI TypeScript/JavaScript SDK manages OCI resources including Fusion Apps as a Service rather than service request records."; rejectedLibraries: readonly [{ packageName: "oci-fusionapps"; reason: "Oracle-maintained OCI SDK package for Fusion Apps Service administration, not a typed Oracle Fusion Service serviceRequests or B2C Service incident data client."; result: "not-used-as-runtime-ticketing-sdk"; source: "npm"; version: "2.135.1"; }, { packageName: "oci-sdk"; reason: "Oracle-maintained OCI SDK aggregate, but it does not expose the Oracle Fusion Service serviceRequests or Oracle B2C Service incident ticketing runtime surface used by this package."; result: "not-used-as-runtime-ticketing-sdk"; source: "npm"; version: "2.135.1"; }, { packageName: "osvc_node"; reason: "Unofficial Oracle Service Cloud REST wrapper last published years ago, not a maintained Oracle runtime SDK suitable for Cognidesk provider-client ownership."; result: "rejected-unofficial-stale-wrapper"; source: "npm"; version: "1.0.0"; }]; result: "no-suitable-maintained-runtime-provider-sdk"; strategy: "no-official-sdk-rest-adapter"; }; providerClient: { defaultClientPolicy: "built-in-provider-rest-adapter"; importPolicy: "optional-host-override"; interface: "OracleServiceTicketingProviderClient"; operationTargets: readonly [{ alias: "ticket.create"; target: "providerClient.createServiceRequest"; }, { alias: "ticket.read"; target: "providerClient.getServiceRequest"; }, { alias: "ticket.update"; target: "providerClient.updateServiceRequest"; }, { alias: "ticket.search"; target: "providerClient.searchServiceRequests"; }, { alias: "oracle-service.serviceRequestMessage.create"; target: "providerClient.createServiceRequestMessage"; }]; package: "optional-host-provided"; }; providerRestAdapterOperationSlice: { adapterKind: "no-official-sdk-rest-adapter"; checkedAt: "2026-06-25"; operations: readonly [{ alias: "ticket.create"; target: "providerClient.createServiceRequest"; }, { alias: "ticket.read"; target: "providerClient.getServiceRequest"; }, { alias: "ticket.update"; target: "providerClient.updateServiceRequest"; }, { alias: "ticket.search"; target: "providerClient.searchServiceRequests"; }, { alias: "oracle-service.serviceRequestMessage.create"; target: "providerClient.createServiceRequestMessage"; }]; sourceKind: "provider-rest-adapter"; sourceVersion: "11.13.18.05"; }; sdkDecision: { acceptedRuntimeProviderSdk: null; checkedAt: "2026-06-25"; checkedSources: readonly ["Oracle Fusion Service serviceRequests REST API documentation", "Oracle B2C Service incidents REST API documentation", "npm registry package metadata and search results"]; providerRestAdapterException: true; rejectedLibraries: readonly [{ packageName: "oci-fusionapps"; reason: "Oracle-maintained OCI SDK package for Fusion Apps Service administration, not a typed Oracle Fusion Service serviceRequests or B2C Service incident data client."; result: "not-used-as-runtime-ticketing-sdk"; source: "npm"; version: "2.135.1"; }, { packageName: "oci-sdk"; reason: "Oracle-maintained OCI SDK aggregate, but it does not expose the Oracle Fusion Service serviceRequests or Oracle B2C Service incident ticketing runtime surface used by this package."; result: "not-used-as-runtime-ticketing-sdk"; source: "npm"; version: "2.135.1"; }, { packageName: "osvc_node"; reason: "Unofficial Oracle Service Cloud REST wrapper last published years ago, not a maintained Oracle runtime SDK suitable for Cognidesk provider-client ownership."; result: "rejected-unofficial-stale-wrapper"; source: "npm"; version: "1.0.0"; }]; result: "provider-rest-adapter-exception"; viableMaintainedRuntimeProviderSdk: false; }; }; name: "Oracle Service"; operations: readonly [{ alias: "ticket.create"; audiences: readonly ["customer-facing", "internal-support", "mixed"]; capability: "create-provider-object"; changesWorkflow: true; exposesSensitiveData: true; providerObject: "oracleServiceRequest"; requiresCredential: true; sideEffect: true; }, { alias: "ticket.read"; audiences: readonly ["customer-facing", "internal-support", "mixed"]; capability: "read-provider-object"; exposesSensitiveData: true; providerObject: "oracleServiceRequest"; requiresCredential: true; }, { alias: "ticket.update"; audiences: readonly ["internal-support", "mixed"]; capability: "update-provider-object"; changesWorkflow: true; exposesSensitiveData: true; providerObject: "oracleServiceRequest"; requiresCredential: true; sideEffect: true; }, { alias: "ticket.search"; audiences: readonly ["customer-facing", "internal-support", "mixed"]; capability: "search-provider-object"; exposesSensitiveData: true; providerObject: "oracleServiceRequest"; requiresCredential: true; }, { alias: "oracle-service.serviceRequestMessage.create"; audiences: readonly ["customer-facing", "internal-support", "mixed"]; capability: "create-provider-object"; changesWorkflow: true; exposesSensitiveData: true; extension: true; providerObject: "oracleServiceRequestMessage"; requiresCredential: true; sideEffect: true; }]; packageName: "@cognidesk/integration-ticketing-oracle-service"; privacyNotes: readonly ["Oracle service requests can contain customer identity, problem descriptions, service profile data, queue and assignee details, and internal resolution notes.", "Oracle credentials stay server-side and are represented in Studio only as credential readiness and scope status."]; provider: "oracle-service"; trustLevel: "official"; }, { accessToken: string; authConfigured: true; baseUrl: string; basicAuthConfigured: boolean; headersConfigured: boolean; instanceUrl: string; providerClientConfigured: true; }, { oracle-service.serviceRequestMessage.create: (input) => Promise\<OracleServiceProviderResponse>; ticket.create: (input) => Promise\<OracleServiceRequestResource>; ticket.read: (input) => Promise\<OracleServiceRequestResource>; ticket.search: (input?) => Promise\<OracleServiceSearchResult\<OracleServiceRequestResource>>; ticket.update: (input) => Promise\<OracleServiceRequestResource>; }>

createOracleServiceTicketingLiveChecks()¶

function createOracleServiceTicketingLiveChecks(options): {
  description: string;
  id: string;
  requiredCredentialIds: string[];
  run: Promise<{
     details: {
        hasMore: boolean;
        sampleCount: number;
     };
  }>;
}[];

Parameters¶

Parameter	Type
`options`	`OracleServiceLiveCheckOptions`

Returns¶

{ description: string; id: string; requiredCredentialIds: string[]; run: Promise\<{ details: { hasMore: boolean; sampleCount: number; }; }>; }[]

createOracleServiceTicketingOperationHandlers()¶

function createOracleServiceTicketingOperationHandlers(client): {
  oracle-service.serviceRequestMessage.create: (input) => Promise<OracleServiceProviderResponse>;
  ticket.create: (input) => Promise<OracleServiceRequestResource>;
  ticket.read: (input) => Promise<OracleServiceRequestResource>;
  ticket.search: (input?) => Promise<OracleServiceSearchResult<OracleServiceRequestResource>>;
  ticket.update: (input) => Promise<OracleServiceRequestResource>;
};

Parameters¶

Parameter	Type
`client`	`OracleServiceTicketingClient`

Returns¶

{
  oracle-service.serviceRequestMessage.create: (input) => Promise<OracleServiceProviderResponse>;
  ticket.create: (input) => Promise<OracleServiceRequestResource>;
  ticket.read: (input) => Promise<OracleServiceRequestResource>;
  ticket.search: (input?) => Promise<OracleServiceSearchResult<OracleServiceRequestResource>>;
  ticket.update: (input) => Promise<OracleServiceRequestResource>;
}

Name	Type
`oracle-service.serviceRequestMessage.create()`	(`input`) => `Promise`\<`OracleServiceProviderResponse`>
`ticket.create()`	(`input`) => `Promise`\<`OracleServiceRequestResource`>
`ticket.read()`	(`input`) => `Promise`\<`OracleServiceRequestResource`>
`ticket.search()`	(`input?`) => `Promise`\<`OracleServiceSearchResult`\<`OracleServiceRequestResource`>>
`ticket.update()`	(`input`) => `Promise`\<`OracleServiceRequestResource`>

createUnconfiguredOracleServiceTicketingProviderClient()¶

function createUnconfiguredOracleServiceTicketingProviderClient(): OracleServiceTicketingProviderClient;

Returns¶

OracleServiceTicketingProviderClient

oracleServiceTicketingCredentialStatuses()¶

function oracleServiceTicketingCredentialStatuses(input): {
  expiresAt?: string;
  message?: string;
  providerPackageId?: string;
  requirementId: string;
  scopes?: string[];
  state:   | "required"
     | "configured"
     | "permission-blocked"
     | "not-required"
     | "missing"
     | "expired"
     | "insufficient-scope"
     | "unavailable";
}[];

Parameters¶

Parameter	Type
`input`	`OracleServiceCredentialStatusInput`

Returns¶

{ expiresAt?: string; message?: string; providerPackageId?: string; requirementId: string; scopes?: string[]; state: | "required" | "configured" | "permission-blocked" | "not-required" | "missing" | "expired" | "insufficient-scope" | "unavailable"; }[]