Withdrawal history docs and models

docs/spec/components/schemas/WithdrawKey.yaml

@@ -3,10 +3,6 @@ required:
   - id
   - type
 properties:
-  id:
-    type: string
-    description: DID of the points owner
-    example: "did:iden3:readonly:tUDjWxnVJNi7t3FudukqrUcNwF5KVGoWgim5pp2jV"
   type:
     type: string
     enum: [ withdraw ]

docs/spec/components/schemas/Withdrawal.yaml

@@ -0,0 +1,25 @@
+allOf:
+  - $ref: '#/components/schemas/WithdrawalKey'
+  - type: object
+    required:
+      - attributes
+    properties:
+      attributes:
+        type: object
+        required:
+          - amount
+          - address
+          - created_at
+        properties:
+          amount:
+            type: integer
+            description: Amount of points withdrawn
+            example: 580
+          address:
+            type: string
+            description: Rarimo address which points were withdrawn to. Can be any valid address.
+            example: rarimo15hcd6tv7pe8hk2re7hu0zg0aphqdm2dtjrs0ds
+          created_at:
+            type: integer
+            description: Unix timestamp of withdrawal creation
+            example: 1706531218

docs/spec/components/schemas/WithdrawalKey.yaml

@@ -0,0 +1,11 @@
+type: object
+required:
+  - id
+  - type
+properties:
+  id:
+    type: string
+    example: "059c81dd-2a54-44a8-8142-c15ad8f88949"
+  type:
+    type: string
+    enum: [ withdrawal ]

docs/spec/paths/integrations@rarime-points-svc@v1@balances.yaml

@@ -47,9 +47,9 @@ get:
   description: Returns leaders sorted by points in descending order.
   operationId: getLeaderboard
   parameters:
-    - $ref: '#/components/parameters/pageCursor'
     - $ref: '#/components/parameters/pageLimit'
     - $ref: '#/components/parameters/pageNumber'
+    - $ref: '#/components/parameters/pageOrder'
   responses:
     200:
       description: Success

docs/spec/paths/integrations@rarime-points-svc@v1@balances@{did}.yaml

@@ -26,41 +26,3 @@ get:
       $ref: '#/components/responses/invalidAuth'
     500:
       $ref: '#/components/responses/internalError'
-
-patch:
-  tags:
-    - Points balance
-  summary: Withdraw points to RMO
-  description: Convert points to RMO by exchange rate and withdraw to user wallet
-  operationId: withdrawPoints
-  parameters:
-    - $ref: '#/components/parameters/pathDID'
-  requestBody:
-    required: true
-    content:
-      application/vnd.api+json:
-        schema:
-          type: object
-          required:
-            - data
-          properties:
-            data:
-              $ref: '#/components/schemas/Withdraw'
-  responses:
-    200:
-      description: Success
-      content:
-        application/vnd.api+json:
-          schema:
-            type: object
-            required:
-              - data
-            properties:
-              data:
-                $ref: '#/components/schemas/Balance'
-    400:
-      $ref: '#/components/responses/invalidParameter'
-    401:
-      $ref: '#/components/responses/invalidAuth'
-    500:
-      $ref: '#/components/responses/internalError'

docs/spec/paths/integrations@rarime-points-svc@v1@balances@{did}@withdrawals.yaml

@@ -0,0 +1,74 @@
+get:
+  tags:
+    - Points balance
+  summary: Withdrawal history
+  description: Points withdrawal history of the user
+  operationId: getWithdrawalHistory
+  parameters:
+    - $ref: '#/components/parameters/pathDID'
+    - $ref: '#/components/parameters/pageCursor'
+    - $ref: '#/components/parameters/pageLimit'
+    - $ref: '#/components/parameters/pageOrder'
+  responses:
+    200:
+      description: Success
+      content:
+        application/vnd.api+json:
+          schema:
+            type: object
+            required:
+              - data
+            properties:
+              data:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Withdrawal'
+    400:
+      $ref: '#/components/responses/invalidParameter'
+    401:
+      $ref: '#/components/responses/invalidAuth'
+    500:
+      $ref: '#/components/responses/internalError'
+
+post:
+  tags:
+    - Points balance
+  summary: Withdraw points
+  description: Convert points to RMO by exchange rate and withdraw to user wallet
+  operationId: withdrawPoints
+  parameters:
+    - $ref: '#/components/parameters/pathDID'
+  requestBody:
+    required: true
+    content:
+      application/vnd.api+json:
+        schema:
+          type: object
+          required:
+            - data
+          properties:
+            data:
+              $ref: '#/components/schemas/Withdraw'
+  responses:
+    200:
+      description: Success
+      content:
+        application/vnd.api+json:
+          schema:
+            type: object
+            required:
+              - data
+              - included
+            properties:
+              data:
+                $ref: '#/components/schemas/Withdrawal'
+              included:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Balance'
+    400:
+      $ref: '#/components/responses/invalidParameter'
+    401:
+      $ref: '#/components/responses/invalidAuth'
+    500:
+      $ref: '#/components/responses/internalError'

resources/model_resource_type.go

@@ -13,4 +13,5 @@ const (
 	CREATE_BALANCE ResourceType = "create_balance"
 	EVENT          ResourceType = "event"
 	WITHDRAW       ResourceType = "withdraw"
+	WITHDRAWAL     ResourceType = "withdrawal"
 )

resources/model_withdrawal.go

@@ -0,0 +1,43 @@
+/*
+ * GENERATED. Do not modify. Your changes might be overwritten!
+ */
+
+package resources
+
+import "encoding/json"
+
+type Withdrawal struct {
+	Key
+	Attributes WithdrawalAttributes `json:"attributes"`
+}
+type WithdrawalResponse struct {
+	Data     Withdrawal `json:"data"`
+	Included Included   `json:"included"`
+}
+
+type WithdrawalListResponse struct {
+	Data     []Withdrawal    `json:"data"`
+	Included Included        `json:"included"`
+	Links    *Links          `json:"links"`
+	Meta     json.RawMessage `json:"meta,omitempty"`
+}
+
+func (r *WithdrawalListResponse) PutMeta(v interface{}) (err error) {
+	r.Meta, err = json.Marshal(v)
+	return err
+}
+
+func (r *WithdrawalListResponse) GetMeta(out interface{}) error {
+	return json.Unmarshal(r.Meta, out)
+}
+
+// MustWithdrawal - returns Withdrawal from include collection.
+// if entry with specified key does not exist - returns nil
+// if entry with specified key exists but type or ID mismatches - panics
+func (c *Included) MustWithdrawal(key Key) *Withdrawal {
+	var withdrawal Withdrawal
+	if c.tryFindEntry(key, &withdrawal) {
+		return &withdrawal
+	}
+	return nil
+}

resources/model_withdrawal_attributes.go

@@ -0,0 +1,14 @@
+/*
+ * GENERATED. Do not modify. Your changes might be overwritten!
+ */
+
+package resources
+
+type WithdrawalAttributes struct {
+	// Rarimo address which points were withdrawn to. Can be any valid address.
+	Address string `json:"address"`
+	// Amount of points withdrawn
+	Amount int32 `json:"amount"`
+	// Unix timestamp of withdrawal creation
+	CreatedAt int32 `json:"created_at"`
+}