postgrid-node 0.1.0-alpha.5 → 0.2.0

package/src/resources/print-mail/sub-organizations.ts

@@ -0,0 +1,394 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as SubOrganizationsAPI from './sub-organizations';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class SubOrganizations extends APIResource {
+  /**
+   * Get a sub-organization.
+   *
+   * @example
+   * ```ts
+   * const subOrganization =
+   *   await client.printMail.subOrganizations.retrieve('id');
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<SubOrganization> {
+    return this._client.get(path`/print-mail/v1/sub_organizations/${id}`, options);
+  }
+
+  /**
+   * When creating a user through the API, the verifiedEmail field will automatically
+   * be set to true. However, if public signups are used, the email will need to be
+   * verified by the user.
+   *
+   * @example
+   * ```ts
+   * const subOrganization =
+   *   await client.printMail.subOrganizations.update({
+   *     countryCode: 'CA',
+   *     email: 'suborg@postgrid.com',
+   *     name: 'Calvin',
+   *     organizationName: 'PostGrid',
+   *     password: 'very-strong-password',
+   *     phoneNumber: '9059059059',
+   *   });
+   * ```
+   */
+  update(
+    body: SubOrganizationUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<SubOrganizationUpdateResponse> {
+    return this._client.post('/print-mail/v1/sub_organizations', { body, ...options });
+  }
+
+  /**
+   * List sub-organizations.
+   *
+   * @example
+   * ```ts
+   * const subOrganizations =
+   *   await client.printMail.subOrganizations.list();
+   * ```
+   */
+  list(
+    query: SubOrganizationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SubOrganizationListResponse> {
+    return this._client.get('/print-mail/v1/sub_organizations', { query, ...options });
+  }
+
+  /**
+   * List users for a sub-organization.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.printMail.subOrganizations.retrieveUsers(
+   *     'id',
+   *   );
+   * ```
+   */
+  retrieveUsers(
+    id: string,
+    query: SubOrganizationRetrieveUsersParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SubOrganizationRetrieveUsersResponse> {
+    return this._client.get(path`/print-mail/v1/sub_organizations/${id}/users`, { query, ...options });
+  }
+}
+
+/**
+ * A set of preferences for how a user should receive emails.
+ */
+export interface EmailPreferences {
+  /**
+   * The list of preferences for receiving order preview emails.
+   */
+  orderPreviewSendPreference?: 'do_not_send' | 'send_live_only' | 'send_live_and_test';
+}
+
+/**
+ * The Sub-Organization object.
+ */
+export interface SubOrganization {
+  /**
+   * A unique ID prefixed with `sub_org_`.
+   */
+  id: string;
+
+  /**
+   * The country code of the sub-organization.
+   */
+  countryCode: string;
+
+  /**
+   * The UTC time at which this resource was created.
+   */
+  createdAt: string;
+
+  /**
+   * The limit of mailings the sub-organization can send before being charged
+   * overages for the month.
+   */
+  limit: number;
+
+  /**
+   * The name of the sub-organization.
+   */
+  name: string;
+
+  /**
+   * Always `sub_org`.
+   */
+  object: 'sub_org';
+
+  /**
+   * The current rolling charge for the sub-organization for the month, in cents.
+   */
+  spend: number;
+
+  /**
+   * The UTC time at which this resource was last update.
+   */
+  updatedAt: string;
+
+  /**
+   * The amount of mail the sub-organization has sent out this month.
+   */
+  usage: number;
+}
+
+export interface SubOrganizationUpdateResponse {
+  /**
+   * The Sub-Organization object.
+   */
+  subOrganization: SubOrganization;
+
+  /**
+   * The user object.
+   */
+  user: SubOrganizationUpdateResponse.User;
+}
+
+export namespace SubOrganizationUpdateResponse {
+  /**
+   * The user object.
+   */
+  export interface User {
+    /**
+     * A unique ID prefixed with `user_`.
+     */
+    id: string;
+
+    /**
+     * The user's API keys. Contains live and test mode API keys.
+     */
+    apiKeys: Array<User.APIKey>;
+
+    /**
+     * The email of the user.
+     */
+    email: string;
+
+    /**
+     * The name of the user.
+     */
+    name: string;
+
+    /**
+     * A unique ID prefixed with `user_`.
+     */
+    organization: string;
+
+    /**
+     * Indicates if the user has a pending invite.
+     */
+    pendingInvite: boolean;
+
+    /**
+     * The roles given to the user. Roles can be used to restrict access for users.
+     */
+    roles: Array<string>;
+
+    /**
+     * Indicates if the user has a verified email or not.
+     */
+    verifiedEmail: boolean;
+
+    /**
+     * A set of preferences for how a user should receive emails.
+     */
+    emailPreferences?: SubOrganizationsAPI.EmailPreferences;
+
+    /**
+     * The date and time at which the user last logged in.
+     */
+    lastLoginTime?: string;
+
+    /**
+     * The phone number of the user.
+     */
+    phoneNumber?: string;
+
+    /**
+     * A list of emails the user has previously had. If a user has changed their email
+     * before, this list will be populated with all of the emails they once had.
+     */
+    previousEmails?: Array<string>;
+  }
+
+  export namespace User {
+    /**
+     * An API key.
+     */
+    export interface APIKey {
+      /**
+       * The value of the API key.
+       */
+      value: string;
+
+      /**
+       * An optional date which the API key is active until. After this date, the API key
+       * will no longer be valid.
+       */
+      activeUntil?: string;
+    }
+  }
+}
+
+export interface SubOrganizationListResponse {
+  data: Array<SubOrganization>;
+
+  limit: number;
+
+  object: 'list';
+
+  skip: number;
+
+  totalCount: number;
+}
+
+export type SubOrganizationRetrieveUsersResponse =
+  Array<SubOrganizationRetrieveUsersResponse.SubOrganizationRetrieveUsersResponseItem>;
+
+export namespace SubOrganizationRetrieveUsersResponse {
+  /**
+   * The user object.
+   */
+  export interface SubOrganizationRetrieveUsersResponseItem {
+    /**
+     * A unique ID prefixed with `user_`.
+     */
+    id: string;
+
+    /**
+     * The email of the user.
+     */
+    email: string;
+
+    /**
+     * The name of the user.
+     */
+    name: string;
+
+    /**
+     * A unique ID prefixed with `user_`.
+     */
+    organization: string;
+
+    /**
+     * Indicates if the user has a pending invite.
+     */
+    pendingInvite: boolean;
+
+    /**
+     * The roles given to the user. Roles can be used to restrict access for users.
+     */
+    roles: Array<string>;
+
+    /**
+     * Indicates if the user has a verified email or not.
+     */
+    verifiedEmail: boolean;
+
+    /**
+     * A set of preferences for how a user should receive emails.
+     */
+    emailPreferences?: SubOrganizationsAPI.EmailPreferences;
+
+    /**
+     * The date and time at which the user last logged in.
+     */
+    lastLoginTime?: string;
+
+    /**
+     * The phone number of the user.
+     */
+    phoneNumber?: string;
+
+    /**
+     * A list of emails the user has previously had. If a user has changed their email
+     * before, this list will be populated with all of the emails they once had.
+     */
+    previousEmails?: Array<string>;
+  }
+}
+
+export interface SubOrganizationUpdateParams {
+  /**
+   * The country code of the sub-organization.
+   */
+  countryCode: string;
+
+  /**
+   * The email of the user to be created alongside the sub-organization.
+   */
+  email: string;
+
+  /**
+   * The name of the user to be created alongside the sub-organization.
+   */
+  name: string;
+
+  /**
+   * The name of the sub-organization.
+   */
+  organizationName: string;
+
+  /**
+   * The password of the user to be created alongside the sub-organization.
+   */
+  password: string;
+
+  /**
+   * The phone number of the user to be created alongside the sub-organization.
+   */
+  phoneNumber?: string;
+}
+
+export interface SubOrganizationListParams {
+  limit?: number;
+
+  /**
+   * You can supply any string to help narrow down the list of resources. For
+   * example, if you pass `"New York"` (quoted), it will return resources that have
+   * that string present somewhere in their response. Alternatively, you can supply a
+   * structured search query. See the documentation on `StructuredSearchQuery` for
+   * more details.
+   */
+  search?: string;
+
+  skip?: number;
+}
+
+export interface SubOrganizationRetrieveUsersParams {
+  limit?: number;
+
+  /**
+   * You can supply any string to help narrow down the list of resources. For
+   * example, if you pass `"New York"` (quoted), it will return resources that have
+   * that string present somewhere in their response. Alternatively, you can supply a
+   * structured search query. See the documentation on `StructuredSearchQuery` for
+   * more details.
+   */
+  search?: string;
+
+  skip?: number;
+}
+
+export declare namespace SubOrganizations {
+  export {
+    type EmailPreferences as EmailPreferences,
+    type SubOrganization as SubOrganization,
+    type SubOrganizationUpdateResponse as SubOrganizationUpdateResponse,
+    type SubOrganizationListResponse as SubOrganizationListResponse,
+    type SubOrganizationRetrieveUsersResponse as SubOrganizationRetrieveUsersResponse,
+    type SubOrganizationUpdateParams as SubOrganizationUpdateParams,
+    type SubOrganizationListParams as SubOrganizationListParams,
+    type SubOrganizationRetrieveUsersParams as SubOrganizationRetrieveUsersParams,
+  };
+}

package/src/resources/print-mail/templates.ts

@@ -0,0 +1,216 @@
+// 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 Templates extends APIResource {
+  /**
+   * Create a template. Note that if you want to create a template that works with
+   * our template editor, you must use our dashboard.
+   *
+   * @example
+   * ```ts
+   * const template = await client.printMail.templates.create({
+   *   description: 'Test',
+   *   html: '<b>Hello</b> {{to.firstName}}',
+   * });
+   * ```
+   */
+  create(body: TemplateCreateParams, options?: RequestOptions): APIPromise<Template> {
+    return this._client.post('/print-mail/v1/templates', { body, ...options });
+  }
+
+  /**
+   * Retrieve a template by ID.
+   *
+   * @example
+   * ```ts
+   * const template = await client.printMail.templates.retrieve(
+   *   'id',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Template> {
+    return this._client.get(path`/print-mail/v1/templates/${id}`, options);
+  }
+
+  /**
+   * Update a template by ID.
+   *
+   * @example
+   * ```ts
+   * const template = await client.printMail.templates.update(
+   *   'id',
+   *   {
+   *     description: 'Test',
+   *     html: '<b>Hello</b> {{to.firstName}}!',
+   *   },
+   * );
+   * ```
+   */
+  update(id: string, body: TemplateUpdateParams, options?: RequestOptions): APIPromise<Template> {
+    return this._client.post(path`/print-mail/v1/templates/${id}`, { body, ...options });
+  }
+
+  /**
+   * Get a list of templates.
+   *
+   * @example
+   * ```ts
+   * const templates = await client.printMail.templates.list();
+   * ```
+   */
+  list(
+    query: TemplateListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<TemplateListResponse> {
+    return this._client.get('/print-mail/v1/templates', { query, ...options });
+  }
+
+  /**
+   * Delete a template by ID. Note that this operation cannot be undone.
+   *
+   * @example
+   * ```ts
+   * const template = await client.printMail.templates.delete(
+   *   'id',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<TemplateDeleteResponse> {
+    return this._client.delete(path`/print-mail/v1/templates/${id}`, options);
+  }
+}
+
+export interface Template {
+  /**
+   * A unique ID prefixed with template\_
+   */
+  id: string;
+
+  /**
+   * The UTC time at which this resource was created.
+   */
+  createdAt: string;
+
+  /**
+   * `true` if this is a live mode resource else `false`.
+   */
+  live: boolean;
+
+  /**
+   * Always `template`.
+   */
+  object: 'template';
+
+  /**
+   * The UTC time at which this resource was last updated.
+   */
+  updatedAt: string;
+
+  /**
+   * An optional string describing this resource. Will be visible in the API and the
+   * dashboard.
+   */
+  description?: string;
+
+  /**
+   * The HTML content of this template.
+   */
+  html?: string;
+
+  /**
+   * See the section on Metadata.
+   */
+  metadata?: { [key: string]: unknown };
+}
+
+export interface TemplateListResponse {
+  data: Array<Template>;
+
+  limit: number;
+
+  object: 'list';
+
+  skip: number;
+
+  totalCount: number;
+}
+
+export interface TemplateDeleteResponse {
+  /**
+   * A unique ID prefixed with template\_
+   */
+  id: string;
+
+  deleted: true;
+
+  /**
+   * Always `template`.
+   */
+  object: 'template';
+}
+
+export interface TemplateCreateParams {
+  /**
+   * An optional string describing this resource. Will be visible in the API and the
+   * dashboard.
+   */
+  description?: string;
+
+  /**
+   * The HTML content of this template.
+   */
+  html?: string;
+
+  /**
+   * See the section on Metadata.
+   */
+  metadata?: { [key: string]: unknown };
+}
+
+export interface TemplateUpdateParams {
+  /**
+   * An optional string describing this resource. Will be visible in the API and the
+   * dashboard.
+   */
+  description?: string;
+
+  /**
+   * The HTML content of this template.
+   */
+  html?: string;
+
+  /**
+   * See the section on Metadata.
+   */
+  metadata?: { [key: string]: unknown };
+}
+
+export interface TemplateListParams {
+  limit?: number;
+
+  /**
+   * You can supply any string to help narrow down the list of resources. For
+   * example, if you pass `"New York"` (quoted), it will return resources that have
+   * that string present somewhere in their response. Alternatively, you can supply a
+   * structured search query. See the documentation on `StructuredSearchQuery` for
+   * more details.
+   */
+  search?: string;
+
+  skip?: number;
+}
+
+export declare namespace Templates {
+  export {
+    type Template as Template,
+    type TemplateListResponse as TemplateListResponse,
+    type TemplateDeleteResponse as TemplateDeleteResponse,
+    type TemplateCreateParams as TemplateCreateParams,
+    type TemplateUpdateParams as TemplateUpdateParams,
+    type TemplateListParams as TemplateListParams,
+  };
+}

package/src/resources/print-mail.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './print-mail/index';

package/src/tsconfig.json

@@ -4,8 +4,8 @@
   // via declaration maps
   "include": ["index.ts"],
   "compilerOptions": {
-    "target": "es2015",
-    "lib": ["DOM"],
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
     "moduleResolution": "node"
   }
 }