@shophost/client 2.0.27 → 2.0.29

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.
@@ -3518,6 +3518,213 @@
3518
3518
  }
3519
3519
  }
3520
3520
  },
3521
+ "Member": {
3522
+ "type": "object",
3523
+ "properties": {
3524
+ "id": {
3525
+ "type": "string",
3526
+ "example": "clf9876543210abcdef",
3527
+ "description": "ID of the member"
3528
+ },
3529
+ "organizationId": {
3530
+ "type": "string",
3531
+ "example": "cju0z9k4z0000l1qg5z1z1z1z",
3532
+ "description": "ID of the organization"
3533
+ },
3534
+ "userId": {
3535
+ "type": "string",
3536
+ "example": "usr_123",
3537
+ "description": "ID of the user"
3538
+ },
3539
+ "role": {
3540
+ "type": "string",
3541
+ "example": "owner",
3542
+ "description": "Role of the member in the organization"
3543
+ },
3544
+ "createdAt": {
3545
+ "type": "string",
3546
+ "format": "date-time"
3547
+ },
3548
+ "user": {
3549
+ "type": "object",
3550
+ "properties": {
3551
+ "id": {
3552
+ "type": "string"
3553
+ },
3554
+ "firstname": {
3555
+ "type": "string"
3556
+ },
3557
+ "lastname": {
3558
+ "type": "string"
3559
+ },
3560
+ "email": {
3561
+ "type": "string"
3562
+ },
3563
+ "image": {
3564
+ "type": [
3565
+ "string",
3566
+ "null"
3567
+ ]
3568
+ }
3569
+ },
3570
+ "required": [
3571
+ "id",
3572
+ "firstname",
3573
+ "lastname",
3574
+ "email"
3575
+ ],
3576
+ "description": "User details"
3577
+ }
3578
+ },
3579
+ "required": [
3580
+ "id",
3581
+ "organizationId",
3582
+ "userId",
3583
+ "role",
3584
+ "createdAt",
3585
+ "user"
3586
+ ]
3587
+ },
3588
+ "UpdateMemberRole": {
3589
+ "type": "object",
3590
+ "properties": {
3591
+ "role": {
3592
+ "type": "string",
3593
+ "minLength": 1,
3594
+ "example": "admin",
3595
+ "description": "New role for the member"
3596
+ }
3597
+ },
3598
+ "required": [
3599
+ "role"
3600
+ ]
3601
+ },
3602
+ "Invitation": {
3603
+ "type": "object",
3604
+ "properties": {
3605
+ "id": {
3606
+ "type": "string",
3607
+ "example": "inv_123",
3608
+ "description": "ID of the invitation"
3609
+ },
3610
+ "organizationId": {
3611
+ "type": "string",
3612
+ "example": "cju0z9k4z0000l1qg5z1z1z1z",
3613
+ "description": "ID of the organization"
3614
+ },
3615
+ "email": {
3616
+ "type": "string",
3617
+ "format": "email",
3618
+ "example": "user@example.com",
3619
+ "description": "Email of the invited user"
3620
+ },
3621
+ "role": {
3622
+ "type": [
3623
+ "string",
3624
+ "null"
3625
+ ],
3626
+ "example": "member",
3627
+ "description": "Role assigned to the invitation"
3628
+ },
3629
+ "status": {
3630
+ "type": "string",
3631
+ "example": "pending",
3632
+ "description": "Status of the invitation"
3633
+ },
3634
+ "expiresAt": {
3635
+ "type": "string",
3636
+ "format": "date-time",
3637
+ "description": "Expiration date of the invitation"
3638
+ },
3639
+ "inviterId": {
3640
+ "type": "string",
3641
+ "description": "ID of the user who created the invitation"
3642
+ },
3643
+ "createdAt": {
3644
+ "type": "string",
3645
+ "format": "date-time"
3646
+ }
3647
+ },
3648
+ "required": [
3649
+ "id",
3650
+ "organizationId",
3651
+ "email",
3652
+ "status",
3653
+ "expiresAt",
3654
+ "inviterId"
3655
+ ]
3656
+ },
3657
+ "CreateInvitation": {
3658
+ "type": "object",
3659
+ "properties": {
3660
+ "email": {
3661
+ "type": "string",
3662
+ "format": "email",
3663
+ "example": "user@example.com",
3664
+ "description": "Email of the user to invite"
3665
+ },
3666
+ "role": {
3667
+ "type": "string",
3668
+ "minLength": 1,
3669
+ "example": "member",
3670
+ "description": "Role to assign to the invited user"
3671
+ }
3672
+ },
3673
+ "required": [
3674
+ "email",
3675
+ "role"
3676
+ ]
3677
+ },
3678
+ "UserInvitation": {
3679
+ "type": "object",
3680
+ "properties": {
3681
+ "id": {
3682
+ "type": "string",
3683
+ "example": "inv_123",
3684
+ "description": "ID of the invitation"
3685
+ },
3686
+ "organizationId": {
3687
+ "type": "string",
3688
+ "example": "cju0z9k4z0000l1qg5z1z1z1z",
3689
+ "description": "ID of the organization"
3690
+ },
3691
+ "role": {
3692
+ "type": [
3693
+ "string",
3694
+ "null"
3695
+ ],
3696
+ "example": "member",
3697
+ "description": "Role assigned to the invitation"
3698
+ },
3699
+ "expiresAt": {
3700
+ "type": "string",
3701
+ "format": "date-time",
3702
+ "description": "Expiration date of the invitation"
3703
+ },
3704
+ "organization": {
3705
+ "type": "object",
3706
+ "properties": {
3707
+ "id": {
3708
+ "type": "string"
3709
+ },
3710
+ "name": {
3711
+ "type": "string"
3712
+ }
3713
+ },
3714
+ "required": [
3715
+ "id",
3716
+ "name"
3717
+ ],
3718
+ "description": "Organization details"
3719
+ }
3720
+ },
3721
+ "required": [
3722
+ "id",
3723
+ "organizationId",
3724
+ "expiresAt",
3725
+ "organization"
3726
+ ]
3727
+ },
3521
3728
  "ShippingMethod": {
3522
3729
  "type": "object",
3523
3730
  "properties": {
@@ -9339,6 +9546,1409 @@
9339
9546
  }
9340
9547
  }
