@rippling/rippling-sdk 0.2.0-alpha.86 → 0.2.0-alpha.88

package/src/resources/packages/packages.ts

@@ -0,0 +1,329 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as BusinessPartnersAPI from '../business-partners';
+import * as VersionsAPI from './versions';
+import { VersionCreateParams, VersionCreateResponse, Versions } from './versions';
+import { APIPromise } from '../../core/api-promise';
+import { PageCursorURL, PagePromise } from '../../core/pagination';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Author, publish, and install Unity Packages V2 packages
+ */
+export class Packages extends APIResource {
+  versions: VersionsAPI.Versions = new VersionsAPI.Versions(this._client);
+
+  /**
+   * A list of packages.
+   *
+   * - Requires: `Unity Packages V2 Platform API`
+   * - Filterable fields: `package_key`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: PackageListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PackageListResponsesPageCursorURL, PackageListResponse> {
+    return this._client.getAPIList('/packages/', PageCursorURL<PackageListResponse>, { query, ...options });
+  }
+
+  /**
+   * Create a new package
+   */
+  create(body: PackageCreateParams, options?: RequestOptions): APIPromise<PackageCreateResponse> {
+    return this._client.post('/packages/', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific package
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<PackageRetrieveResponse> {
+    return this._client.get(path`/packages/${id}/`, options);
+  }
+
+  /**
+   * Update a specific package.
+   */
+  update(id: string, body: PackageUpdateParams, options?: RequestOptions): APIPromise<PackageUpdateResponse> {
+    return this._client.patch(path`/packages/${id}/`, { body, ...options });
+  }
+
+  /**
+   * Delete a package
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/packages/${id}/`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type PackageListResponsesPageCursorURL = PageCursorURL<PackageListResponse>;
+
+export interface PackageListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The display name of the package
+   */
+  package_display_name: string;
+
+  /**
+   * The unique package key within the publisher company
+   */
+  package_key: string;
+
+  /**
+   * The package type (for example MANAGED or UNMANAGED)
+   */
+  package_type: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The description of the package
+   */
+  description?: string;
+
+  /**
+   * The ID of the latest package version, if any
+   */
+  latest_version_id?: string;
+
+  /**
+   * The version number of the latest package version, if any
+   */
+  latest_version_number?: string;
+}
+
+export interface PackageCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The display name of the package
+   */
+  package_display_name: string;
+
+  /**
+   * The unique package key within the publisher company
+   */
+  package_key: string;
+
+  /**
+   * The package type (for example MANAGED or UNMANAGED)
+   */
+  package_type: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The description of the package
+   */
+  description?: string;
+
+  /**
+   * The ID of the latest package version, if any
+   */
+  latest_version_id?: string;
+
+  /**
+   * The version number of the latest package version, if any
+   */
+  latest_version_number?: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface PackageRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The display name of the package
+   */
+  package_display_name: string;
+
+  /**
+   * The unique package key within the publisher company
+   */
+  package_key: string;
+
+  /**
+   * The package type (for example MANAGED or UNMANAGED)
+   */
+  package_type: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The description of the package
+   */
+  description?: string;
+
+  /**
+   * The ID of the latest package version, if any
+   */
+  latest_version_id?: string;
+
+  /**
+   * The version number of the latest package version, if any
+   */
+  latest_version_number?: string;
+}
+
+export interface PackageUpdateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The display name of the package
+   */
+  package_display_name: string;
+
+  /**
+   * The unique package key within the publisher company
+   */
+  package_key: string;
+
+  /**
+   * The package type (for example MANAGED or UNMANAGED)
+   */
+  package_type: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The description of the package
+   */
+  description?: string;
+
+  /**
+   * The ID of the latest package version, if any
+   */
+  latest_version_id?: string;
+
+  /**
+   * The version number of the latest package version, if any
+   */
+  latest_version_number?: string;
+}
+
+export interface PackageListParams {
+  cursor?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
+export interface PackageCreateParams {
+  /**
+   * The display name of the package
+   */
+  package_display_name: string;
+
+  /**
+   * The unique package key within the publisher company
+   */
+  package_key: string;
+
+  /**
+   * The package type (for example MANAGED or UNMANAGED)
+   */
+  package_type: string;
+
+  /**
+   * The description of the package
+   */
+  description?: string;
+}
+
+export interface PackageUpdateParams {
+  /**
+   * The display name of the package
+   */
+  package_display_name: string;
+
+  /**
+   * The unique package key within the publisher company
+   */
+  package_key: string;
+
+  /**
+   * The package type (for example MANAGED or UNMANAGED)
+   */
+  package_type: string;
+
+  /**
+   * The description of the package
+   */
+  description?: string;
+}
+
+Packages.Versions = Versions;
+
+export declare namespace Packages {
+  export {
+    type PackageListResponse as PackageListResponse,
+    type PackageCreateResponse as PackageCreateResponse,
+    type PackageRetrieveResponse as PackageRetrieveResponse,
+    type PackageUpdateResponse as PackageUpdateResponse,
+    type PackageListResponsesPageCursorURL as PackageListResponsesPageCursorURL,
+    type PackageListParams as PackageListParams,
+    type PackageCreateParams as PackageCreateParams,
+    type PackageUpdateParams as PackageUpdateParams,
+  };
+
+  export {
+    Versions as Versions,
+    type VersionCreateResponse as VersionCreateResponse,
+    type VersionCreateParams as VersionCreateParams,
+  };
+}

package/src/resources/packages/versions.ts

@@ -0,0 +1,98 @@
+// 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';
+
+/**
+ * Author, publish, and install Unity Packages V2 packages
+ */
+export class Versions extends APIResource {
+  /**
+   * Create a new package version.
+   */
+  create(
+    packageKey: string,
+    body: VersionCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<VersionCreateResponse> {
+    return this._client.post(path`/packages/${packageKey}/versions/`, { body, ...options });
+  }
+}
+
+export interface VersionCreateResponse {
+  /**
+   * The semantic version number for this package version
+   */
+  version_number: string;
+
+  /**
+   * The unique identifier of the package version
+   */
+  id?: string;
+
+  /**
+   * Components included in this package version
+   */
+  components?: Array<unknown>;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The description of the package version
+   */
+  description?: string;
+
+  /**
+   * Whether this package version has been published
+   */
+  is_published?: boolean;
+
+  /**
+   * The display name of the parent package
+   */
+  package_display_name?: string;
+
+  /**
+   * The ID of the parent package
+   */
+  package_id?: string;
+
+  /**
+   * The package key of the parent package
+   */
+  package_key?: string;
+
+  /**
+   * Record update date
+   */
+  updated_at?: string;
+}
+
+export interface VersionCreateParams {
+  /**
+   * The semantic version number for this package version
+   */
+  version_number: string;
+
+  /**
+   * Components included in this package version
+   */
+  components?: Array<unknown>;
+
+  /**
+   * The description of the package version
+   */
+  description?: string;
+}
+
+export declare namespace Versions {
+  export {
+    type VersionCreateResponse as VersionCreateResponse,
+    type VersionCreateParams as VersionCreateParams,
+  };
+}

package/src/resources/packages.ts

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

package/src/resources/scheduled-job-assignments.ts

@@ -15,7 +15,7 @@ export class ScheduledJobAssignments extends APIResource {
   /**
    * A list of scheduled job assignments.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Sortable fields: `id`, `created_at`, `updated_at`, `effective_from`
    */
   list(

package/src/resources/schedules.ts

@@ -15,7 +15,7 @@ export class Schedules extends APIResource {
   /**
    * A list of schedules.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Expandable fields: `managers`, `observers`, `members`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */

package/src/resources/shift-assignments.ts

@@ -15,7 +15,7 @@ export class ShiftAssignments extends APIResource {
    * Update custom fields for a shift assignment. The request body should contain a
    * dictionary mapping custom field names to their values.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    *
    * @example
    * ```ts

package/src/resources/shift-inputs.ts

@@ -16,7 +16,7 @@ export class ShiftInputs extends APIResource {
   /**
    * A list of shift inputs.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `name`
    * - Expandable fields: `creator`
    * - Sortable fields: `id`, `created_at`, `updated_at`

package/src/resources/shiftassignments.ts

@@ -15,7 +15,7 @@ export class Shiftassignments extends APIResource {
   /**
    * A list of shift assignments.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `worker_id`, `schedule_id`, `shift_data.start_time`,
    *   `shift_data.end_time`
    * - Expandable fields: `worker`, `schedule`