@onkernel/sdk 0.24.0 → 0.25.0

package/src/resources/credentials.ts

@@ -9,8 +9,7 @@ import { path } from '../internal/utils/path';
 
 export class Credentials extends APIResource {
   /**
-   * Create a new credential for storing login information. Values are encrypted at
-   * rest.
+   * Create a new credential for storing login information.
    *
    * @example
    * ```ts
@@ -29,27 +28,32 @@ export class Credentials extends APIResource {
   }
 
   /**
-   * Retrieve a credential by its ID. Credential values are not returned.
+   * Retrieve a credential by its ID or name. Credential values are not returned.
    *
    * @example
    * ```ts
-   * const credential = await client.credentials.retrieve('id');
+   * const credential = await client.credentials.retrieve(
+   *   'id_or_name',
+   * );
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<Credential> {
-    return this._client.get(path`/credentials/${id}`, options);
+  retrieve(idOrName: string, options?: RequestOptions): APIPromise<Credential> {
+    return this._client.get(path`/credentials/${idOrName}`, options);
   }
 
   /**
-   * Update a credential's name or values. Values are encrypted at rest.
+   * Update a credential's name or values. When values are provided, they are merged
+   * with existing values (new keys are added, existing keys are overwritten).
    *
    * @example
    * ```ts
-   * const credential = await client.credentials.update('id');
+   * const credential = await client.credentials.update(
+   *   'id_or_name',
+   * );
    * ```
    */
-  update(id: string, body: CredentialUpdateParams, options?: RequestOptions): APIPromise<Credential> {
-    return this._client.patch(path`/credentials/${id}`, { body, ...options });
+  update(idOrName: string, body: CredentialUpdateParams, options?: RequestOptions): APIPromise<Credential> {
+    return this._client.patch(path`/credentials/${idOrName}`, { body, ...options });
   }
 
   /**
@@ -72,19 +76,35 @@ export class Credentials extends APIResource {
   }
 
   /**
-   * Delete a credential by its ID.
+   * Delete a credential by its ID or name.
    *
    * @example
    * ```ts
-   * await client.credentials.delete('id');
+   * await client.credentials.delete('id_or_name');
    * ```
    */
-  delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/credentials/${id}`, {
+  delete(idOrName: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/credentials/${idOrName}`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
+
+  /**
+   * Returns the current 6-digit TOTP code for a credential with a configured
+   * totp_secret. Use this to complete 2FA setup on sites or when you need a fresh
+   * code.
+   *
+   * @example
+   * ```ts
+   * const response = await client.credentials.totpCode(
+   *   'id_or_name',
+   * );
+   * ```
+   */
+  totpCode(idOrName: string, options?: RequestOptions): APIPromise<CredentialTotpCodeResponse> {
+    return this._client.get(path`/credentials/${idOrName}/totp-code`, options);
+  }
 }
 
 export type CredentialsOffsetPagination = OffsetPagination<Credential>;
@@ -107,6 +127,20 @@ export interface CreateCredentialRequest {
    * Field name to value mapping (e.g., username, password)
    */
   values: { [key: string]: string };
+
+  /**
+   * If set, indicates this credential should be used with the specified SSO provider
+   * (e.g., google, github, microsoft). When the target site has a matching SSO
+   * button, it will be clicked first before filling credential values on the
+   * identity provider's login page.
+   */
+  sso_provider?: string;
+
+  /**
+   * Base32-encoded TOTP secret for generating one-time passwords. Used for automatic
+   * 2FA during login.
+   */
+  totp_secret?: string;
 }
 
 /**
@@ -137,6 +171,30 @@ export interface Credential {
    * When the credential was last updated
    */
   updated_at: string;
+
+  /**
+   * Whether this credential has a TOTP secret configured for automatic 2FA
+   */
+  has_totp_secret?: boolean;
+
+  /**
+   * If set, indicates this credential should be used with the specified SSO provider
+   * (e.g., google, github, microsoft). When the target site has a matching SSO
+   * button, it will be clicked first before filling credential values on the
+   * identity provider's login page.
+   */
+  sso_provider?: string | null;
+
+  /**
+   * Current 6-digit TOTP code. Only included in create/update responses when
+   * totp_secret was just set.
+   */
+  totp_code?: string;
+
+  /**
+   * When the totp_code expires. Only included when totp_code is present.
+   */
+  totp_code_expires_at?: string;
 }
 
 /**
@@ -149,12 +207,36 @@ export interface UpdateCredentialRequest {
   name?: string;
 
   /**
-   * Field name to value mapping (e.g., username, password). Replaces all existing
-   * values.
+   * If set, indicates this credential should be used with the specified SSO
+   * provider. Set to empty string or null to remove.
+   */
+  sso_provider?: string | null;
+
+  /**
+   * Base32-encoded TOTP secret for generating one-time passwords. Spaces and
+   * formatting are automatically normalized. Set to empty string to remove.
+   */
+  totp_secret?: string;
+
+  /**
+   * Field name to value mapping. Values are merged with existing values (new keys
+   * added, existing keys overwritten).
    */
   values?: { [key: string]: string };
 }
 