9341
9548
  },
9549
+ "/{organizationId}/access/members": {
9550
+ "get": {
9551
+ "description": "Fetches a paginated list of members for an organization",
9552
+ "operationId": "getMembers",
9553
+ "summary": "Get Members",
9554
+ "tags": [
9555
+ "Access"
9556
+ ],
9557
+ "parameters": [
9558
+ {
9559
+ "schema": {
9560
+ "type": "string",
9561
+ "minLength": 1,
9562
+ "format": "cuid",
9563
+ "example": "ckel0e8qw00004n5p5w6fznym",
9564
+ "description": "The organization ID"
9565
+ },
9566
+ "required": true,
9567
+ "description": "The organization ID",
9568
+ "name": "organizationId",
9569
+ "in": "path"
9570
+ },
9571
+ {
9572
+ "schema": {
9573
+ "type": [
9574
+ "number",
9575
+ "null"
9576
+ ],
9577
+ "default": 1,
9578
+ "example": 1,
9579
+ "description": "Page number"
9580
+ },
9581
+ "required": false,
9582
+ "description": "Page number",
9583
+ "name": "page",
9584
+ "in": "query"
9585
+ },
9586
+ {
9587
+ "schema": {
9588
+ "type": [
9589
+ "number",
9590
+ "null"
9591
+ ],
9592
+ "default": 10,
9593
+ "example": 50,
9594
+ "description": "Number of items per page"
9595
+ },
9596
+ "required": false,
9597
+ "description": "Number of items per page",
9598
+ "name": "limit",
9599
+ "in": "query"
9600
+ },
9601
+ {
9602
+ "schema": {
9603
+ "type": "string",
9604
+ "example": "Apple",
9605
+ "description": "Search query"
9606
+ },
9607
+ "required": false,
9608
+ "description": "Search query",
9609
+ "name": "search",
9610
+ "in": "query"
9611
+ },
9612
+ {
9613
+ "schema": {
9614
+ "type": [
9615
+ "boolean",
9616
+ "null"
9617
+ ],
9618
+ "example": true,
9619
+ "description": "Whether to filter by published items"
9620
+ },
9621
+ "required": false,
9622
+ "description": "Whether to filter by published items",
9623
+ "name": "published",
9624
+ "in": "query"
9625
+ },
9626
+ {
9627
+ "schema": {
9628
+ "type": "string",
9629
+ "enum": [
9630
+ "af",
9631
+ "sq",
9632
+ "ar_dz",
9633
+ "ar_bh",
9634
+ "ar_eg",
9635
+ "ar_iq",
9636
+ "ar_jo",
9637
+ "ar_kw",
9638
+ "ar_lb",
9639
+ "ar_ly",
9640
+ "ar_ma",
9641
+ "ar_om",
9642
+ "ar_qa",
9643
+ "ar_sa",
9644
+ "ar_sy",
9645
+ "ar_tn",
9646
+ "ar_ae",
9647
+ "ar_ye",
9648
+ "eu",
9649
+ "be",
9650
+ "bg",
9651
+ "ca",
9652
+ "zh_hk",
9653
+ "zh_cn",
9654
+ "zh_sg",
9655
+ "zh_tw",
9656
+ "hr",
9657
+ "cs",
9658
+ "da",
9659
+ "nl_be",
9660
+ "nl",
9661
+ "en",
9662
+ "en_au",
9663
+ "en_bz",
9664
+ "en_ca",
9665
+ "en_ie",
9666
+ "en_jm",
9667
+ "en_nz",
9668
+ "en_za",
9669
+ "en_tt",
9670
+ "en_gb",
9671
+ "en_us",
9672
+ "et",
9673
+ "fo",
9674
+ "fa",
9675
+ "fi",
9676
+ "fr_be",
9677
+ "fr_ca",
9678
+ "fr_lu",
9679
+ "fr",
9680
+ "fr_ch",
9681
+ "gd",
9682
+ "de_at",
9683
+ "de_li",
9684
+ "de_lu",
9685
+ "de",
9686
+ "de_ch",
9687
+ "el",
9688
+ "he",
9689
+ "hi",
9690
+ "hu",
9691
+ "is",
9692
+ "id",
9693
+ "ga",
9694
+ "it",
9695
+ "it_ch",
9696
+ "ja",
9697
+ "ko",
9698
+ "ku",
9699
+ "lv",
9700
+ "lt",
9701
+ "mk",
9702
+ "ml",
9703
+ "ms",
9704
+ "mt",
9705
+ "no",
9706
+ "nb",
9707
+ "nn",
9708
+ "pl",
9709
+ "pt_br",
9710
+ "pt",
9711
+ "pa",
9712
+ "rm",
9713
+ "ro",
9714
+ "ro_md",
9715
+ "ru",
9716
+ "ru_md",
9717
+ "sr",
9718
+ "sk",
9719
+ "sl",
9720
+ "sb",
9721
+ "es_ar",
9722
+ "es_bo",
9723
+ "es_cl",
9724
+ "es_co",
9725
+ "es_cr",
9726
+ "es_do",
9727
+ "es_ec",
9728
+ "es_sv",
9729
+ "es_gt",
9730
+ "es_hn",
9731
+ "es_mx",
9732
+ "es",
9733
+ "sv",
9734
+ "sv_fi",
9735
+ "th",
9736
+ "tr",
9737
+ "uk",
9738
+ "ur",
9739
+ "vi",
9740
+ "cy",
9741
+ "ji",
9742
+ "zu"
9743
+ ],
9744
+ "description": "Enum for locale values",
9745
+ "example": "en"
9746
+ },
9747
+ "required": false,
9748
+ "description": "Enum for locale values",
9749
+ "name": "locale",
9750
+ "in": "query"
9751
+ },
9752
+ {
9753
+ "schema": {
9754
+ "type": "string",
9755
+ "example": "en-US",
9756
+ "description": "Accept-Language header"
9757
+ },
9758
+ "required": false,
9759
+ "description": "Accept-Language header",
9760
+ "in": "header",
9761
+ "name": "accept-language"
9762
+ },
9763
+ {
9764
+ "schema": {
9765
+ "type": "string",
9766
+ "example": "session=1234567890",
9767
+ "description": "Cookie header"
9768
+ },
9769
+ "required": false,
9770
+ "description": "Cookie header",
9771
+ "in": "header",
9772
+ "name": "cookie"
9773
+ }
9774
+ ],
9775
+ "responses": {
9776
+ "200": {
9777
+ "description": "OK",
9778
+ "content": {
9779
+ "application/json": {
9780
+ "schema": {
9781
+ "type": "object",
9782
+ "properties": {
9783
+ "list": {
9784
+ "type": "array",
9785
+ "items": {
9786
+ "$ref": "#/components/schemas/Member"
9787
+ }
9788
+ },
9789
+ "meta": {
9790
+ "$ref": "#/components/schemas/PaginationMeta"
9791
+ }
9792
+ },
9793
+ "required": [
9794
+ "list",
9795
+ "meta"
9796
+ ]
9797
+ }
9798
+ }
9799
+ }
9800
+ },
9801
+ "400": {
9802
+ "description": "Bad Request",
9803
+ "content": {
9804
+ "application/json": {
9805
+ "schema": {
9806
+ "type": "object",
9807
+ "properties": {
9808
+ "status": {
9809
+ "type": "number",
9810
+ "example": 404,
9811
+ "description": "The HTTP status code"
9812
+ },
9813
+ "message": {
9814
+ "type": "string",
9815
+ "example": "Not found",
9816
+ "description": "The error message"
9817
+ }
9818
+ },
9819
+ "required": [
9820
+ "status",
9821
+ "message"
9822
+ ]
9823
+ }
9824
+ }
9825
+ }
9826
+ },
9827
+ "401": {
9828
+ "description": "Unauthorized",
9829
+ "content": {
9830
+ "application/json": {
9831
+ "schema": {
9832
+ "type": "object",
9833
+ "properties": {
9834
+ "status": {
9835
+ "type": "number",
9836
+ "example": 404,
9837
+ "description": "The HTTP status code"
9838
+ },
9839
+ "message": {
9840
+ "type": "string",
9841
+ "example": "Not found",
9842
+ "description": "The error message"
9843
+ }
9844
+ },
9845
+ "required": [
9846
+ "status",
9847
+ "message"
9848
+ ]
9849
+ }
9850
+ }
9851
+ }
9852
+ }
9853
+ }
9854
+ }
9855
+ },
9856
+ "/{organizationId}/access/members/{memberId}": {
9857
+ "get": {
9858
+ "operationId": "getMember",
9859
+ "summary": "Get Member",
9860
+ "tags": [
9861
+ "Access"
9862
+ ],
9863
+ "parameters": [
9864
+ {
9865
+ "schema": {
9866
+ "type": "string",
9867
+ "description": "ID of the member",
9868
+ "example": "clf9876543210abcdef"
9869
+ },
9870
+ "required": true,
9871
+ "description": "ID of the member",
9872
+ "in": "path",
9873
+ "name": "memberId"
9874
+ },
9875
+ {
9876
+ "schema": {
9877
+ "type": "string",
9878
+ "description": "ID of the organization",
9879
+ "example": "cju0z9k4z0000l1qg5z1z1z1z"
9880
+ },
9881
+ "required": true,
9882
+ "description": "ID of the organization",
9883
+ "in": "path",
9884
+ "name": "organizationId"
9885
+ },
9886
+ {
9887
+ "schema": {
9888
+ "type": "string",
9889
+ "example": "en-US",
9890
+ "description": "Accept-Language header"
9891
+ },
9892
+ "required": false,
9893
+ "description": "Accept-Language header",
9894
+ "in": "header",
9895
+ "name": "accept-language"
9896
+ },
9897
+ {
9898
+ "schema": {
9899
+ "type": "string",
9900
+ "example": "session=1234567890",
9901
+ "description": "Cookie header"
9902
+ },
9903
+ "required": false,
9904
+ "description": "Cookie header",
9905
+ "in": "header",
9906
+ "name": "cookie"
9907
+ }
9908
+ ],
9909
+ "responses": {
9910
+ "200": {
9911
+ "description": "OK",
9912
+ "content": {
9913
+ "application/json": {
9914
+ "schema": {
9915
+ "$ref": "#/components/schemas/Member"
9916
+ }
9917
+ }
9918
+ }
9919
+ },
9920
+ "401": {
9921
+ "description": "Unauthorized",
9922
+ "content": {
9923
+ "application/json": {
9924
+ "schema": {
9925
+ "type": "object",
9926
+ "properties": {
9927
+ "status": {
9928
+ "type": "number",
9929
+ "example": 404,
9930
+ "description": "The HTTP status code"
9931
+ },
9932
+ "message": {
9933
+ "type": "string",
9934
+ "example": "Not found",
9935
+ "description": "The error message"
9936
+ }
9937
+ },
9938
+ "required": [
9939
+ "status",
9940
+ "message"
9941
+ ]
9942
+ }
9943
+ }
9944
+ }
9945
+ },
9946
+ "404": {
9947
+ "description": "Not Found",
9948
+ "content": {
9949
+ "application/json": {
9950
+ "schema": {
9951
+ "type": "object",
9952
+ "properties": {
9953
+ "status": {
9954
+ "type": "number",
9955
+ "example": 404,
9956
+ "description": "The HTTP status code"
9957
+ },
9958
+ "message": {
9959
+ "type": "string",
9960
+ "example": "Not found",
9961
+ "description": "The error message"
9962
+ }
9963
+ },
9964
+ "required": [
9965
+ "status",
9966
+ "message"
9967
+ ]
9968
+ }
9969
+ }
9970
+ }
9971
+ }
9972
+ }
9973
+ },
9974
+ "put": {
9975
+ "description": "Updates a member's role in the organization",
9976
+ "operationId": "updateMemberRole",
9977
+ "summary": "Update Member Role",
9978
+ "tags": [
9979
+ "Access"
9980
+ ],
9981
+ "parameters": [
9982
+ {
9983
+ "schema": {
9984
+ "type": "string",
9985
+ "description": "ID of the member",
9986
+ "example": "clf9876543210abcdef"
9987
+ },
9988
+ "required": true,
9989
+ "description": "ID of the member",
9990
+ "in": "path",
9991
+ "name": "memberId"
9992
+ },
9993
+ {
9994
+ "schema": {
9995
+ "type": "string",
9996
+ "description": "ID of the organization",
9997
+ "example": "cju0z9k4z0000l1qg5z1z1z1z"
9998
+ },
9999
+ "required": true,
10000
+ "description": "ID of the organization",
10001
+ "in": "path",
10002
+ "name": "organizationId"
10003
+ },
10004
+ {
10005
+ "schema": {
10006
+ "type": "string",
10007
+ "example": "en-US",
10008
+ "description": "Accept-Language header"
10009
+ },
10010
+ "required": false,
10011
+ "description": "Accept-Language header",
10012
+ "in": "header",
10013
+ "name": "accept-language"
10014
+ },
10015
+ {
10016
+ "schema": {
10017
+ "type": "string",
10018
+ "example": "session=1234567890",
10019
+ "description": "Cookie header"
10020
+ },
10021
+ "required": false,
10022
+ "description": "Cookie header",
10023
+ "in": "header",
10024
+ "name": "cookie"
10025
+ }
10026
+ ],
10027
+ "requestBody": {
10028
+ "required": true,
10029
+ "content": {
10030
+ "application/json": {
10031
+ "schema": {
10032
+ "$ref": "#/components/schemas/UpdateMemberRole"
10033
+ }
10034
+ }
10035
+ }
10036
+ },
10037
+ "responses": {
10038
+ "200": {
10039
+ "description": "OK",
10040
+ "content": {
10041
+ "application/json": {
10042
+ "schema": {
10043
+ "$ref": "#/components/schemas/Member"
10044
+ }
10045
+ }
10046
+ }
10047
+ },
10048
+ "400": {
10049
+ "description": "Bad Request",
10050
+ "content": {
10051
+ "application/json": {
10052
+ "schema": {
10053
+ "type": "object",
10054
+ "properties": {
10055
+ "status": {
10056
+ "type": "number",
10057
+ "example": 404,
10058
+ "description": "The HTTP status code"
10059
+ },
10060
+ "message": {
10061
+ "type": "string",
10062
+ "example": "Not found",
10063
+ "description": "The error message"
10064
+ }
10065
+ },
10066
+ "required": [
10067
+ "status",
10068
+ "message"
10069
+ ]
10070
+ }
10071
+ }
10072
+ }
10073
+ },
10074
+ "401": {
10075
+ "description": "Unauthorized",
10076
+ "content": {
10077
+ "application/json": {
10078
+ "schema": {
10079
+ "type": "object",
10080
+ "properties": {
10081
+ "status": {
10082
+ "type": "number",
10083
+ "example": 404,
10084
+ "description": "The HTTP status code"
10085
+ },
10086
+ "message": {
10087
+ "type": "string",
10088
+ "example": "Not found",
10089
+ "description": "The error message"
10090
+ }
10091
+ },
10092
+ "required": [
10093
+ "status",
10094
+ "message"
10095
+ ]
10096
+ }
10097
+ }
10098
+ }
10099
+ },
10100
+ "404": {
10101
+ "description": "Not Found",
10102
+ "content": {
10103
+ "application/json": {
10104
+ "schema": {
10105
+ "type": "object",
10106
+ "properties": {
10107
+ "status": {
10108
+ "type": "number",
10109
+ "example": 404,
10110
+ "description": "The HTTP status code"
10111
+ },
10112
+ "message": {
10113
+ "type": "string",
10114
+ "example": "Not found",
10115
+ "description": "The error message"
10116
+ }
10117
+ },
10118
+ "required": [
10119
+ "status",
10120
+ "message"
10121
+ ]
10122
+ }
10123
+ }
10124
+ }
10125
+ }
10126
+ }
10127
+ },
10128
+ "delete": {
10129
+ "description": "Removes a member from the organization",
10130
+ "operationId": "deleteMember",
10131
+ "summary": "Delete Member",
10132
+ "tags": [
10133
+ "Access"
10134
+ ],
10135
+ "parameters": [
10136
+ {
10137
+ "schema": {
10138
+ "type": "string",
10139
+ "description": "ID of the member",
10140
+ "example": "clf9876543210abcdef"
10141
+ },
10142
+ "required": true,
10143
+ "description": "ID of the member",
10144
+ "in": "path",
10145
+ "name": "memberId"
10146
+ },
10147
+ {
10148
+ "schema": {
10149
+ "type": "string",
10150
+ "description": "ID of the organization",
10151
+ "example": "cju0z9k4z0000l1qg5z1z1z1z"
10152
+ },
10153
+ "required": true,
10154
+ "description": "ID of the organization",
10155
+ "in": "path",
10156
+ "name": "organizationId"
10157
+ },
10158
+ {
10159
+ "schema": {
10160
+ "type": "string",
10161
+ "example": "en-US",
10162
+ "description": "Accept-Language header"
10163
+ },
10164
+ "required": false,
10165
+ "description": "Accept-Language header",
10166
+ "in": "header",
10167
+ "name": "accept-language"
10168
+ },
10169
+ {
10170
+ "schema": {
10171
+ "type": "string",
10172
+ "example": "session=1234567890",
10173
+ "description": "Cookie header"
10174
+ },
10175
+ "required": false,
10176
+ "description": "Cookie header",
10177
+ "in": "header",
10178
+ "name": "cookie"
10179
+ }
10180
+ ],
10181
+ "responses": {
10182
+ "204": {
10183
+ "description": "No Content"
10184
+ },
10185
+ "400": {
10186
+ "description": "Bad Request",
10187
+ "content": {
10188
+ "application/json": {
10189
+ "schema": {
10190
+ "type": "object",
10191
+ "properties": {
10192
+ "status": {
10193
+ "type": "number",
10194
+ "example": 404,
10195
+ "description": "The HTTP status code"
10196
+ },
10197
+ "message": {
10198
+ "type": "string",
10199
+ "example": "Not found",
10200
+ "description": "The error message"
10201
+ }
10202
+ },
10203
+ "required": [
10204
+ "status",
10205
+ "message"
10206
+ ]
10207
+ }
10208
+ }
10209
+ }
10210
+ },
10211
+ "401": {
10212
+ "description": "Unauthorized",
10213
+ "content": {
10214
+ "application/json": {
10215
+ "schema": {
10216
+ "type": "object",
10217
+ "properties": {
10218
+ "status": {
10219
+ "type": "number",
10220
+ "example": 404,
10221
+ "description": "The HTTP status code"
10222
+ },
10223
+ "message": {
10224
+ "type": "string",
10225
+ "example": "Not found",
10226
+ "description": "The error message"
10227
+ }
10228
+ },
10229
+ "required": [
10230
+ "status",
10231
+ "message"
10232
+ ]
10233
+ }
10234
+ }
10235
+ }
10236
+ },
10237
+ "404": {
10238
+ "description": "Not Found",
10239
+ "content": {
10240
+ "application/json": {
10241
+ "schema": {
10242
+ "type": "object",
10243
+ "properties": {
10244
+ "status": {
10245
+ "type": "number",
10246
+ "example": 404,
10247
+ "description": "The HTTP status code"
10248
+ },
10249
+ "message": {
10250
+ "type": "string",
10251
+ "example": "Not found",
10252
+ "description": "The error message"
10253
+ }
10254
+ },
10255
+ "required": [
10256
+ "status",
10257
+ "message"
10258
+ ]
10259
+ }
10260
+ }
10261
+ }
10262
+ }
10263
+ }
10264
+ }
10265
+ },
10266
+ "/{organizationId}/access/invitations": {
10267
+ "post": {
10268
+ "description": "Creates a new invitation for the organization",
10269
+ "operationId": "createInvitation",
10270
+ "summary": "Create Invitation",
10271
+ "tags": [
10272
+ "Access"
10273
+ ],
10274
+ "parameters": [
10275
+ {
10276
+ "schema": {
10277
+ "type": "string",
10278
+ "minLength": 1,
10279
+ "format": "cuid",
10280
+ "example": "ckel0e8qw00004n5p5w6fznym",
10281
+ "description": "The organization ID"
10282
+ },
10283
+ "required": true,
10284
+ "description": "The organization ID",
10285
+ "name": "organizationId",
10286
+ "in": "path"
10287
+ },
10288
+ {
10289
+ "schema": {
10290
+ "type": "string",
10291
+ "example": "en-US",
10292
+ "description": "Accept-Language header"
10293
+ },
10294
+ "required": false,
10295
+ "description": "Accept-Language header",
10296
+ "in": "header",
10297
+ "name": "accept-language"
10298
+ },
10299
+ {
10300
+ "schema": {
10301
+ "type": "string",
10302
+ "example": "session=1234567890",
10303
+ "description": "Cookie header"
10304
+ },
10305
+ "required": false,
10306
+ "description": "Cookie header",
10307
+ "in": "header",
10308
+ "name": "cookie"
10309
+ }
10310
+ ],
10311
+ "requestBody": {
10312
+ "required": true,
10313
+ "content": {
10314
+ "application/json": {
10315
+ "schema": {
10316
+ "$ref": "#/components/schemas/CreateInvitation"
10317
+ }
10318
+ }
10319
+ }
10320
+ },
10321
+ "responses": {
10322
+ "201": {
10323
+ "description": "Created",
10324
+ "content": {
10325
+ "application/json": {
10326
+ "schema": {
10327
+ "$ref": "#/components/schemas/Invitation"
10328
+ }
10329
+ }
10330
+ }
10331
+ },
10332
+ "400": {
10333
+ "description": "Bad Request",
10334
+ "content": {
10335
+ "application/json": {
10336
+ "schema": {
10337
+ "type": "object",
10338
+ "properties": {
10339
+ "status": {
10340
+ "type": "number",
10341
+ "example": 404,
10342
+ "description": "The HTTP status code"
10343
+ },
10344
+ "message": {
10345
+ "type": "string",
10346
+ "example": "Not found",
10347
+ "description": "The error message"
10348
+ }
10349
+ },
10350
+ "required": [
10351
+ "status",
10352
+ "message"
10353
+ ]
10354
+ }
10355
+ }
10356
+ }
10357
+ },
10358
+ "401": {
10359
+ "description": "Unauthorized",
10360
+ "content": {
10361
+ "application/json": {
10362
+ "schema": {
10363
+ "type": "object",
10364
+ "properties": {
10365
+ "status": {
10366
+ "type": "number",
10367
+ "example": 404,
10368
+ "description": "The HTTP status code"
10369
+ },
10370
+ "message": {
10371
+ "type": "string",
10372
+ "example": "Not found",
10373
+ "description": "The error message"
10374
+ }
10375
+ },
10376
+ "required": [
10377
+ "status",
10378
+ "message"
10379
+ ]
10380
+ }
10381
+ }
10382
+ }
10383
+ }
10384
+ }
10385
+ },
10386
+ "get": {
10387
+ "description": "Fetches a list of pending invitations for an organization",
10388
+ "operationId": "getInvitations",
10389
+ "summary": "Get Invitations",
10390
+ "tags": [
10391
+ "Access"
10392
+ ],
10393
+ "parameters": [
10394
+ {
10395
+ "schema": {
10396
+ "type": "string",
10397
+ "minLength": 1,
10398
+ "format": "cuid",
10399
+ "example": "ckel0e8qw00004n5p5w6fznym",
10400
+ "description": "The organization ID"
10401
+ },
10402
+ "required": true,
10403
+ "description": "The organization ID",
10404
+ "name": "organizationId",
10405
+ "in": "path"
10406
+ },
10407
+ {
10408
+ "schema": {
10409
+ "type": "string",
10410
+ "example": "en-US",
10411
+ "description": "Accept-Language header"
10412
+ },
10413
+ "required": false,
10414
+ "description": "Accept-Language header",
10415
+ "in": "header",
10416
+ "name": "accept-language"
10417
+ },
10418
+ {
10419
+ "schema": {
10420
+ "type": "string",
10421
+ "example": "session=1234567890",
10422
+ "description": "Cookie header"
10423
+ },
10424
+ "required": false,
10425
+ "description": "Cookie header",
10426
+ "in": "header",
10427
+ "name": "cookie"
10428
+ }
10429
+ ],
10430
+ "responses": {
10431
+ "200": {
10432
+ "description": "OK",
10433
+ "content": {
10434
+ "application/json": {
10435
+ "schema": {
10436
+ "type": "array",
10437
+ "items": {
10438
+ "$ref": "#/components/schemas/Invitation"
10439
+ }
10440
+ }
10441
+ }
10442
+ }
10443
+ },
10444
+ "401": {
10445
+ "description": "Unauthorized",
10446
+ "content": {
10447
+ "application/json": {
10448
+ "schema": {
10449
+ "type": "object",
10450
+ "properties": {
10451
+ "status": {
10452
+ "type": "number",
10453
+ "example": 404,
10454
+ "description": "The HTTP status code"
10455
+ },
10456
+ "message": {
10457
+ "type": "string",
10458
+ "example": "Not found",
10459
+ "description": "The error message"
10460
+ }
10461
+ },
10462
+ "required": [
10463
+ "status",
10464
+ "message"
10465
+ ]
10466
+ }
10467
+ }
10468
+ }
10469
+ }
10470
+ }
10471
+ }
10472
+ },
10473
+ "/{organizationId}/access/invitations/{invitationId}": {
10474
+ "delete": {
10475
+ "description": "Revokes a pending invitation",
10476
+ "operationId": "deleteInvitation",
10477
+ "summary": "Delete Invitation",
10478
+ "tags": [
10479
+ "Access"
10480
+ ],
10481
+ "parameters": [
10482
+ {
10483
+ "schema": {
10484
+ "type": "string",
10485
+ "description": "ID of the invitation",
10486
+ "example": "inv_123"
10487
+ },
10488
+ "required": true,
10489
+ "description": "ID of the invitation",
10490
+ "in": "path",
10491
+ "name": "invitationId"
10492
+ },
10493
+ {
10494
+ "schema": {
10495
+ "type": "string",
10496
+ "description": "ID of the organization",
10497
+ "example": "cju0z9k4z0000l1qg5z1z1z1z"
10498
+ },
10499
+ "required": true,
10500
+ "description": "ID of the organization",
10501
+ "in": "path",
10502
+ "name": "organizationId"
10503
+ },
10504
+ {
10505
+ "schema": {
10506
+ "type": "string",
10507
+ "example": "en-US",
10508
+ "description": "Accept-Language header"
10509
+ },
10510
+ "required": false,
10511
+ "description": "Accept-Language header",
10512
+ "in": "header",
10513
+ "name": "accept-language"
10514
+ },
10515
+ {
10516
+ "schema": {
10517
+ "type": "string",
10518
+ "example": "session=1234567890",
10519
+ "description": "Cookie header"
10520
+ },
10521
+ "required": false,
10522
+ "description": "Cookie header",
10523
+ "in": "header",
10524
+ "name": "cookie"
10525
+ }
10526
+ ],
10527
+ "responses": {
10528
+ "204": {
10529
+ "description": "No Content"
10530
+ },
10531
+ "400": {
10532
+ "description": "Bad Request",
10533
+ "content": {
10534
+ "application/json": {
10535
+ "schema": {
10536
+ "type": "object",
10537
+ "properties": {
10538
+ "status": {
10539
+ "type": "number",
10540
+ "example": 404,
10541
+ "description": "The HTTP status code"
10542
+ },
10543
+ "message": {
10544
+ "type": "string",
10545
+ "example": "Not found",
10546
+ "description": "The error message"
10547
+ }
10548
+ },
10549
+ "required": [
10550
+ "status",
10551
+ "message"
10552
+ ]
10553
+ }
10554
+ }
10555
+ }
10556
+ },
10557
+ "401": {
10558
+ "description": "Unauthorized",
10559
+ "content": {
10560
+ "application/json": {
10561
+ "schema": {
10562
+ "type": "object",
10563
+ "properties": {
10564
+ "status": {
10565
+ "type": "number",
10566
+ "example": 404,
10567
+ "description": "The HTTP status code"
10568
+ },
10569
+ "message": {
10570
+ "type": "string",
10571
+ "example": "Not found",
10572
+ "description": "The error message"
10573
+ }
10574
+ },
10575
+ "required": [
10576
+ "status",
10577
+ "message"
10578
+ ]
10579
+ }
10580
+ }
10581
+ }
10582
+ },
10583
+ "404": {
10584
+ "description": "Not Found",
10585
+ "content": {
10586
+ "application/json": {
10587
+ "schema": {
10588
+ "type": "object",
10589
+ "properties": {
10590
+ "status": {
10591
+ "type": "number",
10592
+ "example": 404,
10593
+ "description": "The HTTP status code"
10594
+ },
10595
+ "message": {
10596
+ "type": "string",
10597
+ "example": "Not found",
10598
+ "description": "The error message"
10599
+ }
10600
+ },
10601
+ "required": [
10602
+ "status",
10603
+ "message"
10604
+ ]
10605
+ }
10606
+ }
10607
+ }
10608
+ }
10609
+ }
10610
+ }
10611
+ },
10612
+ "/access/invitations/me": {
10613
+ "get": {
10614
+ "description": "Fetches pending invitations for the currently authenticated user",
10615
+ "operationId": "getUserInvitations",
10616
+ "summary": "Get User Invitations",
10617
+ "tags": [
10618
+ "Access"
10619
+ ],
10620
+ "parameters": [
10621
+ {
10622
+ "schema": {
10623
+ "type": "string",
10624
+ "example": "en-US",
10625
+ "description": "Accept-Language header"
10626
+ },
10627
+ "required": false,
10628
+ "description": "Accept-Language header",
10629
+ "in": "header",
10630
+ "name": "accept-language"
10631
+ },
10632
+ {
10633
+ "schema": {
10634
+ "type": "string",
10635
+ "example": "session=1234567890",
10636
+ "description": "Cookie header"
10637
+ },
10638
+ "required": false,
10639
+ "description": "Cookie header",
10640
+ "in": "header",
10641
+ "name": "cookie"
10642
+ }
10643
+ ],
10644
+ "responses": {
10645
+ "200": {
10646
+ "description": "OK",
10647
+ "content": {
10648
+ "application/json": {
10649
+ "schema": {
10650
+ "type": "array",
10651
+ "items": {
10652
+ "$ref": "#/components/schemas/UserInvitation"
10653
+ }
10654
+ }
10655
+ }
10656
+ }
10657
+ },
10658
+ "401": {
10659
+ "description": "Unauthorized",
10660
+ "content": {
10661
+ "application/json": {
10662
+ "schema": {
10663
+ "type": "object",
10664
+ "properties": {
10665
+ "status": {
10666
+ "type": "number",
10667
+ "example": 404,
10668
+ "description": "The HTTP status code"
10669
+ },
10670
+ "message": {
10671
+ "type": "string",
10672
+ "example": "Not found",
10673
+ "description": "The error message"
10674
+ }
10675
+ },
10676
+ "required": [
10677
+ "status",
10678
+ "message"
10679
+ ]
10680
+ }
10681
+ }
10682
+ }
10683
+ }
10684
+ }
10685
+ }
10686
+ },
10687
+ "/access/invitations/{invitationId}/accept": {
10688
+ "post": {
10689
+ "description": "Accepts a pending invitation and adds the user as a member",
10690
+ "operationId": "acceptInvitation",
10691
+ "summary": "Accept Invitation",
10692
+ "tags": [
10693
+ "Access"
10694
+ ],
10695
+ "parameters": [
10696
+ {
10697
+ "schema": {
10698
+ "type": "string",
10699
+ "description": "ID of the invitation",
10700
+ "example": "inv_123"
10701
+ },
10702
+ "required": true,
10703
+ "description": "ID of the invitation",
10704
+ "in": "path",
10705
+ "name": "invitationId"
10706
+ },
10707
+ {
10708
+ "schema": {
10709
+ "type": "string",
10710
+ "example": "en-US",
10711
+ "description": "Accept-Language header"
10712
+ },
10713
+ "required": false,
10714
+ "description": "Accept-Language header",
10715
+ "in": "header",
10716
+ "name": "accept-language"
10717
+ },
10718
+ {
10719
+ "schema": {
10720
+ "type": "string",
10721
+ "example": "session=1234567890",
10722
+ "description": "Cookie header"
10723
+ },
10724
+ "required": false,
10725
+ "description": "Cookie header",
10726
+ "in": "header",
10727
+ "name": "cookie"
10728
+ }
10729
+ ],
10730
+ "responses": {
10731
+ "200": {
10732
+ "description": "OK",
10733
+ "content": {
10734
+ "application/json": {
10735
+ "schema": {
10736
+ "$ref": "#/components/schemas/Member"
10737
+ }
10738
+ }
10739
+ }
10740
+ },
10741
+ "400": {
10742
+ "description": "Bad Request",
10743
+ "content": {
10744
+ "application/json": {
10745
+ "schema": {
10746
+ "type": "object",
10747
+ "properties": {
10748
+ "status": {
10749
+ "type": "number",
10750
+ "example": 404,
10751
+ "description": "The HTTP status code"
10752
+ },
10753
+ "message": {
10754
+ "type": "string",
10755
+ "example": "Not found",
10756
+ "description": "The error message"
10757
+ }
10758
+ },
10759
+ "required": [
10760
+ "status",
10761
+ "message"
10762
+ ]
10763
+ }
10764
+ }
10765
+ }
10766
+ },
10767
+ "401": {
10768
+ "description": "Unauthorized",
10769
+ "content": {
10770
+ "application/json": {
10771
+ "schema": {
10772
+ "type": "object",
10773
+ "properties": {
10774
+ "status": {
10775
+ "type": "number",
10776
+ "example": 404,
10777
+ "description": "The HTTP status code"
10778
+ },
10779
+ "message": {
10780
+ "type": "string",
10781
+ "example": "Not found",
10782
+ "description": "The error message"
10783
+ }
10784
+ },
10785
+ "required": [
10786
+ "status",
10787
+ "message"
10788
+ ]
10789
+ }
10790
+ }
10791
+ }
10792
+ },
10793
+ "404": {
10794
+ "description": "Not Found",
10795
+ "content": {
10796
+ "application/json": {
10797
+ "schema": {
10798
+ "type": "object",
10799
+ "properties": {
10800
+ "status": {
10801
+ "type": "number",
10802
+ "example": 404,
10803
+ "description": "The HTTP status code"
10804
+ },
10805
+ "message": {
10806
+ "type": "string",
10807
+ "example": "Not found",
10808
+ "description": "The error message"
10809
+ }
10810
+ },
10811
+ "required": [
10812
+ "status",
10813
+ "message"
10814
+ ]
10815
+ }
10816
+ }
10817
+ }
10818
+ }
10819
+ }
10820
+ }
10821
+ },
10822
+ "/{organizationId}/access/leave": {
10823
+ "post": {
10824
+ "description": "Leave an organization by revoking your own membership",
10825
+ "operationId": "leaveOrganization",
10826
+ "summary": "Leave Organization",
10827
+ "tags": [
10828
+ "Access"
10829
+ ],
10830
+ "parameters": [
10831
+ {
10832
+ "schema": {
10833
+ "type": "string",
10834
+ "minLength": 1,
10835
+ "format": "cuid",
10836
+ "example": "ckel0e8qw00004n5p5w6fznym",
10837
+ "description": "The organization ID"
10838
+ },
10839
+ "required": true,
10840
+ "description": "The organization ID",
10841
+ "name": "organizationId",
10842
+ "in": "path"
10843
+ },
10844
+ {
10845
+ "schema": {
10846
+ "type": "string",
10847
+ "example": "en-US",
10848
+ "description": "Accept-Language header"
10849
+ },
10850
+ "required": false,
10851
+ "description": "Accept-Language header",
10852
+ "in": "header",
10853
+ "name": "accept-language"
10854
+ },
10855
+ {
10856
+ "schema": {
10857
+ "type": "string",
10858
+ "example": "session=1234567890",
10859
+ "description": "Cookie header"
10860
+ },
10861
+ "required": false,
10862
+ "description": "Cookie header",
10863
+ "in": "header",
10864
+ "name": "cookie"
10865
+ }
10866
+ ],
10867
+ "responses": {
10868
+ "204": {
10869
+ "description": "No Content"
10870
+ },
10871
+ "400": {
10872
+ "description": "Bad Request",
10873
+ "content": {
10874
+ "application/json": {
10875
+ "schema": {
10876
+ "type": "object",
10877
+ "properties": {
10878
+ "status": {
10879
+ "type": "number",
10880
+ "example": 404,
10881
+ "description": "The HTTP status code"
10882
+ },
10883
+ "message": {
10884
+ "type": "string",
10885
+ "example": "Not found",
10886
+ "description": "The error message"
10887
+ }
10888
+ },
10889
+ "required": [
10890
+ "status",
10891
+ "message"
10892
+ ]
10893
+ }
10894
+ }
10895
+ }
10896
+ },
10897
+ "401": {
10898
+ "description": "Unauthorized",
10899
+ "content": {
10900
+ "application/json": {
10901
+ "schema": {
10902
+ "type": "object",
10903
+ "properties": {
10904
+ "status": {
10905
+ "type": "number",
10906
+ "example": 404,
10907
+ "description": "The HTTP status code"
10908
+ },
10909
+ "message": {
10910
+ "type": "string",
10911
+ "example": "Not found",
10912
+ "description": "The error message"
10913
+ }
10914
+ },
10915
+ "required": [
10916
+ "status",
10917
+ "message"
10918
+ ]
10919
+ }
10920
+ }
10921
+ }
10922
+ },
10923
+ "404": {
10924
+ "description": "Not Found",
10925
+ "content": {
10926
+ "application/json": {
10927
+ "schema": {
10928
+ "type": "object",
10929
+ "properties": {
10930
+ "status": {
10931
+ "type": "number",
10932
+ "example": 404,
10933
+ "description": "The HTTP status code"
10934
+ },
10935
+ "message": {
10936
+ "type": "string",
10937
+ "example": "Not found",
10938
+ "description": "The error message"
10939
+ }
10940
+ },
10941
+ "required": [
10942
+ "status",
10943
+ "message"
10944
+ ]
10945
+ }
10946
+ }
10947
+ }
10948
+ }
10949
+ }
10950
+ }
10951
+ },
9342
10952
  "/{organizationId}/shipping-methods": {
9343
10953
  "post": {
9344
10954
  "description": "Creates a new shipping method for an organization",