dist¶

Interfaces¶

AppStoreAppAttributes¶

Indexable¶

[providerField: string]: AppStoreReviewsProviderExtensionValue

Properties¶

bundleId?¶

optional bundleId?: string;

name?¶

optional name?: string;

primaryLocale?¶

optional primaryLocale?: string;

sku?¶

optional sku?: string;

AppStoreCredentialStatusInput¶

Properties¶

appId?¶

optional appId?: string;

expiresAt?¶

optional expiresAt?: string;

issuerId?¶

optional issuerId?: string;

keyId?¶

optional keyId?: string;

privateKeyConfigured?¶

optional privateKeyConfigured?: boolean;

responsePolicyConfigured?¶

optional responsePolicyConfigured?: boolean;

AppStoreCustomerReviewAttributes¶

Indexable¶

[providerField: string]: AppStoreReviewsProviderExtensionValue

Properties¶

appVersionString?¶

optional appVersionString?: string;

body?¶

optional body?: string;

createdDate?¶

optional createdDate?: string;

rating?¶

optional rating?: number;

reviewerNickname?¶

optional reviewerNickname?: string;

territory?¶

optional territory?: string;

title?¶

optional title?: string;

AppStoreCustomerReviewRelationships¶

Indexable¶

[providerField: string]: AppStoreReviewsProviderExtensionValue

Properties¶

response?¶

optional response?: {
  data?: AppStoreRelationshipData<"customerReviewResponses">;
  links?: AppStoreRelationshipLinks;
};

data?¶

optional data?: AppStoreRelationshipData<"customerReviewResponses">;

links?¶

optional links?: AppStoreRelationshipLinks;

AppStoreCustomerReviewResponseAttributes¶

Indexable¶

[providerField: string]: AppStoreReviewsProviderExtensionValue

Properties¶

lastModifiedDate?¶

optional lastModifiedDate?: string;

responseBody?¶

optional responseBody?: string;

state?¶

optional state?: string;

AppStoreCustomerReviewResponseRelationships¶

Indexable¶

[providerField: string]: AppStoreReviewsProviderExtensionValue

Properties¶

review?¶

optional review?: {
  data?: AppStoreRelationshipData<"customerReviews">;
  links?: AppStoreRelationshipLinks;
};

data?¶

optional data?: AppStoreRelationshipData<"customerReviews">;

links?¶

optional links?: AppStoreRelationshipLinks;

AppStoreJsonApiResource¶

Type Parameters¶

Type Parameter	Default type
`TType` extends `string`	`string`
`TAttributes` extends `object`	`AppStoreReviewsJsonObject`
`TRelationships` extends `object`	`AppStoreReviewsJsonObject`

Properties¶

attributes?¶

optional attributes?: TAttributes;

id¶

id: string;

links?¶

optional links?: {
  self?: string;
} & AppStoreReviewsJsonObject;

Type Declaration¶

self?¶

optional self?: string;

relationships?¶

optional relationships?: TRelationships;

type¶

type: TType;

AppStoreJwtOptions¶

Properties¶

audience?¶

optional audience?: string;

issuerId¶

issuerId: string;

jti?¶

optional jti?: string;

keyId¶

keyId: string;

now?¶

optional now?: () => number;

Returns¶

number

privateKey¶

privateKey: string;

ttlSeconds?¶

optional ttlSeconds?: number;

AppStoreListReviewsInput¶

Properties¶

cursor?¶

optional cursor?: string;

fields?¶

optional fields?: Partial<Record<AppStoreReviewFieldResource, string[]>>;

filter?¶

optional filter?: Partial<Record<AppStoreReviewFilter, string | string[]>>;

include?¶

optional include?: AppStoreReviewInclude[];

limit?¶

optional limit?: number;

sort?¶

optional sort?:
  | string & {
}
  | "createdDate"
  | "-createdDate"
  | "rating"
  | "-rating";

AppStoreLiveCheckOptions¶

Extends¶

AppStoreReviewsClientOptions

Properties¶

accessToken?¶

optional accessToken?: string;

Inherited from¶

AppStoreReviewsClientOptions.accessToken

appId¶

appId: string;

