@rainfall-digital/sdk 0.1.2

package/src/sdk/magic-link.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { magicLinkRequest } from "../funcs/magic-link-request.js";
+import { magicLinkValidate } from "../funcs/magic-link-validate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class MagicLink extends ClientSDK {
+  /**
+   * Request magic link
+   *
+   * @remarks
+   * Generates a magic link for the provided email address, if a user with that email exists.
+   */
+  async request(
+    request: models.MagicLinkRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(magicLinkRequest(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Validate magic link
+   *
+   * @remarks
+   * Validates a magic link token.
+   */
+  async validate(
+    request: models.MagicLinkLogin,
+    security?: operations.AuthMagicLinkValidateCreateSecurity | undefined,
+    options?: RequestOptions,
+  ): Promise<models.Jwt> {
+    return unwrapAsync(magicLinkValidate(
+      this,
+      request,
+      security,
+      options,
+    ));
+  }
+}

package/src/sdk/media.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { mediaCreate } from "../funcs/media-create.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Media extends ClientSDK {
+  /**
+   * Create an image
+   *
+   * @remarks
+   * Create an image resource by providing a file and an optional name.
+   *
+   * The file must be of type image/png or image/jpeg, and cannot exceed 5 MB in size.
+   */
+  async create(
+    security: operations.ImageCreateSecurity,
+    request: models.ImageInput,
+    options?: RequestOptions,
+  ): Promise<models.Image> {
+    return unwrapAsync(mediaCreate(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/merchants.ts

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { merchantsGet } from "../funcs/merchants-get.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Merchants extends ClientSDK {
+  /**
+   * Get merchant
+   *
+   * @remarks
+   * Fetch detailed information about a specific merchant, identified by its slug.
+   */
+  async get(
+    security: operations.MerchantsRetrieveSecurity,
+    request: operations.MerchantsRetrieveRequest,
+    options?: RequestOptions,
+  ): Promise<models.Merchant> {
+    return unwrapAsync(merchantsGet(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/password.ts

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { passwordChange } from "../funcs/password-change.js";
+import { passwordResetConfirm } from "../funcs/password-reset-confirm.js";
+import { passwordReset } from "../funcs/password-reset.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Password extends ClientSDK {
+  /**
+   * Change your password
+   *
+   * @remarks
+   * Changes the account **password** to the given values.
+   */
+  async change(
+    security: operations.AuthPasswordChangeCreateSecurity,
+    request: models.PasswordChange,
+    options?: RequestOptions,
+  ): Promise<models.RestAuthDetail> {
+    return unwrapAsync(passwordChange(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Reset your password
+   *
+   * @remarks
+   * Sends an email to the provided **email** address with a password reset link.
+   */
+  async reset(
+    request: models.PasswordReset,
+    security?: operations.AuthPasswordResetCreateSecurity | undefined,
+    options?: RequestOptions,
+  ): Promise<models.RestAuthDetail> {
+    return unwrapAsync(passwordReset(
+      this,
+      request,
+      security,
+      options,
+    ));
+  }
+
+  /**
+   * Confirm password reset
+   *
+   * @remarks
+   * Confirms the password reset request and sets the new password for the user, using the provided **uid**, **token**, and **new_password**.
+   */
+  async resetConfirm(
+    request: models.PasswordResetConfirm,
+    security?: operations.AuthPasswordResetConfirmCreateSecurity | undefined,
+    options?: RequestOptions,
+  ): Promise<models.RestAuthDetail> {
+    return unwrapAsync(passwordResetConfirm(
+      this,
+      request,
+      security,
+      options,
+    ));
+  }
+}

package/src/sdk/product-events.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { productEventsGet } from "../funcs/product-events-get.js";
+import { productEventsList } from "../funcs/product-events-list.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class ProductEvents extends ClientSDK {
+  /**
+   * Get events
+   *
+   * @remarks
+   * Retrieve a paginated list of product events. Use query parameters like `limit` and `offset` to control the number of results.
+   */
+  async list(
+    security: operations.ProductEventsListSecurity,
+    request?: operations.ProductEventsListRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.PaginatedProductEventList> {
+    return unwrapAsync(productEventsList(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get event
+   *
+   * @remarks
+   * Fetch detailed information about a specific product event, identified by its UUID.
+   */
+  async get(
+    security: operations.ProductEventsRetrieveSecurity,
+    request: operations.ProductEventsRetrieveRequest,
+    options?: RequestOptions,
+  ): Promise<models.ProductEvent> {
+    return unwrapAsync(productEventsGet(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/product-lines.ts

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { productLinesAssignProvisionalProducts } from "../funcs/product-lines-assign-provisional-products.js";
+import { productLinesGet } from "../funcs/product-lines-get.js";
+import { productLinesList } from "../funcs/product-lines-list.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class ProductLines extends ClientSDK {
+  /**
+   * Get product lines
+   *
+   * @remarks
+   * Retrieve a paginated list of all available product lines. Use query parameters like `limit` and `offset` to control the number of results.
+   */
+  async list(
+    security: operations.GetProductLinesSecurity,
+    request?: operations.GetProductLinesRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.PaginatedProductLineRetrieveList> {
+    return unwrapAsync(productLinesList(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get product line
+   *
+   * @remarks
+   * Fetch detailed information about a specific product line, identified by its UUID.
+   */
+  async get(
+    security: operations.GetProductLineSecurity,
+    request: operations.GetProductLineRequest,
+    options?: RequestOptions,
+  ): Promise<models.ProductLineRetrieve> {
+    return unwrapAsync(productLinesGet(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Assign provisional products
+   *
+   * @remarks
+   * Assigns one or more provisional products to a specific `ProductLine`. The provisional products are provided as a list, with each item containing the product's serial number and a dictionary of attribute values keyed bythe attribute slugs defined for the `ProductLine`.
+   */
+  async assignProvisionalProducts(
+    security: operations.ProductLinesAssignProvisionalProductsCreateSecurity,
+    request: operations.ProductLinesAssignProvisionalProductsCreateRequest,
+    options?: RequestOptions,
+  ): Promise<{ [k: string]: any } | undefined> {
+    return unwrapAsync(productLinesAssignProvisionalProducts(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/products.ts

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { productsCreateEvent } from "../funcs/products-create-event.js";
+import { productsFetchById } from "../funcs/products-fetch-by-id.js";
+import { productsGet } from "../funcs/products-get.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Products extends ClientSDK {
+  /**
+   * Get products
+   *
+   * @remarks
+   * Retrieve a paginated list of all products with optional filtering by various criteria. Use `limit` and `offset` to manage pagination, or `updated_at_before`/`updated_at_after` for date-based filtering.
+   */
+  async get(
+    security: operations.GetProductsSecurity,
+    request?: operations.GetProductsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.PaginatedProductList> {
+    return unwrapAsync(productsGet(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get product
+   *
+   * @remarks
+   * Fetch detailed information about a specific product, identified by its UUID.
+   */
+  async fetchById(
+    security: operations.GetProductSecurity,
+    request: operations.GetProductRequest,
+    options?: RequestOptions,
+  ): Promise<models.Product> {
+    return unwrapAsync(productsFetchById(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create product event
+   *
+   * @remarks
+   * Creates a new product event for the specified product.
+   */
+  async createEvent(
+    security: operations.ProductsEventCreateSecurity,
+    request: operations.ProductsEventCreateRequest,
+    options?: RequestOptions,
+  ): Promise<models.ProductEvent> {
+    return unwrapAsync(productsCreateEvent(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/provisional-lines.ts

@@ -0,0 +1,90 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { provisionalLinesCreateProducts } from "../funcs/provisional-lines-create-products.js";
+import { provisionalLinesCreate } from "../funcs/provisional-lines-create.js";
+import { provisionalLinesListProducts } from "../funcs/provisional-lines-list-products.js";
+import { provisionalLinesList } from "../funcs/provisional-lines-list.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class ProvisionalLines extends ClientSDK {
+  /**
+   * List provisional lines
+   *
+   * @remarks
+   * Returns a list of all available provisional lines.<br /><br />Provisional lines represent product lines that are in a preliminary state, allowing for the creation and management of provisional products.
+   */
+  async list(
+    security: operations.GetProvisionalLinesSecurity,
+    request?: operations.GetProvisionalLinesRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.PaginatedProvisionalLineList> {
+    return unwrapAsync(provisionalLinesList(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create Provisional Line
+   *
+   * @remarks
+   * Creates a new provisional line.<br /><br />A provisional line serves as a container for provisional products, allowing for the organization and management of products before they are assigned to their permanent home.
+   */
+  async create(
+    security: operations.CreateProvisionalLineSecurity,
+    request: models.ProvisionalLineInput,
+    options?: RequestOptions,
+  ): Promise<models.ProvisionalLine> {
+    return unwrapAsync(provisionalLinesCreate(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create additional provisional products
+   *
+   * @remarks
+   * Creates additional provisional products for the specified Provisional Line. This endpoint allows for bulk creation of provisional products, which can be later converted into full products.<br /><br  />Returns a success message with the number of products created or an error message if the operation fails.
+   */
+  async createProducts(
+    security: operations.CreateProvisionalProductsSecurity,
+    request: operations.CreateProvisionalProductsRequest,
+    options?: RequestOptions,
+  ): Promise<string> {
+    return unwrapAsync(provisionalLinesCreateProducts(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List products from a provisional line
+   *
+   * @remarks
+   * Returns a list of all products from a provisional line.
+   */
+  async listProducts(
+    security: operations.GetProductsProvisionalLinesSecurity,
+    request: operations.GetProductsProvisionalLinesRequest,
+    options?: RequestOptions,
+  ): Promise<models.PaginatedProvisionalProductListList> {
+    return unwrapAsync(provisionalLinesListProducts(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/provisional-products.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { provisionalProductsGet } from "../funcs/provisional-products-get.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class ProvisionalProducts extends ClientSDK {
+  /**
+   * List all provisional products
+   *
+   * @remarks
+   * This endpoint is DEPRECATED and will be removed in a future release. Please use the `ProvisionalLine` endpoints to retrieve a list of all products in a provisional line. Was previously used to list all provisional products within a provisional line.
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  async get(
+    security: operations.GetProvisionalProductsSecurity,
+    request?: operations.GetProvisionalProductsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.PaginatedProvisionalProductListList> {
+    return unwrapAsync(provisionalProductsGet(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/registration.ts

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { registrationCreate } from "../funcs/registration-create.js";
+import { registrationResendEmailVerification } from "../funcs/registration-resend-email-verification.js";
+import { registrationVerifyEmail } from "../funcs/registration-verify-email.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Registration extends ClientSDK {
+  /**
+   * Register a new user
+   *
+   * @remarks
+   * Creates a new user account with the provided registration details, such as **username**, **email**, and **password**. An email verification link is sent to the provided email address.
+   */
+  async create(
+    request: models.UserRegister,
+    security?: operations.AuthRegistrationCreateSecurity | undefined,
+    options?: RequestOptions,
+  ): Promise<models.RestAuthDetail> {
+    return unwrapAsync(registrationCreate(
+      this,
+      request,
+      security,
+      options,
+    ));
+  }
+
+  /**
+   * Resend email verification
+   *
+   * @remarks
+   * Resends an email verification link to the provided **email** address, in case the user did not receive or lost the previous one.
+   */
+  async resendEmailVerification(
+    request: models.ResendEmailVerification,
+    security?: operations.AuthRegistrationResendEmailCreateSecurity | undefined,
+    options?: RequestOptions,
+  ): Promise<models.RestAuthDetail> {
+    return unwrapAsync(registrationResendEmailVerification(
+      this,
+      request,
+      security,
+      options,
+    ));
+  }
+
+  /**
+   * Verify email address
+   *
+   * @remarks
+   * Verifies the user's email address using the provided **key**, thus activating the user account.
+   */
+  async verifyEmail(
+    request: models.VerifyEmail,
+    security?: operations.AuthRegistrationVerifyEmailCreateSecurity | undefined,
+    options?: RequestOptions,
+  ): Promise<models.RestAuthDetail> {
+    return unwrapAsync(registrationVerifyEmail(
+      this,
+      request,
+      security,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -0,0 +1,111 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClientSDK } from "../lib/sdks.js";
+import { Assets } from "./assets.js";
+import { General } from "./general.js";
+import { MagicLink } from "./magic-link.js";
+import { Media } from "./media.js";
+import { Merchants } from "./merchants.js";
+import { Password } from "./password.js";
+import { ProductEvents } from "./product-events.js";
+import { ProductLines } from "./product-lines.js";
+import { Products } from "./products.js";
+import { ProvisionalLines } from "./provisional-lines.js";
+import { ProvisionalProducts } from "./provisional-products.js";
+import { Registration } from "./registration.js";
+import { Settings } from "./settings.js";
+import { SharedEvents } from "./shared-events.js";
+import { Transfers } from "./transfers.js";
+import { UserProfile } from "./user-profile.js";
+import { Webhooks } from "./webhooks.js";
+
+export class Rainfall extends ClientSDK {
+  private _assets?: Assets;
+  get assets(): Assets {
+    return (this._assets ??= new Assets(this._options));
+  }
+
+  private _general?: General;
+  get general(): General {
+    return (this._general ??= new General(this._options));
+  }
+
+  private _magicLink?: MagicLink;
+  get magicLink(): MagicLink {
+    return (this._magicLink ??= new MagicLink(this._options));
+  }
+
+  private _password?: Password;
+  get password(): Password {
+    return (this._password ??= new Password(this._options));
+  }
+
+  private _registration?: Registration;
+  get registration(): Registration {
+    return (this._registration ??= new Registration(this._options));
+  }
+
+  private _userProfile?: UserProfile;
+  get userProfile(): UserProfile {
+    return (this._userProfile ??= new UserProfile(this._options));
+  }
+
+  private _media?: Media;
+  get media(): Media {
+    return (this._media ??= new Media(this._options));
+  }
+
+  private _merchants?: Merchants;
+  get merchants(): Merchants {
+    return (this._merchants ??= new Merchants(this._options));
+  }
+
+  private _productEvents?: ProductEvents;
+  get productEvents(): ProductEvents {
+    return (this._productEvents ??= new ProductEvents(this._options));
+  }
+
+  private _productLines?: ProductLines;
+  get productLines(): ProductLines {
+    return (this._productLines ??= new ProductLines(this._options));
+  }
+
+  private _products?: Products;
+  get products(): Products {
+    return (this._products ??= new Products(this._options));
+  }
+
+  private _provisionalLines?: ProvisionalLines;
+  get provisionalLines(): ProvisionalLines {
+    return (this._provisionalLines ??= new ProvisionalLines(this._options));
+  }
+
+  private _provisionalProducts?: ProvisionalProducts;
+  get provisionalProducts(): ProvisionalProducts {
+    return (this._provisionalProducts ??= new ProvisionalProducts(
+      this._options,
+    ));
+  }
+
+  private _settings?: Settings;
+  get settings(): Settings {
+    return (this._settings ??= new Settings(this._options));
+  }
+
+  private _sharedEvents?: SharedEvents;
+  get sharedEvents(): SharedEvents {
+    return (this._sharedEvents ??= new SharedEvents(this._options));
+  }
+
+  private _transfers?: Transfers;
+  get transfers(): Transfers {
+    return (this._transfers ??= new Transfers(this._options));
+  }
+
+  private _webhooks?: Webhooks;
+  get webhooks(): Webhooks {
+    return (this._webhooks ??= new Webhooks(this._options));
+  }
+}