@izak0s/spacebring-api 11.1.0 → 11.2.0

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
@@ -33979,9 +33979,9 @@ interface operations {
33979
33979
  membershipRef?: string;
33980
33980
  /** @description Token to retrieve the next page of results. */
33981
33981
  nextPageToken?: string;
33982
- /** @description Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
33982
+ /** @description Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded. */
33983
33983
  status?: string;
33984
- /** @description Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
33984
+ /** @description Filter by what moved the credits: allocations add credits ('adminAllocation' granted by an admin, 'subscriptionAllocation' from a plan, 'purchaseAllocation' from a bought package); 'booking', 'order', 'eventTicket' and 'adminCharge' spend them; 'refund' returns them; 'expiration' and 'subscriptionExpiration' remove unused credits. Matches analytics report type filters. Comma-separated, one or more of: adminAllocation, adminCharge, booking, eventTicket, expiration, order, purchaseAllocation, refund, subscriptionAllocation, subscriptionExpiration. */
33985
33985
  type?: string;
33986
33986
  };
33987
33987
  header?: {
@@ -34142,7 +34142,7 @@ interface operations {
34142
34142
  membershipRef?: string;
34143
34143
  /** @description Token to retrieve the next page of results. */
34144
34144
  nextPageToken?: string;
34145
- /** @description Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
34145
+ /** @description Filter by what moved the day passes: allocations add passes ('adminAllocation' granted by an admin, 'subscriptionAllocation' from a plan, 'purchaseAllocation' from a bought package); 'booking' and 'adminCharge' spend them; 'refund' returns them; 'expiration' and 'subscriptionExpiration' remove unused passes. Matches analytics report type filters. Comma-separated, one or more of: adminAllocation, adminCharge, booking, expiration, purchaseAllocation, refund, subscriptionAllocation, subscriptionExpiration. */
34146
34146
  type?: string;
34147
34147
  };
34148
34148
  header?: {
@@ -34258,9 +34258,9 @@ interface operations {
34258
34258
  locationRef?: string;
34259
34259
  /** @description Token to retrieve the next page of results. */
34260
34260
  nextPageToken?: string;
34261
- /** @description Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
34261
+ /** @description Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded. */
34262
34262
  status?: string;
34263
- /** @description Filter by transaction type. Comma-separated type values, e.g. `type=booking,invoice`. */
34263
+ /** @description Filter by what was paid for: 'booking' a resource, 'creditPackage' a credits or day passes package, 'eventTicket' an event ticket, 'invoice' an issued invoice, 'order' a shop order, 'subscription' a membership plan, 'custom' a one-off charge created by an admin. Comma-separated, one or more of: booking, creditPackage, custom, eventTicket, invoice, order, subscription. */
34264
34264
  type?: string;
34265
34265
  };
34266
34266
  header?: {
@@ -35205,9 +35205,9 @@ interface GetCreditsTransactionsQuery {
35205
35205
  membershipRef?: string;
35206
35206
  /** Token to retrieve the next page of results. */
35207
35207
  nextPageToken?: string;
35208
- /** Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
35208
+ /** Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded. */
35209
35209
  status?: string;
35210
- /** Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
35210
+ /** Filter by what moved the credits: allocations add credits ('adminAllocation' granted by an admin, 'subscriptionAllocation' from a plan, 'purchaseAllocation' from a bought package); 'booking', 'order', 'eventTicket' and 'adminCharge' spend them; 'refund' returns them; 'expiration' and 'subscriptionExpiration' remove unused credits. Matches analytics report type filters. Comma-separated, one or more of: adminAllocation, adminCharge, booking, eventTicket, expiration, order, purchaseAllocation, refund, subscriptionAllocation, subscriptionExpiration. */
35211
35211
  type?: string;
35212
35212
  }
35213
35213
  /** Query parameters for `sb.transactions.dayPasses.list()`. */
@@ -35228,7 +35228,7 @@ interface GetDayPassesTransactionsQuery {
35228
35228
  membershipRef?: string;
35229
35229
  /** Token to retrieve the next page of results. */
35230
35230
  nextPageToken?: string;
35231
- /** Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
35231
+ /** Filter by what moved the day passes: allocations add passes ('adminAllocation' granted by an admin, 'subscriptionAllocation' from a plan, 'purchaseAllocation' from a bought package); 'booking' and 'adminCharge' spend them; 'refund' returns them; 'expiration' and 'subscriptionExpiration' remove unused passes. Matches analytics report type filters. Comma-separated, one or more of: adminAllocation, adminCharge, booking, expiration, purchaseAllocation, refund, subscriptionAllocation, subscriptionExpiration. */
35232
35232
  type?: string;
35233
35233
  }
35234
35234
  /** Query parameters for `sb.transactions.money.list()`. */
@@ -35245,9 +35245,9 @@ interface GetMoneyTransactionsQuery {
35245
35245
  locationRef?: string;
35246
35246
  /** Token to retrieve the next page of results. */
35247
35247
  nextPageToken?: string;
35248
- /** Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
35248
+ /** Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded. */
35249
35249
  status?: string;
35250
- /** Filter by transaction type. Comma-separated type values, e.g. `type=booking,invoice`. */
35250
+ /** Filter by what was paid for: 'booking' a resource, 'creditPackage' a credits or day passes package, 'eventTicket' an event ticket, 'invoice' an issued invoice, 'order' a shop order, 'subscription' a membership plan, 'custom' a one-off charge created by an admin. Comma-separated, one or more of: booking, creditPackage, custom, eventTicket, invoice, order, subscription. */
35251
35251
  type?: string;
35252
35252
  }
35253
35253
  /** Query parameters for `sb.transactions.credits.scheduled.list()`. */
package/dist/index.d.ts CHANGED
@@ -33979,9 +33979,9 @@ interface operations {
33979
33979
  membershipRef?: string;
33980
33980
  /** @description Token to retrieve the next page of results. */
33981
33981
  nextPageToken?: string;
33982
- /** @description Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
33982
+ /** @description Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded. */
33983
33983
  status?: string;
33984
- /** @description Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
33984
+ /** @description Filter by what moved the credits: allocations add credits ('adminAllocation' granted by an admin, 'subscriptionAllocation' from a plan, 'purchaseAllocation' from a bought package); 'booking', 'order', 'eventTicket' and 'adminCharge' spend them; 'refund' returns them; 'expiration' and 'subscriptionExpiration' remove unused credits. Matches analytics report type filters. Comma-separated, one or more of: adminAllocation, adminCharge, booking, eventTicket, expiration, order, purchaseAllocation, refund, subscriptionAllocation, subscriptionExpiration. */
33985
33985
  type?: string;
33986
33986
  };
33987
33987
  header?: {
@@ -34142,7 +34142,7 @@ interface operations {
34142
34142
  membershipRef?: string;
34143
34143
  /** @description Token to retrieve the next page of results. */
34144
34144
  nextPageToken?: string;
34145
- /** @description Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
34145
+ /** @description Filter by what moved the day passes: allocations add passes ('adminAllocation' granted by an admin, 'subscriptionAllocation' from a plan, 'purchaseAllocation' from a bought package); 'booking' and 'adminCharge' spend them; 'refund' returns them; 'expiration' and 'subscriptionExpiration' remove unused passes. Matches analytics report type filters. Comma-separated, one or more of: adminAllocation, adminCharge, booking, expiration, purchaseAllocation, refund, subscriptionAllocation, subscriptionExpiration. */
34146
34146
  type?: string;
34147
34147
  };
34148
34148
  header?: {
@@ -34258,9 +34258,9 @@ interface operations {
34258
34258
  locationRef?: string;
34259
34259
  /** @description Token to retrieve the next page of results. */
34260
34260
  nextPageToken?: string;
34261
- /** @description Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
34261
+ /** @description Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded. */
34262
34262
  status?: string;
34263
- /** @description Filter by transaction type. Comma-separated type values, e.g. `type=booking,invoice`. */
34263
+ /** @description Filter by what was paid for: 'booking' a resource, 'creditPackage' a credits or day passes package, 'eventTicket' an event ticket, 'invoice' an issued invoice, 'order' a shop order, 'subscription' a membership plan, 'custom' a one-off charge created by an admin. Comma-separated, one or more of: booking, creditPackage, custom, eventTicket, invoice, order, subscription. */
34264
34264
  type?: string;
34265
34265
  };
34266
34266
  header?: {
@@ -35205,9 +35205,9 @@ interface GetCreditsTransactionsQuery {
35205
35205
  membershipRef?: string;
35206
35206
  /** Token to retrieve the next page of results. */
35207
35207
  nextPageToken?: string;
35208
- /** Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
35208
+ /** Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded. */
35209
35209
  status?: string;
35210
- /** Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
35210
+ /** Filter by what moved the credits: allocations add credits ('adminAllocation' granted by an admin, 'subscriptionAllocation' from a plan, 'purchaseAllocation' from a bought package); 'booking', 'order', 'eventTicket' and 'adminCharge' spend them; 'refund' returns them; 'expiration' and 'subscriptionExpiration' remove unused credits. Matches analytics report type filters. Comma-separated, one or more of: adminAllocation, adminCharge, booking, eventTicket, expiration, order, purchaseAllocation, refund, subscriptionAllocation, subscriptionExpiration. */
35211
35211
  type?: string;
35212
35212
  }
35213
35213
  /** Query parameters for `sb.transactions.dayPasses.list()`. */
@@ -35228,7 +35228,7 @@ interface GetDayPassesTransactionsQuery {
35228
35228
  membershipRef?: string;
35229
35229
  /** Token to retrieve the next page of results. */
35230
35230
  nextPageToken?: string;
35231
- /** Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
35231
+ /** Filter by what moved the day passes: allocations add passes ('adminAllocation' granted by an admin, 'subscriptionAllocation' from a plan, 'purchaseAllocation' from a bought package); 'booking' and 'adminCharge' spend them; 'refund' returns them; 'expiration' and 'subscriptionExpiration' remove unused passes. Matches analytics report type filters. Comma-separated, one or more of: adminAllocation, adminCharge, booking, expiration, purchaseAllocation, refund, subscriptionAllocation, subscriptionExpiration. */
35232
35232
  type?: string;
35233
35233
  }
35234
35234
  /** Query parameters for `sb.transactions.money.list()`. */
@@ -35245,9 +35245,9 @@ interface GetMoneyTransactionsQuery {
35245
35245
  locationRef?: string;
35246
35246
  /** Token to retrieve the next page of results. */
35247
35247
  nextPageToken?: string;
35248
- /** Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
35248
+ /** Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded. */
35249
35249
  status?: string;
35250
- /** Filter by transaction type. Comma-separated type values, e.g. `type=booking,invoice`. */
35250
+ /** Filter by what was paid for: 'booking' a resource, 'creditPackage' a credits or day passes package, 'eventTicket' an event ticket, 'invoice' an issued invoice, 'order' a shop order, 'subscription' a membership plan, 'custom' a one-off charge created by an admin. Comma-separated, one or more of: booking, creditPackage, custom, eventTicket, invoice, order, subscription. */
35251
35251
  type?: string;
35252
35252
  }
35253
35253
  /** Query parameters for `sb.transactions.credits.scheduled.list()`. */