Inherited from¶

AppStoreReviewsClientOptions.appId

baseUrl?¶

optional baseUrl?: string;

Inherited from¶

AppStoreReviewsClientOptions.baseUrl

client?¶

optional client?: Pick<AppStoreReviewsClient, "getApp">;

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¶

AppStoreReviewsClientOptions.fetch

getJwt?¶

optional getJwt?: () => string | Promise<string>;

Returns¶

string | Promise\<string>

Inherited from¶

AppStoreReviewsClientOptions.getJwt

issuerId?¶

optional issuerId?: string;

Inherited from¶

AppStoreReviewsClientOptions.issuerId

keyId?¶

optional keyId?: string;

Inherited from¶

AppStoreReviewsClientOptions.keyId

privateKey?¶

optional privateKey?: string;

Inherited from¶

AppStoreReviewsClientOptions.privateKey

providerClient?¶

optional providerClient?: AppStoreReviewsProviderClient;

Inherited from¶

AppStoreReviewsClientOptions.providerClient

retry?¶

optional retry?:
  | number
  | ProviderJsonRetryOptions;

Inherited from¶

AppStoreReviewsClientOptions.retry

sdkClient?¶

optional sdkClient?: Client;

Inherited from¶

AppStoreReviewsClientOptions.sdkClient

signal?¶

optional signal?: AbortSignal;

Inherited from¶

AppStoreReviewsClientOptions.signal

timeoutMs?¶

optional timeoutMs?: number;

Inherited from¶

AppStoreReviewsClientOptions.timeoutMs

AppStorePagedDocumentLinks¶

Properties¶

first?¶

optional first?: string;

next?¶

optional next?: string;

self?¶

optional self?: string;

AppStoreRawRequestInput¶

Properties¶

body?¶

optional body?: AppStoreReviewsProviderPayload;

method¶

method: AppStoreHttpMethod;

path¶

path: string;

query?¶

optional query?: AppStoreReviewsProviderQuery;

AppStoreRelationshipData¶

Type Parameters¶

Type Parameter	Default type
`TType` extends `string`	`string`

Properties¶

id¶

id: string;

type¶

type: TType;

AppStoreRelationshipLinks¶

Properties¶

optional related?: string;

self?¶

optional self?: string;

AppStoreResourceDocument¶

Type Parameters¶

Type Parameter	Default type
`TData` extends `AppStoreReviewsProviderExtensionValue`	\| `AppStoreJsonApiResource` \| `AppStoreJsonApiResource`[] \| `undefined`
`TIncluded` extends `AppStoreReviewsProviderExtensionValue`	`AppStoreJsonApiResource`

Indexable¶

[providerField: string]: AppStoreReviewsProviderExtensionValue

Properties¶

data?¶

optional data?: TData;

included?¶

optional included?: TIncluded[];

links?¶

optional links?: AppStorePagedDocumentLinks & AppStoreReviewsJsonObject;

meta?¶

optional meta?: AppStoreReviewsJsonObject;

AppStoreReviewResponseInput¶

Properties¶

responseBody¶

responseBody: string;

reviewId¶

reviewId: string;

AppStoreReviewsClient¶

Extends¶

AppStoreReviewsProviderClient

Properties¶

providerClient¶

providerClient: AppStoreReviewsProviderClient;

Methods¶

createOrUpdateReviewResponse()¶

createOrUpdateReviewResponse(input): Promise<AppStoreCustomerReviewResponseDocument>;

Parameters¶

Parameter	Type
`input`	`AppStoreReviewResponseInput`

Returns¶

Promise\<AppStoreCustomerReviewResponseDocument>

Inherited from¶

AppStoreReviewsProviderClient.createOrUpdateReviewResponse

deleteReviewResponse()¶

deleteReviewResponse(responseId): Promise<void>;

Parameters¶

Parameter	Type
`responseId`	`string`

Returns¶

Promise\<void>

Inherited from¶

AppStoreReviewsProviderClient.deleteReviewResponse

getApp()¶

getApp(): Promise<AppStoreAppResponse>;

Returns¶

Promise\<AppStoreAppResponse>

Inherited from¶

AppStoreReviewsProviderClient.getApp

