@harnessio/react-integration-manager-client 0.8.2 → 0.8.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -12,9 +12,9 @@ export interface GetAirbyteConnectorCatalogQueryQueryParams {
12
12
  */
13
13
  integration_type: string;
14
14
  /**
15
- * Reference to the connector
15
+ * Reference to the connector, required when fetch_default=false
16
16
  */
17
- connector_ref: string;
17
+ connector_ref?: string;
18
18
  /**
19
19
  * Filter for specific tables/streams
20
20
  */
@@ -23,6 +23,10 @@ export interface GetAirbyteConnectorCatalogQueryQueryParams {
23
23
  * Start date filter
24
24
  */
25
25
  start_date?: string;
26
+ /**
27
+ * When true returns only default streams
28
+ */
29
+ fetch_default?: boolean;
26
30
  }
27
31
  export type GetAirbyteConnectorCatalogOkResponse = ResponseWithPagination<AirbyteGetAirbyteConnectorCatalogResponse>;
28
32
  export type GetAirbyteConnectorCatalogErrorResponse = ApierrorsErrorResponse;
@@ -17,6 +17,6 @@ export interface ListDefaultMappingFieldsProps extends ListDefaultMappingFieldsQ
17
17
  }
18
18
  export declare function listDefaultMappingFields(props: ListDefaultMappingFieldsProps): Promise<ListDefaultMappingFieldsOkResponse>;
19
19
  /**
20
- * Returns fields from the default mapping for the given integration type. Query 'integration_type' is required. Only primary kinds are included. Only fields inside the mapping's metadata (properties.metadata) are returned. Response is mappings: an array of { kind, fields } where fields is a list of { field_name, display_name, description, target_path, is_required }. Optional query 'kind' filters to a single kind; when omitted, all primary kinds are returned.
20
+ * Returns fields from the default mapping for the given integration type. Query 'integration_type' is required. Only primary kinds are included. Only fields inside the mapping's metadata (properties.metadata) are returned. Response is mapping_fields: an array of { kind, fields } where fields is a list of { field_name, display_name, description, target_path, is_required }. Response also includes default_mappings: integration-level fallback field mappings (source_field, target_field, required) applied when no kind-specific mapping is present. Optional query 'kind' filters to a single kind; when omitted, all primary kinds are returned.
21
21
  */
