@shipstatic/ship 0.4.6 → 0.4.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -260,9 +260,25 @@ interface DeploymentResourceContext extends ResourceContext {
260
260
  clientDefaults?: ShipClientOptions;
261
261
  hasAuth?: () => boolean;
262
262
  }
263
+ /**
264
+ * Create deployment resource with all CRUD operations.
265
+ */
263
266
  declare function createDeploymentResource(ctx: DeploymentResourceContext): DeploymentResource;
267
+ /**
268
+ * Create domain resource with all CRUD operations.
269
+ *
270
+ * @remarks
271
+ * The `name` parameter in all methods is an FQDN (Fully Qualified Domain Name).
272
+ * The SDK does not validate or normalize domain names - the API handles all domain semantics.
273
+ */
264
274
  declare function createDomainResource(ctx: ResourceContext): DomainResource;
275
+ /**
276
+ * Create account resource (whoami functionality).
277
+ */
265
278
  declare function createAccountResource(ctx: ResourceContext): AccountResource;
279
+ /**
280
+ * Create token resource for managing deploy tokens.
281
+ */
266
282
  declare function createTokenResource(ctx: ResourceContext): TokenResource;
267
283
 
268
284
  /**
package/dist/index.d.ts CHANGED
@@ -260,9 +260,25 @@ interface DeploymentResourceContext extends ResourceContext {
260
260
  clientDefaults?: ShipClientOptions;
261
261
  hasAuth?: () => boolean;
262
262
  }
263
+ /**
264
+ * Create deployment resource with all CRUD operations.
265
+ */
263
266
  declare function createDeploymentResource(ctx: DeploymentResourceContext): DeploymentResource;
267
+ /**
268
+ * Create domain resource with all CRUD operations.
269
+ *
270
+ * @remarks
271
+ * The `name` parameter in all methods is an FQDN (Fully Qualified Domain Name).
272
+ * The SDK does not validate or normalize domain names - the API handles all domain semantics.
273
+ */
264
274
  declare function createDomainResource(ctx: ResourceContext): DomainResource;
275
+ /**
276
+ * Create account resource (whoami functionality).
277
+ */
265
278
  declare function createAccountResource(ctx: ResourceContext): AccountResource;
279
+ /**
280
+ * Create token resource for managing deploy tokens.
281
+ */
266
282
  declare function createTokenResource(ctx: ResourceContext): TokenResource;
267
283
 
268
284
  /**