getReview()¶

getReview(reviewId, input?): Promise<AppStoreReviewResponse>;

Parameters¶

Parameter	Type
`reviewId`	`string`
`input?`	`Pick`\<`AppStoreListReviewsInput`, `"include"` \| `"fields"`>

Returns¶

Promise\<AppStoreReviewResponse>

Inherited from¶

AppStoreReviewsProviderClient.getReview

listReviews()¶

listReviews(input?): Promise<AppStoreReviewsListResponse>;

Parameters¶

Parameter	Type
`input?`	`AppStoreListReviewsInput`

Returns¶

Promise\<AppStoreReviewsListResponse>

Inherited from¶

AppStoreReviewsProviderClient.listReviews

listReviewsPage()¶

listReviewsPage(pageUrl): Promise<AppStoreReviewsListResponse>;

Parameters¶

Parameter	Type
`pageUrl`	`string`

Returns¶

Promise\<AppStoreReviewsListResponse>

Inherited from¶

AppStoreReviewsProviderClient.listReviewsPage

AppStoreReviewsClientOptions¶

Extended by¶

AppStoreLiveCheckOptions

Properties¶

accessToken?¶

optional accessToken?: string;

appId¶

appId: string;

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>

getJwt?¶

optional getJwt?: () => string | Promise<string>;

Returns¶

string | Promise\<string>

issuerId?¶

optional issuerId?: string;

keyId?¶

optional keyId?: string;

privateKey?¶

optional privateKey?: string;

providerClient?¶

optional providerClient?: AppStoreReviewsProviderClient;

retry?¶

optional retry?:
  | number
  | ProviderJsonRetryOptions;

sdkClient?¶

optional sdkClient?: Client;

signal?¶

optional signal?: AbortSignal;

timeoutMs?¶

optional timeoutMs?: number;

AppStoreReviewsJsonObject¶

Indexable¶

[key: string]: AppStoreReviewsProviderExtensionValue

AppStoreReviewsProviderClient¶

Extended by¶

AppStoreReviewsClient

Methods¶

createOrUpdateReviewResponse()¶

createOrUpdateReviewResponse(input): Promise<AppStoreCustomerReviewResponseDocument>;

Parameters¶

Parameter	Type
`input`	`AppStoreReviewResponseInput`

Returns¶

Promise\<AppStoreCustomerReviewResponseDocument>

deleteReviewResponse()¶

deleteReviewResponse(responseId): Promise<void>;

Parameters¶

Parameter	Type
`responseId`	`string`

Returns¶

Promise\<void>

getApp()¶

getApp(): Promise<AppStoreAppResponse>;

Returns¶

Promise\<AppStoreAppResponse>

getReview()¶

getReview(reviewId, input?): Promise<AppStoreReviewResponse>;

Parameters¶

Parameter	Type
`reviewId`	`string`
`input?`	`Pick`\<`AppStoreListReviewsInput`, `"include"` \| `"fields"`>

Returns¶

Promise\<AppStoreReviewResponse>

listReviews()¶

listReviews(input?): Promise<AppStoreReviewsListResponse>;

Parameters¶

Parameter	Type
`input?`	`AppStoreListReviewsInput`

Returns¶

Promise\<AppStoreReviewsListResponse>

listReviewsPage()¶

listReviewsPage(pageUrl): Promise<AppStoreReviewsListResponse>;

Parameters¶

Parameter	Type
`pageUrl`	`string`

Returns¶

Promise\<AppStoreReviewsListResponse>

Type Aliases¶

AppStoreAppResource¶

type AppStoreAppResource = AppStoreJsonApiResource<"apps", AppStoreAppAttributes>;

AppStoreAppResponse¶

type AppStoreAppResponse = AppStoreResourceDocument<AppStoreAppResource>;

AppStoreCustomerReviewResource¶

type AppStoreCustomerReviewResource = AppStoreJsonApiResource<"customerReviews", AppStoreCustomerReviewAttributes, AppStoreCustomerReviewRelationships>;

AppStoreCustomerReviewResponseDocument¶

type AppStoreCustomerReviewResponseDocument = AppStoreResourceDocument<AppStoreCustomerReviewResponseResource>;

