@codeqr/ts 0.1.2

package/src/resources/domains.ts

@@ -0,0 +1,205 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Domains extends APIResource {
+  /**
+   * Create a domain for the authenticated workspace.
+   *
+   * @example
+   * ```ts
+   * const domain = await client.domains.create({
+   *   slug: 'acme.com',
+   * });
+   * ```
+   */
+  create(body: DomainCreateParams, options?: RequestOptions): APIPromise<Domain> {
+    return this._client.post('/domains', { body, ...options });
+  }
+
+  /**
+   * Update a domain for the authenticated workspace.
+   *
+   * @example
+   * ```ts
+   * const domain = await client.domains.update('acme.com');
+   * ```
+   */
+  update(
+    pathSlug: string,
+    body: DomainUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Domain> {
+    return this._client.patch(path`/domains/${pathSlug}`, { body, ...options });
+  }
+
+  /**
+   * Retrieve a list of domains associated with the authenticated workspace.
+   *
+   * @example
+   * ```ts
+   * const domains = await client.domains.list();
+   * ```
+   */
+  list(
+    query: DomainListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DomainListResponse> {
+    return this._client.get('/domains', { query, ...options });
+  }
+
+  /**
+   * Delete a domain from a workspace. It cannot be undone. This will also delete all
+   * the links associated with the domain.
+   *
+   * @example
+   * ```ts
+   * const domain = await client.domains.delete('acme.com');
+   * ```
+   */
+  delete(slug: string, options?: RequestOptions): APIPromise<DomainDeleteResponse> {
+    return this._client.delete(path`/domains/${slug}`, options);
+  }
+}
+
+export interface Domain {
+  /**
+   * The unique identifier of the domain.
+   */
+  id: string;
+
+  /**
+   * Whether the domain is archived.
+   */
+  archived: boolean;
+
+  /**
+   * The date the domain was created.
+   */
+  createdAt: string;
+
+  /**
+   * The URL to redirect to when a link under this domain has expired.
+   */
+  expiredUrl: string | null;
+
+  /**
+   * Provide context to your teammates in the link creation modal by showing them an
+   * example of a link to be shortened.
+   */
+  placeholder: string;
+
+  /**
+   * Whether the domain is the primary domain for the project.
+   */
+  primary: boolean;
+
+  /**
+   * The domain name.
+   */
+  slug: string;
+
+  /**
+   * The date the domain was last updated.
+   */
+  updatedAt: string;
+
+  /**
+   * Whether the domain is verified.
+   */
+  verified: boolean;
+}
+
+export type DomainListResponse = Array<Domain>;
+
+export interface DomainDeleteResponse {
+  /**
+   * The domain name.
+   */
+  slug: string;
+}
+
+export interface DomainCreateParams {
+  /**
+   * Name of the domain.
+   */
+  slug: string;
+
+  /**
+   * Whether to archive this domain. `false` will unarchive a previously archived
+   * domain.
+   */
+  archived?: boolean;
+
+  /**
+   * Redirect users to a specific URL when any link under this domain has expired.
+   */
+  expiredUrl?: string | null;
+
+  /**
+   * Provide context to your teammates in the link creation modal by showing them an
+   * example of a link to be shortened.
+   */
+  placeholder?: string | null;
+}
+
+export interface DomainUpdateParams {
+  /**
+   * Whether to archive this domain. `false` will unarchive a previously archived
+   * domain.
+   */
+  archived?: boolean;
+
+  /**
+   * Redirect users to a specific URL when any link under this domain has expired.
+   */
+  expiredUrl?: string | null;
+
+  /**
+   * Provide context to your teammates in the link creation modal by showing them an
+   * example of a link to be shortened.
+   */
+  placeholder?: string | null;
+
+  /**
+   * Name of the domain.
+   */
+  body_slug?: string;
+}
+
+export interface DomainListParams {
+  /**
+   * Whether to include archived domains in the response. Defaults to `false` if not
+   * provided.
+   */
+  archived?: boolean;
+
+  /**
+   * The page number for pagination.
+   */
+  page?: number;
+
+  /**
+   * The number of items per page.
+   */
+  pageSize?: number;
+
+  /**
+   * The search term to filter the domains by.
+   */
+  search?: string;
+}
+
+export declare namespace Domains {
+  export {
+    type Domain as Domain,
+    type DomainListResponse as DomainListResponse,
+    type DomainDeleteResponse as DomainDeleteResponse,
+    type DomainCreateParams as DomainCreateParams,
+    type DomainUpdateParams as DomainUpdateParams,
+    type DomainListParams as DomainListParams,
+  };
+}