+export interface CredentialTotpCodeResponse {
+  /**
+   * Current 6-digit TOTP code
+   */
+  code: string;
+
+  /**
+   * When this code expires (ISO 8601 timestamp)
+   */
+  expires_at: string;
+}
+
 export interface CredentialCreateParams {
   /**
    * Target domain this credential is for
@@ -170,6 +252,20 @@ export interface CredentialCreateParams {
    * Field name to value mapping (e.g., username, password)
    */
   values: { [key: string]: string };
+
+  /**
+   * If set, indicates this credential should be used with the specified SSO provider
+   * (e.g., google, github, microsoft). When the target site has a matching SSO
+   * button, it will be clicked first before filling credential values on the
+   * identity provider's login page.
+   */
+  sso_provider?: string;
+
+  /**
+   * Base32-encoded TOTP secret for generating one-time passwords. Used for automatic
+   * 2FA during login.
+   */
+  totp_secret?: string;
 }
 
 export interface CredentialUpdateParams {
@@ -179,8 +275,20 @@ export interface CredentialUpdateParams {
   name?: string;
 
   /**
-   * Field name to value mapping (e.g., username, password). Replaces all existing
-   * values.
+   * If set, indicates this credential should be used with the specified SSO
+   * provider. Set to empty string or null to remove.
+   */
+  sso_provider?: string | null;
+
+  /**
+   * Base32-encoded TOTP secret for generating one-time passwords. Spaces and
+   * formatting are automatically normalized. Set to empty string to remove.
+   */
+  totp_secret?: string;
+
+  /**
+   * Field name to value mapping. Values are merged with existing values (new keys
+   * added, existing keys overwritten).
    */
   values?: { [key: string]: string };
 }
@@ -197,6 +305,7 @@ export declare namespace Credentials {
     type CreateCredentialRequest as CreateCredentialRequest,
     type Credential as Credential,
     type UpdateCredentialRequest as UpdateCredentialRequest,
+    type CredentialTotpCodeResponse as CredentialTotpCodeResponse,
     type CredentialsOffsetPagination as CredentialsOffsetPagination,
     type CredentialCreateParams as CredentialCreateParams,
     type CredentialUpdateParams as CredentialUpdateParams,

package/src/resources/index.ts

@@ -37,6 +37,7 @@ export {
   type CreateCredentialRequest,
   type Credential,
   type UpdateCredentialRequest,
+  type CredentialTotpCodeResponse,
   type CredentialCreateParams,
   type CredentialUpdateParams,
   type CredentialListParams,
@@ -81,5 +82,6 @@ export {
   type ProxyCreateResponse,
   type ProxyRetrieveResponse,
   type ProxyListResponse,
+  type ProxyCheckResponse,
   type ProxyCreateParams,
 } from './proxies';

package/src/resources/proxies.ts

@@ -37,6 +37,13 @@ export class Proxies extends APIResource {
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
+
+  /**
+   * Run a health check on the proxy to verify it's working.
+   */
+  check(id: string, options?: RequestOptions): APIPromise<ProxyCheckResponse> {
+    return this._client.post(path`/proxies/${id}/check`, options);
+  }
 }
 
 /**
@@ -703,6 +710,226 @@ export namespace ProxyListResponse {
   }
 }
 
+/**
+ * Configuration for routing traffic through a proxy.
+ */
+export interface ProxyCheckResponse {
+  /**
+   * Proxy type to use. In terms of quality for avoiding bot-detection, from best to
+   * worst: `mobile` > `residential` > `isp` > `datacenter`.
+   */
+  type: 'datacenter' | 'isp' | 'residential' | 'mobile' | 'custom';
+
+  id?: string;
+
+  /**
+   * Configuration specific to the selected proxy `type`.
+   */
+  config?:
+    | ProxyCheckResponse.DatacenterProxyConfig
+    | ProxyCheckResponse.IspProxyConfig
+    | ProxyCheckResponse.ResidentialProxyConfig
+    | ProxyCheckResponse.MobileProxyConfig
+    | ProxyCheckResponse.CustomProxyConfig;
+
+  /**
+   * Timestamp of the last health check performed on this proxy.
+   */
+  last_checked?: string;
+
+  /**
+   * Readable name of the proxy.
+   */
+  name?: string;
+
+  /**
+   * Protocol to use for the proxy connection.
+   */
+  protocol?: 'http' | 'https';
+
+  /**
+   * Current health status of the proxy.
+   */
+  status?: 'available' | 'unavailable';
+}
+
+export namespace ProxyCheckResponse {
+  /**
+   * Configuration for a datacenter proxy.
+   */
+  export interface DatacenterProxyConfig {
+    /**
+     * ISO 3166 country code. Defaults to US if not provided.
+     */
+    country?: string;
+  }
+
+  /**
+   * Configuration for an ISP proxy.
+   */
+  export interface IspProxyConfig {
+    /**
+     * ISO 3166 country code. Defaults to US if not provided.
+     */
+    country?: string;
+  }
+
+  /**
+   * Configuration for residential proxies.
+   */
+  export interface ResidentialProxyConfig {
+    /**
+     * Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
+     */
+    asn?: string;
+
+    /**
+     * City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
+     * provided.
+     */
+    city?: string;
+
+    /**
+     * ISO 3166 country code.
+     */
+    country?: string;
+
+    /**
+     * @deprecated Operating system of the residential device.
+     */
+    os?: 'windows' | 'macos' | 'android';
+
+    /**
+     * Two-letter state code.
+     */
+    state?: string;
+
+    /**
+     * US ZIP code.
+     */
+    zip?: string;
+  }
+
+  /**
+   * Configuration for mobile proxies.
+   */
+  export interface MobileProxyConfig {
+    /**
+     * Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
+     */
+    asn?: string;
+
+    /**
+     * Mobile carrier.
+     */
+    carrier?:
+      | 'a1'
+      | 'aircel'
+      | 'airtel'
+      | 'att'
+      | 'celcom'
+      | 'chinamobile'
+      | 'claro'
+      | 'comcast'
+      | 'cox'
+      | 'digi'
+      | 'dt'
+      | 'docomo'
+      | 'dtac'
+      | 'etisalat'
+      | 'idea'
+      | 'kyivstar'
+      | 'meo'
+      | 'megafon'
+      | 'mtn'
+      | 'mtnza'
+      | 'mts'
+      | 'optus'
+      | 'orange'
+      | 'qwest'
+      | 'reliance_jio'
+      | 'robi'
+      | 'sprint'
+      | 'telefonica'
+      | 'telstra'
+      | 'tmobile'
+      | 'tigo'
+      | 'tim'
+      | 'verizon'
+      | 'vimpelcom'
+      | 'vodacomza'
+      | 'vodafone'
+      | 'vivo'
+      | 'zain'
+      | 'vivabo'
+      | 'telenormyanmar'
+      | 'kcelljsc'
+      | 'swisscom'
+      | 'singtel'
+      | 'asiacell'
+      | 'windit'
+      | 'cellc'
+      | 'ooredoo'
+      | 'drei'
+      | 'umobile'
+      | 'cableone'
+      | 'proximus'
+      | 'tele2'
+      | 'mobitel'
+      | 'o2'
+      | 'bouygues'
+      | 'free'
+      | 'sfr'
+      | 'digicel';
+
+    /**
+     * City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
+     * provided.
+     */
+    city?: string;
+
+    /**
+     * ISO 3166 country code
+     */
+    country?: string;
+
+    /**
+     * Two-letter state code.
+     */
+    state?: string;
+
+    /**
+     * US ZIP code.
+     */
+    zip?: string;
+  }
+
+  /**
+   * Configuration for a custom proxy (e.g., private proxy server).
+   */
+  export interface CustomProxyConfig {
+    /**
+     * Proxy host address or IP.
+     */
+    host: string;
+
+    /**
+     * Proxy port.
+     */
+    port: number;
+
+    /**
+     * Whether the proxy has a password.
+     */
+    has_password?: boolean;
+
+    /**
+     * Username for proxy authentication.
+     */
+    username?: string;
+  }
+}
+
 export interface ProxyCreateParams {
   /**
    * Proxy type to use. In terms of quality for avoiding bot-detection, from best to
@@ -913,6 +1140,7 @@ export declare namespace Proxies {
     type ProxyCreateResponse as ProxyCreateResponse,
     type ProxyRetrieveResponse as ProxyRetrieveResponse,
     type ProxyListResponse as ProxyListResponse,
+    type ProxyCheckResponse as ProxyCheckResponse,
     type ProxyCreateParams as ProxyCreateParams,
   };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.24.0'; // x-release-please-version
+export const VERSION = '0.25.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.24.0";
+export declare const VERSION = "0.25.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.24.0";
+export declare const VERSION = "0.25.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.24.0'; // x-release-please-version
+exports.VERSION = '0.25.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.24.0'; // x-release-please-version
+export const VERSION = '0.25.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map