AppStoreCustomerReviewResponseResource¶

type AppStoreCustomerReviewResponseResource = AppStoreJsonApiResource<"customerReviewResponses", AppStoreCustomerReviewResponseAttributes, AppStoreCustomerReviewResponseRelationships>;

AppStoreHttpMethod¶

type AppStoreHttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";

AppStoreReviewFieldResource¶

type AppStoreReviewFieldResource =
  | "apps"
  | "customerReviews"
  | "customerReviewResponses"
  | string & {
};

AppStoreReviewFilter¶

type AppStoreReviewFilter =
  | "rating"
  | "territory"
  | "existsPublishedResponse"
  | string & {
};

AppStoreReviewInclude¶

type AppStoreReviewInclude =
  | "response"
  | string & {
};

AppStoreReviewResponse¶

type AppStoreReviewResponse = AppStoreResourceDocument<AppStoreCustomerReviewResource, AppStoreCustomerReviewResponseResource>;

AppStoreReviewsJsonPrimitive¶

type AppStoreReviewsJsonPrimitive = string | number | boolean | null;

AppStoreReviewsJsonValue¶

type AppStoreReviewsJsonValue =
  | AppStoreReviewsJsonPrimitive
  | AppStoreReviewsJsonObject
  | readonly AppStoreReviewsJsonValue[];

AppStoreReviewsListResponse¶

type AppStoreReviewsListResponse = AppStoreResourceDocument<AppStoreCustomerReviewResource[], AppStoreCustomerReviewResponseResource>;

AppStoreReviewsProviderExtensionValue¶

type AppStoreReviewsProviderExtensionValue =
  | AppStoreReviewsJsonValue
  | object
  | undefined;

AppStoreReviewsProviderPayload¶

type AppStoreReviewsProviderPayload = AppStoreReviewsJsonObject | object;

AppStoreReviewsProviderQuery¶

type AppStoreReviewsProviderQuery = Record<string, ProviderQueryValue>;

Variables¶

appStoreReviewOperations¶

const appStoreReviewOperations: typeof createAppStoreReviewsOperationHandlers;

appStoreReviewsIntegration¶

const appStoreReviewsIntegration: {
  bindingReport: {
     extraHandlerAliases: never[];
     invalidExtensionOperationAliases: never[];
     missingHandlerAliases: string[];
  };
  manifest: {
     capabilities: {
        audiences?: ("customer-facing" | "mixed" | "internal-support")[];
        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" | "mixed" | "internal-support")[];
     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"
        | "bidirectional"
        | "inbound-only"
       | "outbound-only")[];
     id: string;
     limitations: string[];
     maintainers: {
        name: string;
        type: "official" | "community" | "unknown" | "partner";
        url?: string;
     }[];
     metadata?: Record<string, unknown>;
     name: string;
     operations: {
        alias: string;
        audience?: "customer-facing" | "mixed" | "internal-support";
        audiences?: ("customer-facing" | "mixed" | "internal-support")[];
        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: "official" | "community" | "verified" | "experimental";
   } & {
     capabilities: {
        audiences?: ("customer-facing" | "mixed" | "internal-support")[];
        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" | "mixed" | "internal-support")[];
     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"
        | "bidirectional"
        | "inbound-only"
       | "outbound-only")[];
     id: string;
     limitations?: string[];
     maintainers?: {
        name: string;
        type?: "official" | "community" | "unknown" | "partner";
        url?: string;
     }[];
     metadata?: Record<string, unknown>;
     name: string;
     operations?: {
        alias: string;
        audience?: "customer-facing" | "mixed" | "internal-support";
        audiences?: ("customer-facing" | "mixed" | "internal-support")[];
        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<..., ...>;
           schemaName?: string;
        }[];
        providerOperation?: string;
        requiredPolicyIds?: string[];
        requiresApproval?: boolean;
        requiresCredential?: boolean;
        sideEffect?: boolean;
     }[];
     packageName: string;
     privacyNotes?: string[];
     provider: string;
     trustLevel?: "official" | "community" | "verified" | "experimental";
  };
  operationAliases: never[];
  operations: {
  };
};

