Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions generated-sources/api/src/apis/OperationApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ export interface OperationApiInterface {
getBackfillProgress(requestParameters: GetBackfillProgressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BackfillProgress>;

/**
* Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as backfill progress or write outcome details.
* Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as read progress or write outcome details.
* @summary Get an operation
* @param {string} projectIdOrName The Ampersand project ID or project name.
* @param {string} operationId Unique identifier for the operation. Obtain from the list operations API endpoint, the Ampersand dashboard, or webhook payloads.
Expand All @@ -100,7 +100,7 @@ export interface OperationApiInterface {
getOperationRaw(requestParameters: GetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Operation>>;

/**
* Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as backfill progress or write outcome details.
* Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as read progress or write outcome details.
* Get an operation
*/
getOperation(requestParameters: GetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Operation>;
Expand Down Expand Up @@ -204,7 +204,7 @@ export class OperationApi extends runtime.BaseAPI implements OperationApiInterfa
}

/**
* Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as backfill progress or write outcome details.
* Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as read progress or write outcome details.
* Get an operation
*/
async getOperationRaw(requestParameters: GetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Operation>> {
Expand Down Expand Up @@ -243,7 +243,7 @@ export class OperationApi extends runtime.BaseAPI implements OperationApiInterfa
}

/**
* Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as backfill progress or write outcome details.
* Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as read progress or write outcome details.
* Get an operation
*/
async getOperation(requestParameters: GetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Operation> {
Expand Down
14 changes: 14 additions & 0 deletions generated-sources/api/src/models/ModuleInfo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@
*/

import { exists, mapValues } from '../runtime';
import type { SubscribeRequirements } from './SubscribeRequirements';
import {
SubscribeRequirementsFromJSON,
SubscribeRequirementsFromJSONTyped,
SubscribeRequirementsToJSON,
} from './SubscribeRequirements';
import type { Support } from './Support';
import {
SupportFromJSON,
Expand Down Expand Up @@ -44,6 +50,12 @@ export interface ModuleInfo {
* @memberof ModuleInfo
*/
support: Support;
/**
*
* @type {SubscribeRequirements}
* @memberof ModuleInfo
*/
subscribeRequirements?: SubscribeRequirements;
}

/**
Expand Down Expand Up @@ -71,6 +83,7 @@ export function ModuleInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean)
'displayName': json['displayName'],
'baseURL': json['baseURL'],
'support': SupportFromJSON(json['support']),
'subscribeRequirements': !exists(json, 'subscribeRequirements') ? undefined : SubscribeRequirementsFromJSON(json['subscribeRequirements']),
};
}

Expand All @@ -86,6 +99,7 @@ export function ModuleInfoToJSON(value?: ModuleInfo | null): any {
'displayName': value.displayName,
'baseURL': value.baseURL,
'support': SupportToJSON(value.support),
'subscribeRequirements': SubscribeRequirementsToJSON(value.subscribeRequirements),
};
}

2 changes: 1 addition & 1 deletion generated-sources/api/src/models/OperationMetadata.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import {
} from './OperationMetadataRetry';

/**
* Additional operation details (e.g. objects, retry info, backfill progress, successfulRecordIds).
* Additional operation details (e.g. objects, retry info, read progress, successfulRecordIds).
* @export
* @interface OperationMetadata
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

import { exists, mapValues } from '../runtime';
/**
* Only present for backfill read operations.
* Read progress for the operation, reporting records processed and, where available, the estimated total. Present for all read operations.
* @export
* @interface OperationMetadataProgress
*/
Expand Down
8 changes: 8 additions & 0 deletions generated-sources/api/src/models/SubscribeRequirements.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ export interface SubscribeRequirements {
* @memberof SubscribeRequirements
*/
postProcess?: boolean;
/**
* Whether the provider supports programmatic subscription via API. If false, provider may still support webhooks via manual configuration in UI.
* @type {boolean}
* @memberof SubscribeRequirements
*/
subscribeByAPI?: boolean;
}

/**
Expand All @@ -61,6 +67,7 @@ export function SubscribeRequirementsFromJSONTyped(json: any, ignoreDiscriminato
'registration': !exists(json, 'registration') ? undefined : json['registration'],
'maintenance': !exists(json, 'maintenance') ? undefined : json['maintenance'],
'postProcess': !exists(json, 'postProcess') ? undefined : json['postProcess'],
'subscribeByAPI': !exists(json, 'subscribeByAPI') ? undefined : json['subscribeByAPI'],
};
}

Expand All @@ -76,6 +83,7 @@ export function SubscribeRequirementsToJSON(value?: SubscribeRequirements | null
'registration': value.registration,
'maintenance': value.maintenance,
'postProcess': value.postProcess,
'subscribeByAPI': value.subscribeByAPI,
};
}

Loading