@appsemble/utils 0.34.21 → 0.35.3-test.0

package/api/paths/payments/acceptPayment.js

@@ -0,0 +1,340 @@
+export const pathItems = {
+    post: {
+        tags: ['main', 'payments'],
+        description: 'Accept a payment.',
+        operationId: 'acceptPayment',
+        requestBody: {
+            description: 'Information about the payment sent by Stripe.',
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            id: {
+                                type: 'string',
+                            },
+                            object: {
+                                type: 'string',
+                            },
+                            api_version: {
+                                type: 'string',
+                            },
+                            created: {
+                                type: 'number',
+                            },
+                            data: {
+                                type: 'object',
+                                properties: {
+                                    object: {
+                                        type: 'object',
+                                        properties: {
+                                            id: {
+                                                type: 'string',
+                                            },
+                                            object: {
+                                                type: 'string',
+                                            },
+                                            account_country: {
+                                                type: 'string',
+                                            },
+                                            account_name: {
+                                                type: 'string',
+                                            },
+                                            account_tax_ids: {
+                                                type: 'string',
+                                            },
+                                            amount_due: {
+                                                type: 'number',
+                                            },
+                                            amount_paid: {
+                                                type: 'number',
+                                            },
+                                            amount_remaining: {
+                                                type: 'number',
+                                            },
+                                            amount_shipping: {
+                                                type: 'number',
+                                            },
+                                            application: {
+                                                type: 'string',
+                                            },
+                                            application_fee_amount: {
+                                                type: 'number',
+                                            },
+                                            attempt_count: {
+                                                type: 'number',
+                                            },
+                                            attempted: {
+                                                type: 'boolean',
+                                            },
+                                            auto_advance: {
+                                                type: 'boolean',
+                                            },
+                                            automatic_tax: {
+                                                type: 'object',
+                                            },
+                                            automatically_finalizes_at: {
+                                                type: 'number',
+                                            },
+                                            billing_reason: {
+                                                type: 'string',
+                                            },
+                                            charge: {
+                                                type: 'string',
+                                            },
+                                            collection_method: {
+                                                type: 'string',
+                                            },
+                                            created: {
+                                                type: 'number',
+                                            },
+                                            currency: {
+                                                type: 'string',
+                                            },
+                                            custom_fields: {
+                                                type: 'array',
+                                                items: {
+                                                    type: 'object',
+                                                },
+                                            },
+                                            customer: {
+                                                type: 'string',
+                                            },
+                                            customer_address: {
+                                                type: 'object',
+                                            },
+                                            customer_email: {
+                                                type: 'string',
+                                            },
+                                            customer_name: {
+                                                type: 'string',
+                                            },
+                                            customer_phone: {
+                                                type: 'string',
+                                            },
+                                            customer_shipping: {
+                                                type: 'object',
+                                            },
+                                            customer_tax_exempt: {
+                                                type: 'string',
+                                            },
+                                            customer_tax_ids: {
+                                                type: 'array',
+                                                items: {
+                                                    type: 'object',
+                                                },
+                                            },
+                                            default_payment_method: {
+                                                type: 'string',
+                                            },
+                                            default_source: {
+                                                type: 'string',
+                                            },
+                                            default_tax_rates: {
+                                                type: 'array',
+                                                items: {
+                                                    type: 'object',
+                                                },
+                                            },
+                                            description: {
+                                                type: 'string',
+                                            },
+                                            discount: {
+                                                type: 'object',
+                                            },
+                                            discounts: {
+                                                type: 'array',
+                                                items: {
+                                                    type: 'string',
+                                                },
+                                            },
+                                            due_date: {
+                                                type: 'number',
+                                            },
+                                            effective_at: {
+                                                type: 'number',
+                                            },
+                                            ending_balance: {
+                                                type: 'number',
+                                            },
+                                            footer: {
+                                                type: 'string',
+                                            },
+                                            from_invoice: {
+                                                type: 'object',
+                                            },
+                                            hosted_invoice_url: {
+                                                type: 'string',
+                                            },
+                                            invoice_pdf: {
+                                                type: 'string',
+                                            },
+                                            issuer: {
+                                                type: 'object',
+                                            },
+                                            last_finalization_error: {
+                                                type: 'object',
+                                            },
+                                            latest_revision: {
+                                                type: 'string',
+                                            },
+                                            lines: {
+                                                type: 'object',
+                                            },
+                                            livemode: {
+                                                type: 'boolean',
+                                            },
+                                            metadata: {
+                                                type: 'object',
+                                                properties: {
+                                                    id: {
+                                                        type: 'number',
+                                                    },
+                                                },
+                                            },
+                                            next_payment_attempt: {
+                                                type: 'number',
+                                            },
+                                            number: {
+                                                type: 'string',
+                                            },
+                                            on_behalf_of: {
+                                                type: 'string',
+                                            },
+                                            paid: {
+                                                type: 'boolean',
+                                            },
+                                            paid_out_of_band: {
+                                                type: 'boolean',
+                                            },
+                                            payment_intent: {
+                                                type: 'string',
+                                            },
+                                            payment_settings: {
+                                                type: 'object',
+                                            },
+                                            period_end: {
+                                                type: 'number',
+                                            },
+                                            period_start: {
+                                                type: 'number',
+                                            },
+                                            post_payment_credit_notes_amount: {
+                                                type: 'number',
+                                            },
+                                            pre_payment_credit_notes_amount: {
+                                                type: 'number',
+                                            },
+                                            quote: {
+                                                type: 'string',
+                                            },
+                                            receipt_number: {
+                                                type: 'string',
+                                            },
+                                            rendering: {
+                                                type: 'object',
+                                            },
+                                            shipping_cost: {
+                                                type: 'object',
+                                            },
+                                            shipping_details: {
+                                                type: 'object',
+                                            },
+                                            starting_balance: {
+                                                type: 'number',
+                                            },
+                                            statement_descriptor: {
+                                                type: 'string',
+                                            },
+                                            status: {
+                                                type: 'string',
+                                            },
+                                            status_transitions: {
+                                                type: 'object',
+                                            },
+                                            subscription: {
+                                                type: 'string',
+                                            },
+                                            subscription_details: {
+                                                type: 'object',
+                                            },
+                                            subtotal: {
+                                                type: 'number',
+                                            },
+                                            subtotal_excluding_tax: {
+                                                type: 'number',
+                                            },
+                                            tax: {
+                                                type: 'number',
+                                            },
+                                            test_clock: {
+                                                type: 'string',
+                                            },
+                                            total: {
+                                                type: 'number',
+                                            },
+                                            total_discount_amounts: {
+                                                type: 'array',
+                                                items: {
+                                                    type: 'object',
+                                                },
+                                            },
+                                            total_excluding_tax: {
+                                                type: 'number',
+                                            },
+                                            total_pretax_credit_amounts: {
+                                                type: 'array',
+                                                items: {
+                                                    type: 'object',
+                                                },
+                                            },
+                                            total_tax_amounts: {
+                                                type: 'array',
+                                                items: {
+                                                    type: 'object',
+                                                },
+                                            },
+                                            transfer_data: {
+                                                type: 'object',
+                                            },
+                                            webhooks_delivered_at: {
+                                                type: 'number',
+                                            },
+                                        },
+                                    },
+                                },
+                            },
+                            livemode: {
+                                type: 'boolean',
+                            },
+                            pending_webhooks: {
+                                type: 'number',
+                            },
+                            request: {
+                                type: 'object',
+                                properties: {
+                                    id: {
+                                        type: 'string',
+                                    },
+                                    idempotency_key: {
+                                        type: 'string',
+                                    },
+                                },
+                            },
+                            type: {
+                                type: 'string',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: 'Response sent to Stripe, should be 200 OK if we receive the webhook, regardless of our internals.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=acceptPayment.js.map

package/api/paths/payments/payment.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/payments/payment.js

@@ -0,0 +1,40 @@
+export const pathItems = {
+    post: {
+        tags: ['main', 'payments'],
+        description: 'Send an invoice.',
+        operationId: 'sendInvoice',
+        responses: {
+            200: {
+                description: 'Whether the invoice has been succesfully created and sent to Stripe.',
+            },
+        },
+        parameters: [
+            {
+                in: 'query',
+                name: 'organizationId',
+                description: 'Organization that we want to invoice.',
+                schema: { type: 'string' },
+            },
+            {
+                in: 'query',
+                name: 'subscriptionType',
+                description: 'Subscription plan that we want to invoice for.',
+                schema: { type: 'string' },
+            },
+            {
+                in: 'query',
+                name: 'period',
+                description: 'Renewal period for which we want to invoice.',
+                schema: { type: 'string' },
+            },
+            {
+                in: 'query',
+                name: 'couponCode',
+                description: 'Coupon code that will be applied to the subscription.',
+                schema: { type: 'string' },
+            },
+        ],
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=payment.js.map

package/api/tags/index.js

@@ -87,6 +87,10 @@ export const tags = [
         name: 'organization',
         description: 'Operations related to organizations',
     },
+    {
+        name: 'organization-subscription',
+        description: 'Operations related to organizationSubscriptions',
+    },
     {
         name: 'rating',
         description: 'Operations related to ratings',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/utils",
-  "version": "0.34.21",
+  "version": "0.35.3-test.0",
   "description": "Utility functions used in Appsemble internally",
   "keywords": [
     "app",
@@ -39,8 +39,8 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.34.21",
-    "@appsemble/lang-sdk": "0.34.21",
+    "@appsemble/types": "0.35.3-test.0",
+    "@appsemble/lang-sdk": "0.35.3-test.0",
     "@odata/parser": "^0.2.14",
     "axios": "^1.0.0",
     "cron-parser": "^4.0.0",