Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SDP: add how to update the SMS messages template #244

Merged
merged 4 commits into from
Feb 22, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Updates the organization profile details. Only account owners have
sidebar_label: "Update Organization Profile"
hide_title: true
hide_table_of_contents: true
api: {"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"examples":{"response":{"value":{"message":"organization profile updated successfully"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Update Organization Profile","description":"Updates the organization profile details. Only account owners have permission to do this. Note: both fields are optional but at least one should be sent in the request. It is not necessary to set the header Content-Type for this request. It is set automatically by the HTTP client.","tags":["Organization"],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"logo":{"description":"The logo of the organization, file type must be png or jpeg.","type":"string","format":"binary"},"data":{"description":"A JSON string that contains the details to update. Contains the following keys: `organization_name` (string): the new name of the organization, `timezone_utc_offset` (string): the new timezone offset of the organization, `is_approval_required` (boolean): whether the approval workflow is enabled or not. For example: '{\"organization_name\": \"NewOrgName\", \"timezone_utc_offset\": \"+02:00\", \"is_approval_required\": true}'\n","type":"string","format":"json"}}}}}},"security":[{"BearerAuth":[]}],"method":"patch","path":"/organization","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update Organization Profile","description":{"content":"Updates the organization profile details. Only account owners have permission to do this. Note: both fields are optional but at least one should be sent in the request. It is not necessary to set the header Content-Type for this request. It is set automatically by the HTTP client.","type":"text/plain"},"url":{"path":["organization"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"formdata","formdata":[]},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"<API Key>","key":"value"},{"type":"any","value":"header","key":"in"}]}}}
api: {"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"examples":{"response":{"value":{"message":"organization profile updated successfully"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}},"403":{"description":"Forbidden","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}},"examples":{"response":{"value":{"error":"Forbidden"}}}}}}},"operationId":"Update Organization Profile","description":"Updates the organization profile details. Only account owners have permission to do this. Note: both fields are optional but at least one should be sent in the request. It is not necessary to set the header Content-Type for this request. It is set automatically by the HTTP client.","tags":["Organization"],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"logo":{"description":"The logo of the organization, file type must be png or jpeg.","type":"string","format":"binary"},"data":{"description":"A JSON string that contains the details to update. Contains the following keys: `organization_name` (string): the new name of the organization, `timezone_utc_offset` (string): the new timezone offset of the organization, `is_approval_required` (boolean): whether the approval workflow is enabled or not. `sms_registration_message_template` (string): the SMS message template sent to the receivers inviting them to registration. Sending this field empty sets the `default` value for it. `otp_message_template` (string): the SMS message template sent to the receivers sending the OTP to complete the registration flow. Sending this field empty sets the `default` value for it. For example: '{\"organization_name\": \"NewOrgName\", \"timezone_utc_offset\": \"+02:00\", \"is_approval_required\": true, \"sms_registration_message_template\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\", \"otp_message_template\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\"}'\n","type":"string","format":"json"}}}}}},"security":[{"BearerAuth":[]}],"method":"patch","path":"/organization","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Update Organization Profile","description":{"content":"Updates the organization profile details. Only account owners have permission to do this. Note: both fields are optional but at least one should be sent in the request. It is not necessary to set the header Content-Type for this request. It is set automatically by the HTTP client.","type":"text/plain"},"url":{"path":["organization"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"formdata","formdata":[]},"auth":{"type":"apikey","apikey":[{"type":"any","value":"Authorization","key":"key"},{"type":"any","value":"<API Key>","key":"value"},{"type":"any","value":"header","key":"in"}]}}}
sidebar_class_name: "patch api-method"
info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api
custom_edit_url: null
Expand All @@ -30,7 +30,7 @@ import TabItem from "@theme/TabItem";

Updates the organization profile details. Only account owners have permission to do this. Note: both fields are optional but at least one should be sent in the request. It is not necessary to set the header Content-Type for this request. It is set automatically by the HTTP client.