Type Declaration¶

Name	Type
`bindingReport`	{ `extraHandlerAliases`: `never`[]; `invalidExtensionOperationAliases`: `never`[]; `missingHandlerAliases`: `string`[]; }
`bindingReport.extraHandlerAliases`	`never`[]
`bindingReport.invalidExtensionOperationAliases`	`never`[]
`bindingReport.missingHandlerAliases`	`string`[]
`manifest`	{ `capabilities`: { `audiences?`: (`"customer-facing"` \| `"mixed"` \| `"internal-support"`)[]; `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"` \| `"mixed"` \| `"internal-support"`)[]; `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"` \| `"bidirectional"` \| `"inbound-only"` \| `"outbound-only"`)[]; `id`: `string`; `limitations`: `string`[]; `maintainers`: { `name`: `string`; `type`: `"official"` \| `"community"` \| `"unknown"` \| `"partner"`; `url?`: `string`; }[]; `metadata?`: `Record`\<`string`, `unknown`>; `name`: `string`; `operations`: { `alias`: `string`; `audience?`: `"customer-facing"` \| `"mixed"` \| `"internal-support"`; `audiences?`: (`"customer-facing"` \| `"mixed"` \| `"internal-support"`)[]; `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`: `"official"` \| `"community"` \| `"verified"` \| `"experimental"`; } & { `capabilities`: { `audiences?`: (`"customer-facing"` \| `"mixed"` \| `"internal-support"`)[]; `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"` \| `"mixed"` \| `"internal-support"`)[]; `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"` \| `"bidirectional"` \| `"inbound-only"` \| `"outbound-only"`)[]; `id`: `string`; `limitations?`: `string`[]; `maintainers?`: { `name`: `string`; `type?`: `"official"` \| `"community"` \| `"unknown"` \| `"partner"`; `url?`: `string`; }[]; `metadata?`: `Record`\<`string`, `unknown`>; `name`: `string`; `operations?`: { `alias`: `string`; `audience?`: `"customer-facing"` \| `"mixed"` \| `"internal-support"`; `audiences?`: (`"customer-facing"` \| `"mixed"` \| `"internal-support"`)[]; `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`\<..., ...>; `schemaName?`: `string`; }[]; `providerOperation?`: `string`; `requiredPolicyIds?`: `string`[]; `requiresApproval?`: `boolean`; `requiresCredential?`: `boolean`; `sideEffect?`: `boolean`; }[]; `packageName`: `string`; `privacyNotes?`: `string`[]; `provider`: `string`; `trustLevel?`: `"official"` \| `"community"` \| `"verified"` \| `"experimental"`; }
`operationAliases`	`never`[]
`operations`	{ }

Functions¶

applyListQuery()¶

function applyListQuery(url, input): void;

Parameters¶

Parameter	Type
`url`	`URL`
`input`	\| `AppStoreListReviewsInput` \| `Pick`\<`AppStoreListReviewsInput`, `"fields"` \| `"include"`>

Returns¶

void

appStoreOperationUrl()¶

function appStoreOperationUrl(
   apiBaseUrl,
   path,
   pathParams?,
   query?): string;

Parameters¶

Parameter	Type
`apiBaseUrl`	`string`
`path`	`string`
`pathParams?`	`Record`\<`string`, `string` \| `number` \| `boolean` \| `undefined`>
`query?`	`AppStoreReviewsProviderQuery`

Returns¶

string

appStoreReviewsCredentialStatuses()¶