22
22
  export declare function useListDefaultMappingFieldsQuery(props: ListDefaultMappingFieldsProps, options?: Omit<UseQueryOptions<ListDefaultMappingFieldsOkResponse, ListDefaultMappingFieldsErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ListDefaultMappingFieldsOkResponse, ApierrorsErrorResponse>;
@@ -7,7 +7,7 @@ export function listDefaultMappingFields(props) {
7
7
  return fetcher(Object.assign({ url: `/api/v1/accounts/${props.accountIdentifier}/integration/default-mapping-fields`, method: 'GET' }, props));
8
8
  }
9
9
  /**
10
- * Returns fields from the default mapping for the given integration type. Query 'integration_type' is required. Only primary kinds are included. Only fields inside the mapping's metadata (properties.metadata) are returned. Response is mappings: an array of { kind, fields } where fields is a list of { field_name, display_name, description, target_path, is_required }. Optional query 'kind' filters to a single kind; when omitted, all primary kinds are returned.
10
+ * Returns fields from the default mapping for the given integration type. Query 'integration_type' is required. Only primary kinds are included. Only fields inside the mapping's metadata (properties.metadata) are returned. Response is mapping_fields: an array of { kind, fields } where fields is a list of { field_name, display_name, description, target_path, is_required }. Response also includes default_mappings: integration-level fallback field mappings (source_field, target_field, required) applied when no kind-specific mapping is present. Optional query 'kind' filters to a single kind; when omitted, all primary kinds are returned.
11
11
  */
12
12
  export function useListDefaultMappingFieldsQuery(props, options) {
13
13
  return useQuery(['listDefaultMappingFields', props.accountIdentifier, props.queryParams], ({ signal }) => listDefaultMappingFields(Object.assign(Object.assign({}, props), { signal })), options);
@@ -1,5 +1,6 @@
1
1
  import { UseQueryOptions } from '@tanstack/react-query';
2
2
  import type { TypesIntegrationConfig } from '../schemas/TypesIntegrationConfig';
3
+ import type { ApierrorsErrorResponse } from '../schemas/ApierrorsErrorResponse';
3
4
  import type { EnumIntegrationType } from '../schemas/EnumIntegrationType';
4
5
  import type { ResponseWithPagination } from '../helpers';
5
6
  import { FetcherOptions } from '../../../../fetcher/index.js';
@@ -18,7 +19,7 @@ export interface ListIntegrationConfigsOrgQueryQueryParams {
18
19
  */
19
20
  searchterm?: string;
20
21
  /**
21
- * Maximum number of items to return. Defaults to 50 when omitted.
22
+ * Maximum number of items to return. Defaults to 50 when omitted. Maximum allowed is 200.
22
23
  */
23
24
  limit?: number;
24
25
  /**
@@ -47,7 +48,7 @@ export interface ListIntegrationConfigsOrgQueryQueryParams {
47
48
  enabled?: boolean | null;
48
49
  }
49
50
  export type ListIntegrationConfigsOrgOkResponse = ResponseWithPagination<TypesIntegrationConfig[]>;
50
- export type ListIntegrationConfigsOrgErrorResponse = unknown;
51
+ export type ListIntegrationConfigsOrgErrorResponse = ApierrorsErrorResponse;
51
52
  export interface ListIntegrationConfigsOrgProps extends ListIntegrationConfigsOrgQueryPathParams, Omit<FetcherOptions<ListIntegrationConfigsOrgQueryQueryParams, unknown>, 'url'> {
52
53
  queryParams: ListIntegrationConfigsOrgQueryQueryParams;
53
54
  }
@@ -55,4 +56,4 @@ export declare function listIntegrationConfigsOrg(props: ListIntegrationConfigsO
55
56
  /**
56
57
  * List integration configurations at organization level
57
58
  */
58
- export declare function useListIntegrationConfigsOrgQuery(props: ListIntegrationConfigsOrgProps, options?: Omit<UseQueryOptions<ListIntegrationConfigsOrgOkResponse, ListIntegrationConfigsOrgErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ListIntegrationConfigsOrgOkResponse, unknown>;
59
+ export declare function useListIntegrationConfigsOrgQuery(props: ListIntegrationConfigsOrgProps, options?: Omit<UseQueryOptions<ListIntegrationConfigsOrgOkResponse, ListIntegrationConfigsOrgErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ListIntegrationConfigsOrgOkResponse, ApierrorsErrorResponse>;
@@ -1,5 +1,6 @@
1
1
  import { UseQueryOptions } from '@tanstack/react-query';
2
2
  import type { TypesIntegrationConfig } from '../schemas/TypesIntegrationConfig';
3
+ import type { ApierrorsErrorResponse } from '../schemas/ApierrorsErrorResponse';
3
4
  import type { EnumIntegrationType } from '../schemas/EnumIntegrationType';
4
5
  import type { ResponseWithPagination } from '../helpers';
5
6
  import { FetcherOptions } from '../../../../fetcher/index.js';
@@ -19,7 +20,7 @@ export interface ListIntegrationConfigsProjectQueryQueryParams {
19
20
  */
20
21
  searchterm?: string;
21
22
  /**
22
- * Maximum number of items to return. Defaults to 50 when omitted.
23
+ * Maximum number of items to return. Defaults to 50 when omitted. Maximum allowed is 200.
23
24
  */
24
25
  limit?: number;
25
26
  /**
@@ -48,7 +49,7 @@ export interface ListIntegrationConfigsProjectQueryQueryParams {
48
49
  enabled?: boolean | null;
49
50
  }
50
51
  export type ListIntegrationConfigsProjectOkResponse = ResponseWithPagination<TypesIntegrationConfig[]>;
51
- export type ListIntegrationConfigsProjectErrorResponse = unknown;
52
+ export type ListIntegrationConfigsProjectErrorResponse = ApierrorsErrorResponse;
52
53
  export interface ListIntegrationConfigsProjectProps extends ListIntegrationConfigsProjectQueryPathParams, Omit<FetcherOptions<ListIntegrationConfigsProjectQueryQueryParams, unknown>, 'url'> {
53
54
  queryParams: ListIntegrationConfigsProjectQueryQueryParams;
54
55
  }
@@ -56,4 +57,4 @@ export declare function listIntegrationConfigsProject(props: ListIntegrationConf
56
57
  /**
57
58
  * List integration configurations at project level
58
59
  */
59
- export declare function useListIntegrationConfigsProjectQuery(props: ListIntegrationConfigsProjectProps, options?: Omit<UseQueryOptions<ListIntegrationConfigsProjectOkResponse, ListIntegrationConfigsProjectErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ListIntegrationConfigsProjectOkResponse, unknown>;
60
+ export declare function useListIntegrationConfigsProjectQuery(props: ListIntegrationConfigsProjectProps, options?: Omit<UseQueryOptions<ListIntegrationConfigsProjectOkResponse, ListIntegrationConfigsProjectErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ListIntegrationConfigsProjectOkResponse, ApierrorsErrorResponse>;
@@ -1,5 +1,6 @@
1
1
  import { UseQueryOptions } from '@tanstack/react-query';
2
2
  import type { TypesIntegrationConfig } from '../schemas/TypesIntegrationConfig';
3
+ import type { ApierrorsErrorResponse } from '../schemas/ApierrorsErrorResponse';
3
4
  import type { EnumIntegrationType } from '../schemas/EnumIntegrationType';
4
5
  import type { ResponseWithPagination } from '../helpers';
5
6
  import { FetcherOptions } from '../../../../fetcher/index.js';
@@ -17,7 +18,7 @@ export interface ListIntegrationConfigsQueryQueryParams {
17
18
  */
18
19
  searchterm?: string;
19
20
  /**
20
- * Maximum number of items to return. Defaults to 50 when omitted.
21
+ * Maximum number of items to return. Defaults to 50 when omitted. Maximum allowed is 200.
21
22
  */
22
23
  limit?: number;
23
24
  /**
@@ -44,9 +45,13 @@ export interface ListIntegrationConfigsQueryQueryParams {
44
45
  * When set, filters integrations by enabled state (true = enabled only, false = disabled only). Omit to return all integrations regardless of enabled state.
45
46
  */
46
47
  enabled?: boolean | null;
48
+ /**
49
+ * Repeatable query param; each value is a JSON object with id and scope fields (maximum 200). Account-level list route only; each ref scope may be any path within the caller account (account, org, or project). Refs mode is independent of all other list params. Returns 400 for malformed refs, out-of-account scopes, or too many refs. Returns 200 with all matched configs or an empty array when any ref is missing.
50
+ */
51
+ integration_refs?: string[];
47
52
  }
48
53
  export type ListIntegrationConfigsOkResponse = ResponseWithPagination<TypesIntegrationConfig[]>;
49
- export type ListIntegrationConfigsErrorResponse = unknown;
54
+ export type ListIntegrationConfigsErrorResponse = ApierrorsErrorResponse;
50
55
  export interface ListIntegrationConfigsProps extends ListIntegrationConfigsQueryPathParams, Omit<FetcherOptions<ListIntegrationConfigsQueryQueryParams, unknown>, 'url'> {
51
56
  queryParams: ListIntegrationConfigsQueryQueryParams;
52
57
  }
@@ -54,4 +59,4 @@ export declare function listIntegrationConfigs(props: ListIntegrationConfigsProp
54
59
  /**
55
60
  * List integration configurations
56
61
  */
57
- export declare function useListIntegrationConfigsQuery(props: ListIntegrationConfigsProps, options?: Omit<UseQueryOptions<ListIntegrationConfigsOkResponse, ListIntegrationConfigsErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ListIntegrationConfigsOkResponse, unknown>;
62
+ export declare function useListIntegrationConfigsQuery(props: ListIntegrationConfigsProps, options?: Omit<UseQueryOptions<ListIntegrationConfigsOkResponse, ListIntegrationConfigsErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ListIntegrationConfigsOkResponse, ApierrorsErrorResponse>;
@@ -261,6 +261,7 @@ export type { TypesCorrelationMapping } from './schemas/TypesCorrelationMapping'
261
261
  export type { TypesDefaultAirbyteStreamSettings } from './schemas/TypesDefaultAirbyteStreamSettings';
262
262
  export type { TypesDefaultEntityRelation } from './schemas/TypesDefaultEntityRelation';
263
263
  export type { TypesDefaultEntitySchema } from './schemas/TypesDefaultEntitySchema';
264
+ export type { TypesDefaultFieldMapping } from './schemas/TypesDefaultFieldMapping';
264
265
  export type { TypesDefaultKind } from './schemas/TypesDefaultKind';
265
266
  export type { TypesDefaultMappingField } from './schemas/TypesDefaultMappingField';
266
267
  export type { TypesDefaultRelationEnd } from './schemas/TypesDefaultRelationEnd';
@@ -4,5 +4,6 @@ export interface TypesAirbyteCatalogDiscovered {
4
4
  default_stream_settings?: {
5
5
  [key: string]: TypesDefaultAirbyteStreamSettings;
6
6
  };
7
+ is_default?: boolean;
7
8
  streams?: TypesAirbyteStream[] | null;
8
9
  }
@@ -2,7 +2,7 @@ import type { EnumOperator } from '../schemas/EnumOperator';
2
2
  export interface TypesCorrelationMapping {
3
3
  operator?: EnumOperator;
4
4
  /**
5
- * Required. Immutable.
5
+ * Required. Mutable for HarnessCI after create; immutable for Custom.
6
6
  */
7
7
  source_path?: string;
8
8
  /**
@@ -1,3 +1,4 @@
1
+ import type { TypesDefaultFieldMapping } from '../schemas/TypesDefaultFieldMapping';
1
2
  import type { EnumIntegrationType } from '../schemas/EnumIntegrationType';
2
3
  import type { TypesDefaultKind } from '../schemas/TypesDefaultKind';
3
4
  import type { TypesDefaultEntityRelation } from '../schemas/TypesDefaultEntityRelation';
@@ -7,6 +8,7 @@ export interface TypesDefaultEntitySchema {
7
8
  [key: string]: any;
8
9
  } | null;
9
10
  created?: number;
11
+ default_field_mappings?: TypesDefaultFieldMapping[];
10
12
  integration_type?: EnumIntegrationType;
11
13
  kinds?: {
12
14
  [key: string]: TypesDefaultKind;
@@ -0,0 +1,5 @@
1
+ export interface TypesDefaultFieldMapping {
2
+ required?: boolean;
3
+ source_field?: string;
4
+ target_field?: string;
5
+ }
@@ -0,0 +1,4 @@
1
+ /* eslint-disable */
2
+ // This code is autogenerated using @harnessio/oats-cli.
3
+ // Please do not modify this code directly.
4
+ export {};
@@ -1,4 +1,6 @@
1
+ import type { TypesDefaultFieldMapping } from '../schemas/TypesDefaultFieldMapping';
1
2
  import type { TypesKindMappingFields } from '../schemas/TypesKindMappingFields';
2
3
  export interface TypesListDefaultMappingFieldsResponse {
4
+ default_mappings?: TypesDefaultFieldMapping[];
3
5
  mapping_fields?: TypesKindMappingFields[] | null;
4
6
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@harnessio/react-integration-manager-client",
3
- "version": "0.8.2",
3
+ "version": "0.8.4",
4
4
  "description": "Harness React integration manager client - Integration Manager APIs integrated with react hooks",
5
5
  "author": "Harness Inc",
6
6
  "license": "MIT",