<MimeTabs><TabItem label={"multipart/form-data"} value={"multipart/form-data-schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Request Body</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"logo"} required={false} schemaName={"binary"} qualifierMessage={undefined} schema={{"description":"The logo of the organization, file type must be png or jpeg.","type":"string","format":"binary"}}></SchemaItem><SchemaItem collapsible={false} name={"data"} required={false} schemaName={"json"} qualifierMessage={undefined} schema={{"description":"A JSON string that contains the details to update. Contains the following keys: `organization_name` (string): the new name of the organization, `timezone_utc_offset` (string): the new timezone offset of the organization, `is_approval_required` (boolean): whether the approval workflow is enabled or not. For example: '{\"organization_name\": \"NewOrgName\", \"timezone_utc_offset\": \"+02:00\", \"is_approval_required\": true}'\n","type":"string","format":"json"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
<MimeTabs><TabItem label={"multipart/form-data"} value={"multipart/form-data-schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Request Body</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"logo"} required={false} schemaName={"binary"} qualifierMessage={undefined} schema={{"description":"The logo of the organization, file type must be png or jpeg.","type":"string","format":"binary"}}></SchemaItem><SchemaItem collapsible={false} name={"data"} required={false} schemaName={"json"} qualifierMessage={undefined} schema={{"description":"A JSON string that contains the details to update. Contains the following keys: `organization_name` (string): the new name of the organization, `timezone_utc_offset` (string): the new timezone offset of the organization, `is_approval_required` (boolean): whether the approval workflow is enabled or not. `sms_registration_message_template` (string): the SMS message template sent to the receivers inviting them to registration. Sending this field empty sets the `default` value for it. `otp_message_template` (string): the SMS message template sent to the receivers sending the OTP to complete the registration flow. Sending this field empty sets the `default` value for it. For example: '{\"organization_name\": \"NewOrgName\", \"timezone_utc_offset\": \"+02:00\", \"is_approval_required\": true, \"sms_registration_message_template\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\", \"otp_message_template\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\"}'\n","type":"string","format":"json"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

OK

Expand Down
2 changes: 1 addition & 1 deletion openapi/stellar-disbursement-platform/bundled.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1439,7 +1439,7 @@ paths:
type: string
format: json
description: |
A JSON string that contains the details to update. Contains the following keys: `organization_name` (string): the new name of the organization, `timezone_utc_offset` (string): the new timezone offset of the organization, `is_approval_required` (boolean): whether the approval workflow is enabled or not. For example: '{"organization_name": "NewOrgName", "timezone_utc_offset": "+02:00", "is_approval_required": true}'
A JSON string that contains the details to update. Contains the following keys: `organization_name` (string): the new name of the organization, `timezone_utc_offset` (string): the new timezone offset of the organization, `is_approval_required` (boolean): whether the approval workflow is enabled or not. `sms_registration_message_template` (string): the SMS message template sent to the receivers inviting them to registration. Sending this field empty sets the `default` value for it. `otp_message_template` (string): the SMS message template sent to the receivers sending the OTP to complete the registration flow. Sending this field empty sets the `default` value for it. For example: '{"organization_name": "NewOrgName", "timezone_utc_offset": "+02:00", "is_approval_required": true, "sms_registration_message_template": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "otp_message_template": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."}'
security:
- BearerAuth: []
/organization/logo:
Expand Down
4 changes: 3 additions & 1 deletion openapi/stellar-disbursement-platform/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1508,7 +1508,9 @@ paths:
`organization_name` (string): the new name of the organization,
`timezone_utc_offset` (string): the new timezone offset of the organization,
`is_approval_required` (boolean): whether the approval workflow is enabled or not.
For example: '{"organization_name": "NewOrgName", "timezone_utc_offset": "+02:00", "is_approval_required": true}'
`sms_registration_message_template` (string): the SMS message template sent to the receivers inviting them to registration. Sending this field empty sets the `default` value for it.
`otp_message_template` (string): the SMS message template sent to the receivers sending the OTP to complete the registration flow. Sending this field empty sets the `default` value for it.
For example: '{"organization_name": "NewOrgName", "timezone_utc_offset": "+02:00", "is_approval_required": true, "sms_registration_message_template": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "otp_message_template": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."}'
security:
- BearerAuth: []
/organization/logo:
Expand Down