function appStoreReviewsCredentialStatuses(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`	`AppStoreCredentialStatusInput`

Returns¶

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

createAppStoreConnectJwt()¶

function createAppStoreConnectJwt(options): string;

Parameters¶

Parameter	Type
`options`	`AppStoreJwtOptions`

Returns¶

string

createAppStoreConnectRestProviderClient()¶

function createAppStoreConnectRestProviderClient(options): AppStoreReviewsProviderClient;

Parameters¶

Parameter	Type
`options`	`Omit`\<`AppStoreReviewsClientOptions`, `"providerClient"`>

Returns¶

AppStoreReviewsProviderClient

createAppStoreReviewsClient()¶

function createAppStoreReviewsClient(options): AppStoreReviewsClient;

Parameters¶

Parameter	Type
`options`	`AppStoreReviewsClientOptions`

Returns¶

AppStoreReviewsClient

createAppStoreReviewsIntegration()¶

function createAppStoreReviewsIntegration(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";
}, unknown, {
  appstore.reviewResponses.createOrUpdate: (input) => Promise<AppStoreCustomerReviewResponseDocument>;
  appstore.reviewResponses.delete: (input) => Promise<void>;
  appstore.reviews.get: (input) => Promise<AppStoreReviewResponse>;
  appstore.reviews.list: (input) => Promise<AppStoreReviewsListResponse>;
  appstore.reviews.page: (input) => Promise<AppStoreReviewsListResponse>;
}>;

Parameters¶

Parameter	Type
`options`	`AppStoreReviewsClientOptions`

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"; }, unknown, { appstore.reviewResponses.createOrUpdate: (input) => Promise\<AppStoreCustomerReviewResponseDocument>; appstore.reviewResponses.delete: (input) => Promise\<void>; appstore.reviews.get: (input) => Promise\<AppStoreReviewResponse>; appstore.reviews.list: (input) => Promise\<AppStoreReviewsListResponse>; appstore.reviews.page: (input) => Promise\<AppStoreReviewsListResponse>; }>

createAppStoreReviewsLiveChecks()¶

function createAppStoreReviewsLiveChecks(options): {
  description: string;
  id: string;
  requiredCredentialIds: string[];
  run: Promise<{
     details: {
        bundleId: string;
        id: string;
        name: string;
     };
  }>;
}[];

Parameters¶

Parameter	Type
`options`	`AppStoreLiveCheckOptions`

Returns¶

{ description: string; id: string; requiredCredentialIds: string[]; run: Promise\<{ details: { bundleId: string; id: string; name: string; }; }>; }[]

createAppStoreReviewsOperationHandlers()¶

function createAppStoreReviewsOperationHandlers(options): {
  appstore.reviewResponses.createOrUpdate: (input) => Promise<AppStoreCustomerReviewResponseDocument>;
  appstore.reviewResponses.delete: (input) => Promise<void>;
  appstore.reviews.get: (input) => Promise<AppStoreReviewResponse>;
  appstore.reviews.list: (input) => Promise<AppStoreReviewsListResponse>;
  appstore.reviews.page: (input) => Promise<AppStoreReviewsListResponse>;
};

Parameters¶

Parameter	Type
`options`	`AppStoreReviewsClientOptions`

Returns¶

{
  appstore.reviewResponses.createOrUpdate: (input) => Promise<AppStoreCustomerReviewResponseDocument>;
  appstore.reviewResponses.delete: (input) => Promise<void>;
  appstore.reviews.get: (input) => Promise<AppStoreReviewResponse>;
  appstore.reviews.list: (input) => Promise<AppStoreReviewsListResponse>;
  appstore.reviews.page: (input) => Promise<AppStoreReviewsListResponse>;
}

Name	Type
`appstore.reviewResponses.createOrUpdate()`	(`input`) => `Promise`\<`AppStoreCustomerReviewResponseDocument`>
`appstore.reviewResponses.delete()`	(`input`) => `Promise`\<`void`>
`appstore.reviews.get()`	(`input`) => `Promise`\<`AppStoreReviewResponse`>
`appstore.reviews.list()`	(`input`) => `Promise`\<`AppStoreReviewsListResponse`>
`appstore.reviews.page()`	(`input`) => `Promise`\<`AppStoreReviewsListResponse`>

createUnconfiguredAppStoreProviderClient()¶

function createUnconfiguredAppStoreProviderClient(): AppStoreReviewsProviderClient;

Returns¶

AppStoreReviewsProviderClient

normalizeAppStoreReviewsPageUrl()¶

function normalizeAppStoreReviewsPageUrl(
   pageUrl,
   apiBaseUrl,
   appId): string;

Parameters¶

Parameter	Type
`pageUrl`	`string`
`apiBaseUrl`	`string`
`appId`	`string`

Returns¶

string

References¶